Skip to content

Add common flags section to README #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
justinxu421 wants to merge 1 commit into from
Closed

Add common flags section to README #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Copy link

@github-actions github-actions bot Mar 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

| `-q, --quiet` | Show only the final assistant message |
Copy link

@augment-app-staging augment-app-staging bot Mar 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

| `-a, --ask` | Ask mode — retrieval and non-editing tools only |
| `-m, --model <id>` | Select the model to use (`auggie model list` to see options) |
Copy link

@augment-app-staging augment-app-staging bot Mar 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Fix This in Augment

🤖 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 |
Copy link

@augment-app-staging augment-app-staging bot Mar 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


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`).
Expand Down