Skip to content

Commit 6ba1416

Browse files
authored
docs: fix local agent directory path in documentation (#2749)
* docs: fix local agent directory path - Fix local agent path from .aws/amazonq/cli-agents/ to .amazonq/cli-agents/ - Global paths (~/.aws/amazonq/cli-agents/) remain correct - Aligns documentation with source code implementation * fix: correct workspace agent path in /agent help message The help message for the /agent command incorrectly showed the workspace agent path as 'cwd/.aws/amazonq/cli-agents' when it should be 'cwd/.amazonq/cli-agents' (without the .aws directory). This fix aligns the help text with the actual WORKSPACE_AGENT_DIR_RELATIVE constant defined in directories.rs.
1 parent d9c34dc commit 6ba1416

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

crates/chat-cli/src/cli/chat/cli/profile.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ use crate::util::{
5555
5656
Notes
5757
• Launch q chat with a specific agent with --agent
58-
• Construct an agent under ~/.aws/amazonq/cli-agents/ (accessible globally) or cwd/.aws/amazonq/cli-agents (accessible in workspace)
58+
• Construct an agent under ~/.aws/amazonq/cli-agents/ (accessible globally) or cwd/.amazonq/cli-agents (accessible in workspace)
5959
• See example config under global directory
6060
• Set default agent to assume with settings by running \"q settings chat.defaultAgent agent_name\"
6161
• Each agent maintains its own set of context and customizations"

docs/agent-file-locations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ These agents are available from any directory when using Q CLI.
4747

4848
When Q CLI looks for an agent, it follows this precedence order:
4949

50-
1. **Local first**: Checks `.aws/amazonq/cli-agents/` in the current working directory
50+
1. **Local first**: Checks `.amazonq/cli-agents/` in the current working directory
5151
2. **Global fallback**: If not found locally, checks `~/.aws/amazonq/cli-agents/` in the home directory
5252

5353
## Naming Conflicts

docs/default-agent-behavior.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ q chat --agent specialized-agent
9696

9797
### Create a Custom Default
9898
You can create your own "default" agent by placing an agent file with the name `q_cli_default` in either:
99-
- `.aws/amazonq/cli-agents/` (local)
99+
- `.amazonq/cli-agents/` (local)
100100
- `~/.aws/amazonq/cli-agents/` (global)
101101

102102
This will override the built-in default agent configuration.

0 commit comments

Comments
 (0)