augmentcode / auggie
An AI agent that brings Augment Code's power to the terminal.
README
Auggie
Auggie is Augment’s agentic coding CLI that runs in your terminal. It understands your codebase and helps you ship faster by analyzing code, making safe edits, and automating routine tasks — all via natural language.
Learn more in the Augment Docs:
- Overview: Introducing Auggie CLI
- Custom Commands Examples: Custom Slash Commands Examples
Quick start
- Install Auggie (Node 22+ required):
npm install -g @augmentcode/auggie@latest
- Login:
auggie login
- Run Auggie in your project directory:
cd /path/to/your/project
auggie "optional initial prompt"
- Use
auggie --print "your instruction"to run once and print to stdout (great for CI) - Add
--quietto return only the final output
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).
Example structure:
your-project/
├─ .augment/
│ └─ commands/
│ ├─ code-review.md
│ ├─ bug-fix.md
│ ├─ security-review.md
│ └─ performance-optimization.md
└─ ...
See example command templates in .augment/commands/ and the docs page linked above.
GitHub Actions for PRs
Use our official GitHub Actions to improve PR quality automatically:
- Augment Agent: augmentcode/augment-agent
- Review PR: augmentcode/review-pr
- Describe PR: augmentcode/describe-pr
Examples:
- Review PR workflow example: example usage
- Describe PR workflow example: example usage
Add the workflows under .github/workflows/ in your repository.
Feedback and bug reports
- In Auggie or the IDE agent, use
/feedbackto send feedback or report bugs directly with helpful context. - Alternatively, open a GitHub issue using our templates (Bug report / Feature request) in the Github Issues tab.
Community
- Support: Support Portal
- Reddit: https://www.reddit.com/r/AugmentCodeAI/
Privacy and data usage
See Augment’s policies at augmentcode.com/legal and product docs for latest details.
