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
docs: improve markdown formatting and update CLI documentation
- Update CLI command examples to use proper -x flag syntax
- Fix URL formatting with backticks for better readability
- Improve code block formatting with explicit language tags
- Update FAQ formatting for consistency with markdown style
Co-authored-by: Amp <[email protected]>
Amp-Thread-ID: https://ampcode.com/threads/T-3a8ee2b4-1d2e-47cf-bb3b-32c01fb3dd19
Copy file name to clipboardExpand all lines: docs/amp_cli_docs.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ In interactive mode:
87
87
You can use Amp in non-interactive mode by piping content to it:
88
88
89
89
```bash
90
-
echo"commit all my unstaged changes"| amp
90
+
amp -x "commit all my unstaged changes"
91
91
```
92
92
93
93
Or by using input/output redirection:
@@ -135,7 +135,7 @@ Amp CLI supports the following options:
135
135
|`--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
@@ -169,8 +169,8 @@ Amp CLI includes several subcommands for enhanced functionality:
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) |
@@ -196,7 +196,8 @@ amp -x "what file in this folder is in markdown format?"
196
196
```
197
197
198
198
Output:
199
-
```
199
+
200
+
```text
200
201
All Markdown files in this folder:
201
202
- README.md (root)
202
203
- AGENT.md (root)
@@ -212,7 +213,8 @@ amp --dangerously-allow-all -x "Rename all .markdown files to .md. Only print li
212
213
```
213
214
214
215
Output:
215
-
```
216
+
217
+
```text
216
218
- readme.markdown → readme.md
217
219
- ghostty.markdown → ghostty.md
218
220
```
@@ -224,7 +226,8 @@ echo "commit all my unstaged changes" | amp -x --dangerously-allow-all
224
226
```
225
227
226
228
Output:
227
-
```
229
+
230
+
```text
228
231
Done. I have committed all your unstaged changes.
229
232
```
230
233
@@ -235,7 +238,8 @@ cat ~/.zshrc | amp -x "what does the 'beautiful' function do?"
235
238
```
236
239
237
240
Output:
238
-
```
241
+
242
+
```text
239
243
The `beautiful` function creates an infinite loop that prints the letter "o" in cycling colors every 0.2 seconds.
240
244
```
241
245
@@ -304,7 +308,7 @@ Sample configuration:
304
308
305
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:
0 commit comments