Skip to main content

CLI flags

CommandDescription
auggieStart Auggie in interactive mode
auggie --print (-p)Output simple text for one instruction and exit
auggie --quietOutput only the final response for one instruction and exit
auggie --compactOutput tool calls, results, and final response as one line each and exit
auggie -p --output-format jsonOutput the response in structured JSON format. Must be used with --print (-p) mode. Useful for parsing Auggie’s output programmatically in automation workflows.

Input

CommandDescription
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 --print "Summarize this data" < file.txtProvide input from a file
auggie --instruction "Fix the errors"Provide an initial instruction in interactive mode
auggie --instruction-file /path/to/file.txtProvide an instruction by file in interactive mode

Custom Commands

CommandDescription
auggie command <command-name>Execute a custom command from .augment/commands/ or ~/.augment/commands/
Custom commands are reusable instructions stored as markdown files. They can be placed in:
  • ~/.augment/commands/<name>.md - Global commands (user-wide)
  • ./.augment/commands/<name>.md - Project commands (workspace-specific)
  • ~/.claude/commands/<name>.md - Claude Code user commands
  • ./.claude/commands/<name>.md - Claude Code workspace commands
Commands are resolved in order of precedence, with Auggie-specific locations taking priority over Claude Code locations. Examples:
# Execute a custom deployment command
auggie command deploy-staging

# Execute a code review command
auggie command security-review

# List available commands (shown in help output)
auggie command help
See Custom Commands for detailed information on creating and managing custom commands.

Sessions

CommandDescription
auggie --continue (-c)Resumes the previous conversation
auggie --dont-save-sessionDo not save the conversation to the local history
auggie --delete-saved-sessionsDelete all saved sessions from disk

Configuration

CommandDescription
auggie --workspace-root /path/to/projectSpecify the root of the workspace
auggie --rules /path/to/rules.mdAdditional rules to append to workspace guidelines
auggie --model "name"Select the model to use (accepts long or short names from the model list)

Models

List out available models and their short names to be passed into the --model flag
CommandDescription
auggie --list-modelsList available models
auggie -lmShorthand for --list-models
Tool permissions can be configured in settings.json files. See Permissions for detailed configuration.

MCP and integrations

CommandDescription
auggie mcp add [options] <name>Create or update a named MCP server configuration
auggie mcp add-json <name> <json>Add an MCP server from JSON configuration
auggie mcp listDisplay all configured MCP servers
auggie mcp remove <name>Remove a named MCP server configuration
CommandDescription
auggie --mcp-config {key: value}MCP configuration as a JSON string
auggie --mcp-config /path/to/mcp.jsonMCP configuration from a JSON file
You can define MCP servers persistently in the settings files: ~/.augment/settings.json. Any --mcp-config flags are applied last and override settings.
For detailed usage examples, options, settings.json format, and precedence rules, see Integrations and MCP.

Authentication

CommandDescription
auggie --loginLogin to Augment and store the token locally
auggie --logoutRemove the locally stored token
auggie --print-augment-tokenPrint the locally stored token

Additional commands

CommandDescription
auggie --helpShow help
auggie --versionShow version

Environment Variables

VariableDescription
AUGMENT_SESSION_AUTHAuthentication JSON.
AUGMENT_API_URLBackend API endpoint
AUGMENT_API_TOKENAuthentication token
GITHUB_API_TOKENGitHub API token
AUGMENT_DISABLE_AUTO_UPDATEDisable automatic CLI updates

See Also

I