https://github.com/augmentcode/auggie
An AI agent that brings Augment Code's power to the terminal.
https://github.com/augmentcode/auggie
Last synced: 4 days ago
JSON representation
An AI agent that brings Augment Code's power to the terminal.
- Host: GitHub
- URL: https://github.com/augmentcode/auggie
- Owner: augmentcode
- License: other
- Created: 2025-09-08T20:43:39.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-22T02:05:36.000Z (5 days ago)
- Last Synced: 2026-01-22T08:03:59.544Z (5 days ago)
- Homepage: https://www.augmentcode.com/
- Size: 691 KB
- Stars: 118
- Watchers: 1
- Forks: 13
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Auggie
 [](https://www.npmjs.com/package/@augmentcode/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](https://docs.augmentcode.com/cli/overview)
- Custom Commands Examples: [Custom Slash Commands Examples](https://docs.augmentcode.com/cli/custom-commands-examples)
## Quick start
1. Install Auggie (Node 22+ required):
```sh
npm install -g @augmentcode/auggie@latest
```
2. Login:
```sh
auggie login
```
3. Run Auggie in your project directory:
```sh
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 `--quiet` to 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](https://github.com/augmentcode/augment-agent)
- Review PR: [augmentcode/review-pr](https://github.com/augmentcode/review-pr)
- Describe PR: [augmentcode/describe-pr](https://github.com/augmentcode/describe-pr)
Examples:
- Review PR workflow example: [example usage](https://github.com/augmentcode/review-pr#example-usage)
- Describe PR workflow example: [example usage](https://github.com/augmentcode/describe-pr#example-usage)
Add the workflows under `.github/workflows/` in your repository.
## Feedback and bug reports
- In Auggie or the IDE agent, use `/feedback` to 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](https://github.com/augmentcode/auggie/issues) tab.
## Community
- Support: [Support Portal](https://support.augmentcode.com/)
- Reddit: https://www.reddit.com/r/AugmentCodeAI/
## Privacy and data usage
See Augment’s policies at [augmentcode.com/legal](https://augmentcode.com/legal) and product docs for latest details.