You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Major documentation cleanup and reorganization
- Rename AGENT.md section to AGENTS.md for consistency
- Add new Amp Integrations section with VibeKanban, Amp Dash X Raycast, and Conductor
- Remove Demos section and outdated entries
- Update CLI documentation with latest options, examples, and proper formatting
- Remove unverified translations and dead links
- Add LangGraph, Sink repositories, and Amp 101 YouTube Playlist
Co-authored-by: Amp <amp@ampcode.com>
|`--log-file <value>`| Set log file location (overrides the default location) |
136
136
|`--dangerously-allow-all`| Disable all command confirmation prompts (agent will execute all commands without asking) |
137
137
|`--mcp-config <value>`| JSON configuration or file path for MCP servers to merge with existing settings |
138
-
|`--try-gpt5`| Try GPT-5 as the primary agent model (limited time; see https://ampcode.com/news/gpt-5)|
138
+
|`--try-gpt5`| Try GPT-5 as the primary agent model (limited time; see `https://ampcode.com/news/`gpt-5) |
139
139
|`-x, --execute [message]`| Use execute mode, optionally with user message. In execute mode, agent will execute provided prompt (either as argument, or via stdin). Only last assistant message is printed. Enabled automatically when redirecting stdout. |
140
140
141
141
## Commands
@@ -161,16 +161,16 @@ Amp CLI includes several subcommands for enhanced functionality:
161
161
|`permissions test`| Test permissions |
162
162
|`permissions edit`| Edit permissions |
163
163
|`permissions add`| Add permission rule |
164
-
|`permissions migrate`| Migrate allowlist |
164
+
165
165
|`doctor`| Generate support bundle |
166
166
|`update`| Update Amp CLI |
167
167
168
168
## Environment Variables
169
169
170
170
| Variable | Description |
171
171
| ------------------- | ----------- |
172
-
|`AMP_API_KEY`| API key for Amp (see https://ampcode.com/settings)|
173
-
|`AMP_URL`| URL for the Amp service (default is https://ampcode.com/)|
172
+
|`AMP_API_KEY`| API key for Amp (see `https://ampcode.com/settings`) |
173
+
|`AMP_URL`| URL for the Amp service (default is `https://ampcode.com/`) |
174
174
|`AMP_LOG_LEVEL`| Set log level (can also use --log-level) |
175
175
|`AMP_LOG_FILE`| Set log file location (can also use --log-file) |
176
176
|`AMP_SETTINGS_FILE`| Set settings file path (can also use --settings-file, default: ~/.config/amp/settings.json) |
@@ -195,24 +195,54 @@ Use execute mode (`--execute` or `-x`) to send a command to an agent, have it ex
195
195
amp -x "what file in this folder is in markdown format?"
196
196
```
197
197
198
+
Output:
199
+
200
+
```text
201
+
All Markdown files in this folder:
202
+
- README.md (root)
203
+
- AGENT.md (root)
204
+
- Documentation (7 files in doc/)
205
+
- Various README.md files in subdirectories
206
+
Total: **13 Markdown files** found across the project.
207
+
```
208
+
198
209
Use execute mode and allow agent to use tools that would require approval:
199
210
200
211
```bash
201
212
amp --dangerously-allow-all -x "Rename all .markdown files to .md. Only print list of renamed files."
202
213
```
203
214
215
+
Output:
216
+
217
+
```text
218
+
- readme.markdown → readme.md
219
+
- ghostty.markdown → ghostty.md
220
+
```
221
+
204
222
Pipe a command to the agent and use execute mode:
205
223
206
224
```bash
207
225
echo"commit all my unstaged changes"| amp -x --dangerously-allow-all
208
226
```
209
227
228
+
Output:
229
+
230
+
```text
231
+
Done. I have committed all your unstaged changes.
232
+
```
233
+
210
234
Pipe data to the agent and send along a prompt in execute mode:
211
235
212
236
```bash
213
237
cat ~/.zshrc | amp -x "what does the 'beautiful' function do?"
214
238
```
215
239
240
+
Output:
241
+
242
+
```text
243
+
The `beautiful` function creates an infinite loop that prints the letter "o" in cycling colors every 0.2 seconds.
244
+
```
245
+
216
246
Execute a prompt from a file and store final assistant message output in a file (redirecting stdout is equivalent to providing `-x`/`--execute`):
217
247
218
248
```bash
@@ -266,9 +296,9 @@ Sample configuration:
266
296
-**`amp.notifications.enabled`**: Enable system sound notifications when agent completes tasks
267
297
-**`amp.notifications.system.enabled`**: Enable system notifications when terminal is not focused
268
298
-**`amp.mcpServers`**: Model Context Protocol servers to connect to for additional tools
269
-
-**`amp.tools.disable`**: Array of tool names to disable. Use `builtin:toolname` to disable only the builtin tool with that name (allowing an MCP server to provide a tool by that name).
270
-
-**`amp.permissions`**: Permission rules for tool calls. See `amp permissions --help`.
271
-
-**`amp.guardedFiles.allowlist`**: File glob patterns allowed without confirmation; takes precedence over built-in denylist.
299
+
-**`amp.tools.disable`**: Array of tool names to disable. Use 'builtin:toolname' to disable only the builtin tool with that name (allowing an MCP server to provide a tool by that name).
300
+
-**`amp.permissions`**: Permission rules for tool calls. See amp permissions --help
301
+
-**`amp.guardedFiles.allowlist`**: Array of file glob patterns that are allowed to be accessed without confirmation. Takes precedence over the built-in denylist.
272
302
-**`amp.dangerouslyAllowAll`**: Disable all command confirmation prompts (agent will execute all commands without asking)
273
303
-**`amp.git.commit.coauthor.enabled`**: Enable adding Amp as co-author in git commits
274
304
-**`amp.git.commit.ampThread.enabled`**: Enable adding Amp-Thread trailer in git commits
@@ -278,7 +308,7 @@ Sample configuration:
278
308
279
309
Amp can use various tools to help with your tasks. When Amp wants to use a tool (like running a terminal command), it will ask for your confirmation:
280
310
281
-
```
311
+
```text
282
312
Amp wants to run: git status
283
313
284
314
Allow this command? [y/n/!]
@@ -342,4 +372,4 @@ If you see an "Out of free credits" message, visit [ampcode.com/settings](https:
0 commit comments