Getting Started
Visual Studio Code
- Setup Augment
- Agent
- Chat
- Next Edit
- Instructions
- Completions
JetBrains IDEs
- Setup Augment
- Agent
- Chat
- Completions
Vim and Neovim
- Setup Augment
- Chat
- Completions
Troubleshooting
- FAQ
- Support
- Other code assistants
- Feedback
- Request IDs
- Chat panel steals focus
FAQ
Find answers to common questions about Augment, including setup, features, troubleshooting, and account management.
General Questions
Augment is a developer AI platform that helps you understand code, debug issues, and ship faster because it understands your codebase. It offers features like Agent, Chat, Next Edit, Instructions and Code Completions to enhance your development workflow.
Augment currently supports:
- Visual Studio Code
- JetBrains IDEs (IntelliJ, WebStorm, PyCharm, etc.)
- Vim and Neovim
Augment is designed to deeply understand your entire codebase, not just the current file. This allows it to provide more contextually relevant suggestions, explanations, and edits. Augment also offers features like Agent that can help you complete complex tasks across your codebase.
Setup and Installation
You can install Augment from your IDE’s extension marketplace:
- For VS Code: VS Code Marketplace
- For JetBrains IDEs: JetBrains Marketplace
- For Vim/Neovim: Follow our installation guide
For detailed instructions, see our Quickstart guide.
Signing in allows Augment to securely store and access your codebase context, preferences, and settings across devices. It also enables features like workspace indexing and integration with external services.
Having multiple code assistants enabled can cause conflicts. To disable other assistants like GitHub Copilot, see our guide on disabling other code assistants.
Features and Usage
Workspace indexing is how Augment builds an understanding of your codebase. When your workspace is indexed, Augment can provide tailored code suggestions and answers based on your unique codebase, best practices, coding patterns, and preferences. Learn more about workspace indexing.
- Chat allows you to ask questions about your code and get explanations, suggestions, and code snippets.
- Agent is more powerful and can take actions on your behalf, like creating, editing, or deleting code across your workspace, and using tools like the terminal and external integrations.
Next Edit helps you complete your train of thought by suggesting changes based on your recent work and other context. You can jump to the next edit by pressing Cmd/Ctrl ; and quickly accept or reject the suggested change. Learn more about Next Edit.
Yes, you can customize Augment using guidelines. Guidelines are natural language instructions that help Augment reply with more accurate and relevant responses based on your preferences, package versions, styles, and other implementation details. Learn more about guidelines.
Privacy and Security
Augment stores your code securely and privately to enable our powerful context engine. We ensure code privacy through a proof-of-possession API and maintain strict internal data minimization principles. For more details, see our Security page.
Yes, you can control what files get indexed using .gitignore and .augmentignore files. Learn more about controlling what gets indexed.
Troubleshooting
This could be due to incomplete indexing. Check that your workspace is fully indexed and that you haven’t excluded important files. You can also try adding more context to your queries using the @-mention feature. Learn more about focusing context.
To report a bug, please contact Support with details about the issue. Include as much detail as possible, such as steps to reproduce, screenshots, and your Request ID if available. Learn how to find your Request ID.
Some users on Linux systems have reported this issue. You can resolve it by enabling off-screen rendering in your JetBrains IDE. See our guide on fixing focus issues.
Account and Billing
You can manage your subscription by visiting your account settings on the Augment website.
Yes, Augment offers a free trial period. Visit our pricing page for the most up-to-date information on our plans and trial options.
Still need help?
If you couldn’t find an answer to your question, please check our documentation or contact our support team.