From a5f901c465537a135a18adf2ca796d7ac5a46a79 Mon Sep 17 00:00:00 2001 From: Justin Xu Date: Sat, 14 Mar 2026 00:33:25 +0000 Subject: [PATCH] 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 Links to the full CLI reference docs for complete details. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 17b1230..caa2eea 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,21 @@ auggie "optional initial prompt" - Use `auggie --print "your instruction"` to run once and print to stdout (great for CI) - Add `--quiet` to return only the final output +## Common flags + +| Flag | Description | +| :--- | :---------- | +| `-p, --print` | Run one instruction and print to stdout (non-interactive) | +| `-q, --quiet` | Show only the final assistant message | +| `-a, --ask` | Ask mode — retrieval and non-editing tools only | +| `-m, --model ` | Select the model to use (`auggie model list` to see options) | +| `-c, --continue` | Resume the most recent conversation | +| `-r, --resume [id]` | Resume a specific session by ID or pick interactively | +| `--rules ` | Additional rules file to append to workspace guidelines | +| `--mcp-config ` | Path to MCP server configuration JSON | + +See the full [CLI reference](https://docs.augmentcode.com/cli/reference) for all flags and commands. + ## Custom slash commands 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`).