Skip to content

Commit b31b1be

Browse files
jdorfmanampcode-com
jdorfman
and
ampcode-com
authored
docs: update CLI documentation with new features and commands (#63)
* docs: update CLI documentation with new features and commands - Update visibility options to workspace/group (removed team) - Add new CLI flags: --jetbrains, --ide, --stream-json, --stream-json-input - Add new tool commands: make and use - Add MCP server management commands: add, remove, doctor - Add connect command for web interface integration - Include MCP server configuration examples - Add amp.updates.mode configuration option - Update last modified date to 2025-10-16 Amp-Thread-ID: https://ampcode.com/threads/T-f6b54b62-630e-48c7-8198-8bce005ed32a Co-authored-by: Amp <amp@ampcode.com> * Fix linting errors in amp_cli_docs.md: align tables and escape brackets Amp-Thread-ID: https://ampcode.com/threads/T-7330cdac-eeb6-482a-9423-c5a6b641cbc3 Co-authored-by: Amp <amp@ampcode.com> * Whitelist additional npm package URLs in CI workflow Amp-Thread-ID: https://ampcode.com/threads/T-e01d6513-cc25-4c19-b2e9-e85a49e44dba Co-authored-by: Amp <amp@ampcode.com> --------- Co-authored-by: Amp <amp@ampcode.com>
1 parent 0844c76 commit b31b1be

2 files changed

Lines changed: 78 additions & 53 deletions

File tree

‎.github/workflows/lint.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ jobs:
4242
- name: "install awesome-bot"
4343
run: gem install awesome_bot
4444
- name: "linting: ${{ matrix.files }}"
45-
run: awesome_bot --allow-redirect --white-list https://github.com/jdorfman/awesome-amp-cli,https://example.com,https://github.com/user-attachments/assets/44099391-3976-473d-bcf8-95fd7b980f99 ${{ matrix.files }}
45+
run: awesome_bot --allow-redirect --white-list https://github.com/jdorfman/awesome-amp-cli,https://example.com,https://github.com/user-attachments/assets/44099391-3976-473d-bcf8-95fd7b980f99,https://www.npmjs.com/package/llm-rules,https://www.npmjs.com/package/@sourcegraph/amp ${{ matrix.files }}

‎docs/amp_cli_docs.md‎

Lines changed: 77 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -124,56 +124,67 @@ export AMP_API_KEY=your_amp_api_key_here
124124

125125
Amp CLI supports the following options:
126126

127-
| Option | Description |
128-
| --------------------------- | ----------- |
129-
| `--visibility <visibility>` | Set thread visibility (private, public, team) |
130-
| `-V, --version` | output the version number |
131-
| `--notifications` | Enable sound notifications (enabled by default when not in execute mode) |
132-
| `--no-notifications` | Disable sound notifications (enabled by default when not in execute mode) |
133-
| `--settings-file <value>` | Custom settings file path (overrides the default location) |
134-
| `--log-level <value>` | Set log level (error, warn, info, debug, audit) |
135-
| `--log-file <value>` | Set log file location (overrides the default location) |
136-
| `--dangerously-allow-all` | Disable all command confirmation prompts (agent will execute all commands without asking) |
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) |
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. |
127+
| Option | Description |
128+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
129+
| --visibility <visibility> | Set thread visibility (private, public, workspace, group) |
130+
| -V, --version | output the version number |
131+
| --notifications | Enable sound notifications (enabled by default when not in execute mode) |
132+
| --no-notifications | Disable sound notifications (enabled by default when not in execute mode) |
133+
| --settings-file <value> | Custom settings file path (overrides the default location) |
134+
| --log-level <value> | Set log level (error, warn, info, debug, audit) |
135+
| --log-file <value> | Set log file location (overrides the default location) |
136+
| --dangerously-allow-all | Disable all command confirmation prompts (agent will execute all commands without asking) |
137+
| --mcp-config <value> | JSON configuration or file path for MCP servers to merge with existing settings |
138+
| --jetbrains | Enable JetBrains integration. When enabled, Amp automatically includes your open JetBrains file and text selection with every message. |
139+
| --no-jetbrains | Disable JetBrains integration. |
140+
| --ide | Enable IDE connection (default). When enabled, Amp automatically includes your open IDE's file and text selection with every message. |
141+
| --no-ide | Disable IDE connection. |
142+
| --stream-json | When used with --execute, output in Claude Code compatible stream JSON format instead of plain text. |
143+
| --stream-json-input | Read JSON Lines user messages from stdin. Requires both --execute and --stream-json. |
144+
| -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. |
140145

141146
## Commands
142147

143148
Amp CLI includes several subcommands for enhanced functionality:
144149

145-
| Command | Description |
146-
| --------------------- | ----------- |
147-
| `logout` | Log out by removing stored API key |
148-
| `login` | Log in to Amp |
149-
| `threads` | Manage threads |
150-
| `threads new` | Create a new thread |
151-
| `threads continue` | Continue an existing thread |
152-
| `threads fork` | Fork an existing thread |
153-
| `threads list` | List all threads |
154-
| `threads share` | Share a thread |
155-
| `threads compact` | Compact a thread |
156-
| `tools` | Tool management commands |
157-
| `tools list` | List all active tools (including MCP tools) |
158-
| `tools show` | Show details about an active tool |
159-
| `permissions` | Manage permissions |
160-
| `permissions list` | List permissions |
161-
| `permissions test` | Test permissions |
162-
| `permissions edit` | Edit permissions |
163-
| `permissions add` | Add permission rule |
164-
165-
| `doctor` | Generate support bundle |
166-
| `update` | Update Amp CLI |
150+
| Command | Description |
151+
| ------------------ | -------------------------------------------------------- |
152+
| `logout` | Log out by removing stored API key |
153+
| `login` | Log in to Amp |
154+
| `threads` | Manage threads |
155+
| `threads new` | Create a new thread |
156+
| `threads continue` | Continue an existing thread |
157+
| `threads fork` | Fork an existing thread |
158+
| `threads list` | List all threads |
159+
| `threads share` | Share a thread |
160+
| `threads compact` | Compact a thread |
161+
| `tools` | Tool management commands |
162+
| `tools list` | List all active tools (including MCP tools) |
163+
| `tools show` | Show details about an active tool |
164+
| `tools make` | Sets up a skeleton tool in your toolbox |
165+
| `tools use` | Invoke a tool with arguments or JSON input from stdin |
166+
| `permissions` | Manage permissions |
167+
| `permissions list` | List permissions |
168+
| `permissions test` | Test permissions |
169+
| `permissions edit` | Edit permissions |
170+
| `permissions add` | Add permission rule |
171+
| `mcp` | Manage MCP servers |
172+
| `mcp add` | Add an MCP server configuration |
173+
| `mcp remove` | Remove an MCP server configuration |
174+
| `mcp doctor` | Check MCP server status |
175+
| `connect` | Connect CLI to web interface for multi-thread management |
176+
| `doctor` | Generate support bundle |
177+
| `update` | Update Amp CLI |
167178

168179
## Environment Variables
169180

170-
| Variable | Description |
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/`) |
174-
| `AMP_LOG_LEVEL` | Set log level (can also use --log-level) |
175-
| `AMP_LOG_FILE` | Set log file location (can also use --log-file) |
176-
| `AMP_SETTINGS_FILE` | Set settings file path (can also use --settings-file, default: ~/.config/amp/settings.json) |
181+
| Variable | Description |
182+
| ----------------- | ------------------------------------------------------------------------------------------- |
183+
| AMP_API_KEY | API key for Amp (see https://ampcode.com/settings) |
184+
| AMP_URL | URL for the Amp service (default is https://ampcode.com/) |
185+
| AMP_LOG_LEVEL | Set log level (can also use --log-level) |
186+
| AMP_LOG_FILE | Set log file location (can also use --log-file) |
187+
| AMP_SETTINGS_FILE | Set settings file path (can also use --settings-file, default: ~/.config/amp/settings.json) |
177188

178189
## Examples
179190

@@ -249,6 +260,24 @@ Execute a prompt from a file and store final assistant message output in a file
249260
amp < prompt.txt > output.txt
250261
```
251262

263+
Add an MCP server with a local command:
264+
265+
```bash
266+
amp mcp add context7 -- npx -y @upstash/context7-mcp
267+
```
268+
269+
Add an MCP server with environment variables:
270+
271+
```bash
272+
amp mcp add postgres --env PGUSER=orb -- npx -y @modelcontextprotocol/server-postgres postgresql://localhost/orbing
273+
```
274+
275+
Add a remote MCP server:
276+
277+
```bash
278+
amp mcp add hugging-face https://huggingface.co/mcp
279+
```
280+
252281
## Configuration
253282

254283
Amp can be configured using a JSON settings file located at `~/.config/amp/settings.json`. All settings use the "amp." prefix.
@@ -268,26 +297,21 @@ Sample configuration:
268297
]
269298
}
270299
},
271-
"amp.tools.disable": [
272-
"browser_navigate",
273-
"builtin:edit_file"
274-
],
300+
"amp.tools.disable": ["browser_navigate", "builtin:edit_file"],
275301
"amp.permissions": [
276302
{
277303
"tool": "Bash",
278304
"action": "ask",
279305
"matches": {
280-
"cmd": [
281-
"git push*",
282-
"git commit*"
283-
]
306+
"cmd": ["git push*", "git commit*"]
284307
}
285308
}
286309
],
287310
"amp.guardedFiles.allowlist": [],
288311
"amp.dangerouslyAllowAll": false,
289312
"amp.git.commit.coauthor.enabled": true,
290-
"amp.git.commit.ampThread.enabled": true
313+
"amp.git.commit.ampThread.enabled": true,
314+
"amp.updates.mode": "auto"
291315
}
292316
```
293317

@@ -303,6 +327,7 @@ Sample configuration:
303327
- **`amp.git.commit.coauthor.enabled`**: Enable adding Amp as co-author in git commits
304328
- **`amp.git.commit.ampThread.enabled`**: Enable adding Amp-Thread trailer in git commits
305329
- **`amp.proxy`**: Proxy URL used for both HTTP and HTTPS requests to the Amp server
330+
- **`amp.updates.mode`**: Control update checking behavior: "warn" shows update notifications, "disabled" turns off checking, "auto" automatically runs update.
306331

307332
## Tool Usage
308333

@@ -372,4 +397,4 @@ If you see an "Out of free credits" message, visit [ampcode.com/settings](https:
372397

373398
## Last updated
374399

375-
2025-09-05
400+
2025-10-16

0 commit comments

Comments
 (0)