Skip to main content

​
CLI flags

CommandDescription
auggieStart Auggie in interactive mode
auggie --printOutput 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

​
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 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

​
Custom Rules Files

Auggie automatically loads custom rules and guidelines from several file locations to provide context-aware assistance. These files help Auggie understand your project’s conventions, coding standards, and preferences.

​
Supported Rules Files

Auggie looks for rules files in the following order of precedence:
  1. Custom rules file (via --rules flag): /path/to/custom-rules.md
  2. CLAUDE.md: Compatible with Claude Code and other AI tools
  3. AGENTS.md: Compatible with Cursor and other AI development tools
  4. Workspace guidelines: .augment/guidelines.md (legacy format)

​
File Locations

Workspace Root Files:
  • CLAUDE.md - Root-level rules file compatible with Claude Code
  • AGENTS.md - Root-level rules file compatible with Cursor and other tools
Augment Directory Files:
  • .augment/guidelines.md - Legacy workspace guidelines file
  • .augment/rules/ - Directory containing multiple rule files (IDE feature)

​
Rules File Format

Rules files should be written in Markdown format with natural language instructions. Here’s the recommended structure: 
# Project Guidelines

## Code Style
- Use TypeScript for all new JavaScript files
- Follow the existing naming conventions in the codebase
- Add JSDoc comments for all public functions and classes

## Architecture
- Follow the MVC pattern established in the codebase
- Place business logic in service classes
- Keep controllers thin and focused on request/response handling

## Testing
- Write unit tests for all new functions
- Maintain test coverage above 80%
- Use Jest for testing framework

## Dependencies
- Prefer built-in Node.js modules when possible
- Use npm for package management
- Pin exact versions in package.json for production dependencies

​
Example Rules Files

Basic Project Rules (CLAUDE.md): 
# Development Guidelines

- Use semantic commit messages following conventional commits
- Run `npm run lint` before committing changes
- Update documentation when adding new features
- Follow the existing error handling patterns
- Use environment variables for configuration
Framework-Specific Rules (AGENTS.md): 
# React Project Guidelines

## Component Development
- Use functional components with hooks
- Implement proper TypeScript interfaces for props
- Follow the established folder structure in src/components/

## State Management
- Use React Context for global state
- Keep component state local when possible
- Use custom hooks for complex state logic

## Styling
- Use CSS modules for component styling
- Follow the design system tokens defined in src/styles/tokens.css
- Ensure responsive design for mobile and desktop
Backend API Rules: 
# API Development Guidelines

## Endpoint Design
- Follow RESTful conventions for URL structure
- Use appropriate HTTP status codes
- Include proper error messages in responses

## Database
- Use Prisma ORM for database operations
- Write database migrations for schema changes
- Include proper indexing for query performance

## Security
- Validate all input parameters
- Use JWT tokens for authentication
- Implement rate limiting on public endpoints

​
Best Practices for Rules Files

  1. Be Specific: Provide clear, actionable guidelines rather than vague suggestions
  2. Use Examples: Include code examples when describing patterns or conventions
  3. Keep Updated: Regularly review and update rules as your project evolves
  4. Be Concise: Focus on the most important guidelines to avoid overwhelming the AI
  5. Test Guidelines: Verify that Auggie follows your rules by testing with sample requests

​
Compatibility with Other Tools

The CLAUDE.md and AGENTS.md formats are designed to be compatible with other AI development tools:
  • Claude Code: Uses CLAUDE.md for project-specific instructions
  • Cursor: Supports AGENTS.md for AI assistant configuration
  • Other AI Tools: Many tools are adopting these standard file formats
This ensures your rules work consistently across different AI development environments.