Skip to content

Commit 5a400b4

Browse files
chore: fix references to the agent file location (#2455)
1 parent 2bdba01 commit 5a400b4

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
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
@@ -43,7 +43,7 @@ use crate::util::directories::chat_global_agent_path;
4343
4444
Notes
4545
• Launch q chat with a specific agent with --agent
46-
• Construct an agent under ~/.aws/amazonq/agents/ (accessible globally) or cwd/.aws/amazonq/agents (accessible in workspace)
46+
• Construct an agent under ~/.aws/amazonq/cli-agents/ (accessible globally) or cwd/.aws/amazonq/cli-agents (accessible in workspace)
4747
• See example config under global directory
4848
• Set default agent to assume with settings by running \"q settings chat.defaultAgent agent_name\"
4949
• Each agent maintains its own set of context and customizations"

docs/agent-file-locations.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Agent configuration files can be placed in two different locations, allowing for
77
Local agents are stored in the current working directory under:
88

99
```
10-
.aws/amazonq/agents/
10+
.aws/amazonq/cli-agents/
1111
```
1212

1313
These agents are specific to the current workspace or project and are only available when running Q CLI from that directory or its subdirectories.
@@ -17,7 +17,7 @@ These agents are specific to the current workspace or project and are only avail
1717
my-project/
1818
├── .aws/
1919
│ └── amazonq/
20-
│ └── agents/
20+
│ └── cli-agents/
2121
│ ├── dev-agent.json
2222
│ └── aws-specialist.json
2323
└── src/
@@ -29,14 +29,14 @@ my-project/
2929
Global agents are stored in your home directory under:
3030

3131
```
32-
~/.aws/amazonq/agents/
32+
~/.aws/amazonq/cli-agents/
3333
```
3434

3535
These agents are available from any directory when using Q CLI.
3636

3737
**Example structure:**
3838
```
39-
~/.aws/amazonq/agents/
39+
~/.aws/amazonq/cli-agents/
4040
├── general-assistant.json
4141
├── code-reviewer.json
4242
└── documentation-writer.json
@@ -46,8 +46,8 @@ These agents are available from any directory when using Q CLI.
4646

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

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

5252
## Naming Conflicts
5353

@@ -78,8 +78,8 @@ The global agent with the same name will be ignored in favor of the local versio
7878
To create a local agent for your current project:
7979

8080
```bash
81-
mkdir -p .aws/amazonq/agents
82-
cat > .aws/amazonq/agents/project-helper.json << 'EOF'
81+
mkdir -p .aws/amazonq/cli-agents
82+
cat > .aws/amazonq/cli-agents/project-helper.json << 'EOF'
8383
{
8484
"description": "Helper agent for this specific project",
8585
"tools": ["fs_read", "fs_write", "execute_bash"],
@@ -94,8 +94,8 @@ EOF
9494
To create a global agent available everywhere:
9595

9696
```bash
97-
mkdir -p ~/.aws/amazonq/agents
98-
cat > ~/.aws/amazonq/agents/general-helper.json << 'EOF'
97+
mkdir -p ~/.aws/amazonq/cli-agents
98+
cat > ~/.aws/amazonq/cli-agents/general-helper.json << 'EOF'
9999
{
100100
"description": "General purpose assistant",
101101
"tools": ["*"],
@@ -106,4 +106,4 @@ EOF
106106

107107
## Directory Creation
108108

109-
Q CLI will automatically create the global agents directory (`~/.aws/amazonq/agents/`) if it doesn't exist. However, you need to manually create the local agents directory (`.aws/amazonq/agents/`) in your workspace if you want to use local agents.
109+
Q CLI will automatically create the global agents directory (`~/.aws/amazonq/cli-agents/`) if it doesn't exist. However, you need to manually create the local agents directory (`.aws/amazonq/cli-agents/`) in your workspace if you want to use local agents.

docs/default-agent-behavior.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ q chat --agent specialized-agent
9595
```
9696

9797
### Create a Custom Default
98-
You can create your own "default" agent by placing a file named `default.json` in either:
99-
- `.aws/amazonq/agents/default.json` (local)
100-
- `~/.aws/amazonq/agents/default.json` (global)
98+
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)
100+
- `~/.aws/amazonq/cli-agents/` (global)
101101

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

0 commit comments

Comments
 (0)