Skip to content

Commit 276751f

Browse files
committed
Add common flags section to README
Add a quick-reference table of commonly used CLI flags including: - Print/quiet/ask modes - Model selection - Session management (continue/resume) - Rules and MCP config - BYOK provider flags Links to the full CLI reference docs for complete details.
1 parent 023f661 commit 276751f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,24 @@ auggie "optional initial prompt"
3333
- Use `auggie --print "your instruction"` to run once and print to stdout (great for CI)
3434
- Add `--quiet` to return only the final output
3535

36+
## Common flags
37+
38+
| Flag | Description |
39+
| :--- | :---------- |
40+
| `-p, --print` | Run one instruction and print to stdout (non-interactive) |
41+
| `-q, --quiet` | Show only the final assistant message |
42+
| `-a, --ask` | Ask mode — retrieval and non-editing tools only |
43+
| `-m, --model <id>` | Select the model to use (`auggie model list` to see options) |
44+
| `-c, --continue` | Resume the most recent conversation |
45+
| `-r, --resume [id]` | Resume a specific session by ID or pick interactively |
46+
| `--rules <path>` | Additional rules file to append to workspace guidelines |
47+
| `--mcp-config <cfg>` | Path to MCP server configuration JSON |
48+
| `--provider-model <id>` | Override the provider model (BYOK) |
49+
| `--provider-api-key <key>` | API key for third-party provider (BYOK) |
50+
| `--provider-base-url <url>` | Base URL for third-party provider (BYOK) |
51+
52+
See the full [CLI reference](https://docs.augmentcode.com/cli/reference) for all flags and commands.
53+
3654
## Custom slash commands
3755

3856
Store reusable prompts in `.augment/commands/` as markdown files with frontmatter. Once added, they’re available as slash commands (e.g., `/code-review path/to/file`).

0 commit comments

Comments
 (0)