GeezerVison is showing docs.augmentcode.com — CLI Flags and Options - Augment
CLI flags
| Command | Description |
|---|
auggie | Start Auggie in interactive mode | auggie --print "Summarize the staged changes" (-p) | Run one instruction in print mode and exit | auggie --print --mode stream "Summarize the staged changes" | Stream text and tool activity as it happens | auggie --print --mode json "Summarize the staged changes" | Output structured JSON events for automation workflows | auggie --print --show-cost "Summarize the staged changes" | Include cost and credit usage in the output | auggie --acp | Run Auggie as an ACP agent for compatible editors and clients |
Input
| Command | Description |
|---|
auggie "Fix the typescript errors" | Provide an initial instruction in interactive mode | auggie --print "Summarize the staged changes" | Provide an instruction and exit | cat file | auggie --print "Summarize this data" | Pipe content through stdin | auggie @prompt.md @screenshot.png "Explain this UI error" | Include files and images in the initial message | auggie --print --enhance-prompt "Fix the flaky test" | Run the prompt enhancer before sending the instruction | auggie --append-system-prompt <text-or-file> | Append text or file contents to the system prompt |
Custom Commands
| Command | Description |
|---|
auggie command list | List available custom commands | auggie command <command-name> [args...] | Execute a custom command | auggie command help <command-name> | Show help for a custom command |
See Custom Commands for detailed information on creating and managing custom commands.
Sessions
| Command | Description |
|---|
auggie --continue (-c) | Continue the most recent session | auggie --resume (-r) | Interactively choose a saved session to resume | auggie --session <path> | Use a specific session file | auggie --fork <path-or-id> | Fork a session file or partial session ID into a new session | auggie --session-dir <dir> | Directory for session storage and lookup | auggie --no-session | Do not save the session | auggie --export <session.jsonl> [output.html] | Export a session file to HTML and exit | auggie session list | List saved sessions from the current workspace (--all, --json, -n <number>) | auggie session stats [sessionId] | Show session statistics, including cost and credit usage |
Resuming a session restores its --permission and --add-workspace values unless you pass them again.
Workspace
| Command | Description |
|---|
auggie --workspace-root /path/to/project (-w) | Specify the root of the workspace (defaults to the git root) | auggie --add-workspace /path/to/another/project | Index an additional workspace alongside the primary workspace (repeatable) | auggie --discover-workspaces[=depth] | Discover git repositories under a non-git workspace root | auggie --no-discover-workspaces | Disable git repository discovery | auggie --worktree [slug] | Create or reuse a git worktree for this session | auggie --allow-indexing | Allow indexing for the current workspace and skip the confirmation screen | auggie --wait-for-indexing | Wait for workspace indexing to finish before the first agent turn | auggie --augment-cache-dir /path/to/dir | Relocate the Augment config and cache directory (default ~/.augment) |
Models
| Command | Description |
|---|
auggie --model "name" | Select the model. Append :<effort> to set the reasoning effort, for example sonnet:high | auggie --thinking <effort> | Set the reasoning effort. Use default to clear the override | auggie --models <patterns> | Comma-separated model patterns to cycle through | auggie model list [search] | List available models (--json for full metadata) |
Rules, skills, and resources
| Command | Description |
|---|
auggie --rule <path> | Load a rule file or directory (repeatable) | auggie --no-rules | Disable rule discovery | auggie --skill <path> | Load a skill file or directory (repeatable) | auggie --no-skills | Disable skill discovery | auggie --prompt-template <path> | Load a prompt template file or directory (repeatable) | auggie --theme <path> | Load a theme file or directory (repeatable) |
Skills are loaded automatically from .augment/skills/ and .claude/skills/ directories in both your workspace and home directory. See Skills for more information.
Tools
| Command | Description |
|---|
auggie --tools read,bash,edit,write | Enable only the listed built-in tools (read, bash, edit, write, grep, find, ls) | auggie --no-tools | Disable all built-in tools | auggie --remove-tool <tool-name> | Remove a tool by name for the current session (repeatable) | auggie --permission bash:ask-user | Set a tool permission rule for the current run (repeatable) | auggie --enable-tool-search | Hide individual MCP tools behind find-tool and execute-tool |
For fine-grained control over tool behavior (allow, deny, ask-user), see Permissions.
Plugins and extensions
| Command | Description |
|---|
auggie plugin marketplace add <source> | Add a plugin marketplace from a repository or URL | auggie --plugin-dir <path> | Load and enable plugins from a local marketplace directory (repeatable) | auggie install <source> [-l] | Install an extension package and add it to settings (-l for project settings) | auggie remove <source> [-l] | Remove an extension package from settings | auggie update [source] | Update installed extension packages | auggie list | List installed extension packages | auggie config | Enable or disable package resources | auggie --extension <path> (-e) | Load an extension file for this run (repeatable) | auggie --no-extensions | Disable extension discovery |
Use /plugins in interactive mode to browse and manage plugins. See Plugins and Marketplaces.
Auggie 1.x is built on pi, so pi extensions should work in Auggie. Install them with auggie install instead of pi install.
Extensions are third-party code that runs with your user permissions and can read your files, run commands, and
send data anywhere. Augment does not review, control, or support third-party extensions and is not responsible for
what they do, including any data they access or share. Only install extensions from sources you trust.Auggie includes changes to pi, so an extension may behave differently in Auggie than in pi. If something isn’t
working, let us know with /feedback.
MCP and integrations
| Command | Description |
|---|
auggie mcp add [options] <name> | Create or update a named MCP server configuration (--project or --local to choose the settings file) | auggie mcp add-json <name> <json> | Add an MCP server from JSON configuration | auggie mcp list | Display all configured MCP servers | auggie mcp remove <name> | Remove a named MCP server configuration | auggie --mcp-config <json-or-path> | Load MCP server configuration from inline JSON or a file (repeatable) |
--mcp-config overrides MCP servers defined in settings files.
For detailed usage examples, options, settings.json format, and precedence rules, see Integrations and MCP.
Cloud
| Command | Description |
|---|
auggie --cloud | Stream this session to Cosmos so it is visible and steerable from the web UI | auggie --no-cloud | Disable cloud mode | auggie cloud <command> | Manage cloud resources. See Cloud |
Authentication
| Command | Description |
|---|
auggie auth login [--headless] | Log in to Augment and store the session locally | auggie auth logout | Remove the local session | auggie auth status | Show the current authentication status | auggie token print | Print the current session JSON for automation | auggie token revoke | Revoke tokens for the current user and remove the local session | auggie --augment-session-json <json-or-path> | Authenticate with inline session JSON or a session file |
Diagnostics
| Command | Description |
|---|
auggie --log-file <path> | Write logs to the given file. Defaults to a temp file | auggie --log-level <level> | Set the log level: error, warn, info (default), or debug | auggie --verbose | Show the startup header even if quietStartup is set | auggie --offline | Disable startup network operations | auggie --check-startup | Boot, print startup diagnostics as JSON, and exit |
Additional commands
| Command | Description |
|---|
auggie upgrade | Upgrade Auggie to the latest version in its channel | auggie --help (-h) | Show help | auggie --version (-v) | Show version |
Environment Variables
| Variable | Description |
|---|
AUGMENT_SESSION_AUTH | Authentication JSON | AUGMENT_DISABLE_AUTO_UPDATE | Disable automatic CLI updates |
See Also
|