Skip to content

Commit 5bcebd7

Browse files
Update README with latest features (#59)
* 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>
1 parent 935ac7d commit 5bcebd7

7 files changed

Lines changed: 55 additions & 1323 deletions

File tree

docs/amp_cli_docs.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ In interactive mode:
8787
You can use Amp in non-interactive mode by piping content to it:
8888

8989
```bash
90-
echo "commit all my unstaged changes" | amp
90+
amp -x "commit all my unstaged changes"
9191
```
9292

9393
Or by using input/output redirection:
@@ -126,16 +126,16 @@ Amp CLI supports the following options:
126126

127127
| Option | Description |
128128
| --------------------------- | ----------- |
129-
| `-V, --version` | Output the version number |
130129
| `--visibility <visibility>` | Set thread visibility (private, public, team) |
130+
| `-V, --version` | output the version number |
131131
| `--notifications` | Enable sound notifications (enabled by default when not in execute mode) |
132132
| `--no-notifications` | Disable sound notifications (enabled by default when not in execute mode) |
133133
| `--settings-file <value>` | Custom settings file path (overrides the default location) |
134134
| `--log-level <value>` | Set log level (error, warn, info, debug, audit) |
135-
| `--log-file <value>` | Set log file location |
135+
| `--log-file <value>` | Set log file location (overrides the default location) |
136136
| `--dangerously-allow-all` | Disable all command confirmation prompts (agent will execute all commands without asking) |
137137
| `--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) |
139139
| `-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. |
140140

141141
## Commands
@@ -161,16 +161,16 @@ Amp CLI includes several subcommands for enhanced functionality:
161161
| `permissions test` | Test permissions |
162162
| `permissions edit` | Edit permissions |
163163
| `permissions add` | Add permission rule |
164-
| `permissions migrate` | Migrate allowlist |
164+
165165
| `doctor` | Generate support bundle |
166166
| `update` | Update Amp CLI |
167167

168168
## Environment Variables
169169

170170
| Variable | Description |
171171
| ------------------- | ----------- |
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/`) |
174174
| `AMP_LOG_LEVEL` | Set log level (can also use --log-level) |
175175
| `AMP_LOG_FILE` | Set log file location (can also use --log-file) |
176176
| `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
195195
amp -x "what file in this folder is in markdown format?"
196196
```
197197

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+
198209
Use execute mode and allow agent to use tools that would require approval:
199210

200211
```bash
201212
amp --dangerously-allow-all -x "Rename all .markdown files to .md. Only print list of renamed files."
202213
```
203214

215+
Output:
216+
217+
```text
218+
- readme.markdown → readme.md
219+
- ghostty.markdown → ghostty.md
220+
```
221+
204222
Pipe a command to the agent and use execute mode:
205223

206224
```bash
207225
echo "commit all my unstaged changes" | amp -x --dangerously-allow-all
208226
```
209227

228+
Output:
229+
230+
```text
231+
Done. I have committed all your unstaged changes.
232+
```
233+
210234
Pipe data to the agent and send along a prompt in execute mode:
211235

212236
```bash
213237
cat ~/.zshrc | amp -x "what does the 'beautiful' function do?"
214238
```
215239

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+
216246
Execute a prompt from a file and store final assistant message output in a file (redirecting stdout is equivalent to providing `-x`/`--execute`):
217247

218248
```bash
@@ -266,9 +296,9 @@ Sample configuration:
266296
- **`amp.notifications.enabled`**: Enable system sound notifications when agent completes tasks
267297
- **`amp.notifications.system.enabled`**: Enable system notifications when terminal is not focused
268298
- **`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.
272302
- **`amp.dangerouslyAllowAll`**: Disable all command confirmation prompts (agent will execute all commands without asking)
273303
- **`amp.git.commit.coauthor.enabled`**: Enable adding Amp as co-author in git commits
274304
- **`amp.git.commit.ampThread.enabled`**: Enable adding Amp-Thread trailer in git commits
@@ -278,7 +308,7 @@ Sample configuration:
278308

279309
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:
280310

281-
```
311+
```text
282312
Amp wants to run: git status
283313
284314
Allow this command? [y/n/!]
@@ -342,4 +372,4 @@ If you see an "Out of free credits" message, visit [ampcode.com/settings](https:
342372

343373
## Last updated
344374

345-
2025-08-15
375+
2025-09-05

0 commit comments

Comments
 (0)