Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation-only change that adds a useful quick-reference table. One concern about the accuracy of shorthand flag mappings that should be verified against the current CLI source before merging.
🤖 Automated review complete. Please react with 👍 or 👎 on the individual review comments to provide feedback on their usefulness.
|
|
||
| | Flag | Description | | ||
| | :--- | :---------- | | ||
| | `-p, --print` | Run one instruction and print to stdout (non-interactive) | |
There was a problem hiding this comment.
The CHANGELOG (v0.5.0) documents -p as shorthand for --prompt and -q as shorthand for --query:
Added shorthand flags for common options:
-i(input),-if(input-file),-p(prompt),-q(query),-lm(list-models),-m(model),-cm(command)
This table maps -p → --print and -q → --quiet, which contradicts that CHANGELOG entry. Could you verify against the current CLI source that these shorthand mappings are correct? If the shorthands were reassigned in a later version, that's fine — but worth double-checking to avoid confusing users.
🤖 Augment PR SummarySummary: Adds a "Common flags" quick-reference section to the README so frequently used Auggie CLI options are discoverable. 🤖 Was this summary useful? React with 👍 or 👎 |
![augment-app-staging[bot]](https://avatars.githubusercontent.com/in/1008152?s=60&v=4){kind=small}
| | Flag | Description | | ||
| | :--- | :---------- | | ||
| | `-p, --print` | Run one instruction and print to stdout (non-interactive) | | ||
| | `-q, --quiet` | Show only the final assistant message | |
There was a problem hiding this comment.
The CLI reference documents --quiet but doesn’t list a -q short flag; is -q actually supported? If not, consider removing -q here to avoid misleading users.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| | `-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 <id>` | Select the model to use (`auggie model list` to see options) | |
There was a problem hiding this comment.
The CLI reference uses auggie models list (plural) to list available models, but this hint says auggie model list. Consider aligning the command name to prevent copy/paste errors.
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| | `-c, --continue` | Resume the most recent conversation | | ||
| | `-r, --resume [id]` | Resume a specific session by ID or pick interactively | | ||
| | `--rules <path>` | Additional rules file to append to workspace guidelines | | ||
| | `--mcp-config <cfg>` | Path to MCP server configuration JSON | |
There was a problem hiding this comment.
Docs indicate --mcp-config can be provided as a JSON string or as a path to a JSON file, but this description reads like it only accepts a file path. Consider broadening wording if both forms are supported.
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
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.
justinxu421
force-pushed
the
augment-agent-add-common-flags-to-readme
branch
from
276751f to
a5f901c
Compare
1 participant
Summary
Adds a quick-reference table of commonly used CLI flags to the README. Many of these flags exist in the CLI but weren't mentioned in the README at all.
Changes
Adds a "Common flags" section with a table covering:
-p/--print,-q/--quiet,-a/--ask-m/--model-c/--continue,-r/--resume--rules,--mcp-configLinks to the full CLI reference for complete details.
Note: BYOK flags (
--provider-model,--provider-api-key,--provider-base-url) were intentionally excluded as they are not yet publicly available (gated to specific tenants inflags.jsonnet).Context
This was identified by scanning the CLI source code in
clients/cli/src/cli/arguments/and comparing against the existing README, cross-referenced withtools/feature_flags/flags.jsonnetto confirm public availability.