Skip to content

Commit 0b3a2d4

Browse files
jdorfmanampcode-com
andcommitted
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
1 parent bee643c commit 0b3a2d4

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

docs/amp_cli_docs.md

Lines changed: 13 additions & 9 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:
@@ -135,7 +135,7 @@ Amp CLI supports the following options:
135135
| `--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
@@ -169,8 +169,8 @@ Amp CLI includes several subcommands for enhanced functionality:
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) |
@@ -196,7 +196,8 @@ amp -x "what file in this folder is in markdown format?"
196196
```
197197

198198
Output:
199-
```
199+
200+
```text
200201
All Markdown files in this folder:
201202
- README.md (root)
202203
- AGENT.md (root)
@@ -212,7 +213,8 @@ amp --dangerously-allow-all -x "Rename all .markdown files to .md. Only print li
212213
```
213214

214215
Output:
215-
```
216+
217+
```text
216218
- readme.markdown → readme.md
217219
- ghostty.markdown → ghostty.md
218220
```
@@ -224,7 +226,8 @@ echo "commit all my unstaged changes" | amp -x --dangerously-allow-all
224226
```
225227

226228
Output:
227-
```
229+
230+
```text
228231
Done. I have committed all your unstaged changes.
229232
```
230233

@@ -235,7 +238,8 @@ cat ~/.zshrc | amp -x "what does the 'beautiful' function do?"
235238
```
236239

237240
Output:
238-
```
241+
242+
```text
239243
The `beautiful` function creates an infinite loop that prints the letter "o" in cycling colors every 0.2 seconds.
240244
```
241245

@@ -304,7 +308,7 @@ Sample configuration:
304308

305309
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:
306310

307-
```
311+
```text
308312
Amp wants to run: git status
309313
310314
Allow this command? [y/n/!]

docs/amp_faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ Source: [Discord](https://discord.com/channels/1369018393407127613/1392299889550
2727

2828
---
2929

30-
_Last updated: 2025-07-12_
30+
>_Last updated: 2025-07-12_

0 commit comments

Comments
 (0)