## Get started in minutes
Augment works with your favorite IDE and your favorite programming language. Download the extension, sign in, and get coding.
Get completions, chat, and instructions in your favorite open source editor.
Completions are available for all JetBrains IDEs, like WebStorm, PyCharm, and IntelliJ.
Get completions and chat in your favorite text editor.
## Installing Augment for JetBrains IDEs
in the side bar of your IDE. See more details in [Sign
In](/setup-augment/sign-in).
## Using Agent
To use Agent, simply type your request into the input box using natural language and click the submit button. You will see the default context including current workspace, current file, and Agent memories. You can add additional context by clicking 
### Checkpoints
Checkpoints are automatically saved snapshots of your workspace as Agent implements the plan allowing you to easily revert back to a previous step. This enables Agent to continue working while you review code changes and commands results. To revert to a previous checkpoint, click the reverse arrow icon at the point you want to return to.
### Agent memories
Memories help the Agent remember important details about your workspace and your preferences for working in it. Memories are stored locally and are applied to all Agent requests. Memories can be added automatically by Agent, by clicking the remember button under a message, asking Agent to remember something, or by editing the Memories files directly.
### Agent modes
Agent can work in two modes: Manual or Auto. After Agent has made a plan from your request, Agent can implement that plan either automatically or with some manual approval from you.
**Manual mode**
In Manual mode, Agent will pause work when it needs to execute a terminal command or access external integrations. Manual mode allows you to review actions before they are executed. After reviewing the suggested action, click the blue play button to have Agent execute the command and continue working.
**Auto mode**
In Auto mode, Agent will implement the entire plan for you. Agent will edit files, execute terminal commands, and access tools like MCP servers automatically.
### Comparison to Chat
Agent takes Chat to the next level by allowing Augment to do things for you-that is create and make modifications directly to your codebase. Chat can explain code, create plans, and suggest changes which you can smartly apply one-by-one, but Agent takes it a step further by automatically implementing the entire plan and all code changes for you.
| What are you trying to do? | Chat | Agent |
| :----------------------------------------------- | :--: | :---: |
| Ask questions about your code | ☑️ | ✅ |
| Get advice on how to refactor code | ☑️ | ✅ |
| Add new features to selected lines of code | ☑️ | ✅ |
| Add new feature spanning multiple files | | ✅ |
| Document new features | | ✅ |
| Queue up tests for you in the terminal | | ✅ |
| Open Linear tickets or start a pull request | | ✅ |
| Start a new branch in GitHub from recent commits | | ✅ |
| Automatically perform tasks on your behalf | | ✅ |
### Use cases
Use Agent to handle various aspects of your software development workflow, from simple configuration changes to complex feature implementations. Agent supports your daily engineering tasks like:
* **Make quick edits** - Create a pull request to adjust configuration values like feature flags from FALSE to TRUE
* **Perform refactoring** - Move functions between files while maintaining coding conventions and ensuring bug-free operation
* **Start a first draft for new features** - Start a pull request (PR) with implementing entirely new functionality straight from a GitHub Issue or Linear Ticket
* **Branch from GitHub** - Open a PR from GitHub based on recent commits that creates a new branch
* **Add Pull Request descriptions** - Merge your PR into a branch then tell the agent to explain what the changes are and why they were made
* **Create test coverage** - Generate unit tests for your newly developed features
* **Generate documentation** - Produce comprehensive documentation for your libraries and features
* **Start a README** - Write a README for a new feature or updated function that you just wrote
* **Track development progress** - Review and summarize your recent Git commits for better visibility with the GitHub integration
## Next steps
* [Configure Agent Integrations](/setup-augment/agent-integrations)
* [Configure other tools with MCP](/setup-augment/mcp)
# Using Chat
Source: https://docs.augmentcode.com/jetbrains/using-augment/chat
Use Chat to explore your codebase, quickly get up to speed on unfamiliar code, and get help working through a technical problem.
export const win = {
openPanel: "Ctrl L",
commandsPalette: "Ctrl Shift A",
completions: {
toggle: "Ctrl Alt A",
toggleIntelliJ: "Ctrl Alt 9",
accept: "Tab",
reject: "Esc",
acceptNextWord: "Ctrl →"
},
instructions: {
start: "Ctrl I",
accept: "Return",
reject: "Esc"
},
suggestions: {
goToNext: "Ctrl ;",
goToPrevious: "Ctrl Shift ;",
accept: "Enter",
reject: "Backspace",
undo: "Ctrl Z",
redo: "Ctrl Y"
}
};
export const mac = {
openPanel: "Cmd L",
commandsPalette: "Cmd Shift A",
completions: {
toggle: "Cmd Option A",
toggleIntelliJ: "Cmd Option 9",
accept: "Tab",
reject: "Esc",
acceptNextWord: "Cmd →"
},
instructions: {
start: "Cmd I",
accept: "Return",
reject: "Esc"
},
suggestions: {
goToNext: "Cmd ;",
goToPrevious: "Cmd Shift ;",
accept: "Enter",
reject: "Backspace",
undo: "Cmd Z",
redo: "Cmd Shift Z"
}
};
export const DeleteIcon = () => 
## Accessing Chat
Access the Chat sidebar by clicking the Augment icon 
in the sidebar or the status bar. You can also open Chat by using one of the keyboard shortcuts below.
**Keyboard Shortcuts**
| Platform | Shortcut |
| :------------ | :------------------------------------ |
| MacOS | 
## Using actions in Chat
To use a quick action, you an use a 
## Using code blocks from within Chat
Whenever Chat responds with code, you will have the option to add the code to your codebase. The most common option will be shown as a button and you can access the other options by clicking the overflow menu icon
in the status bar at the bottom right corner of your IDE, then selecting in the status bar at the bottom right corner of your IDE, then selecting
Install Augment for Visual Studio Code
Install Augment for JetBrains IDEs, including WebStorm, PyCharm, and IntelliJ
Get completions and chat in your favorite text editor.
You'll be redirected to authorize the integration with the appropriate service. After authorization, the integration will be available for use with Augment Agent.
## 
### 2. Install Slack App
## Installing Augment for Visual Studio Code
in the side bar of your IDE. See more details in [Sign
In](/setup-augment/sign-in).
## Add context to your workspace
To add context to your workspace, click 
| Synced, or sync in progress |
| 
| Not synced |
| 
| Some files within the folder are synced |
# Index your workspace
Source: https://docs.augmentcode.com/setup-augment/workspace-indexing
When your workspace is indexed, Augment can provide tailored code suggestions and answers based on your unique codebase, best practices, coding patterns, and preferences. You can always control what files are indexed.
## About indexing your workspace
When you open a workspace with Augment enabled, your codebase will be automatically uploaded to Augment's secure cloud. You can control what files get indexed using `.gitignore` and `.augmentignore` files. Indexing usually takes less than a minute but can take longer depending on the size of your codebase. In Visual Studio Code, you can use Workspace Context to [view what files are indexed](/setup-augment/workspace-context#view-index-status-in-visual-studio-code) and [add additional context](/setup-augment/workspace-context).
## Security and privacy
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. [Read more about our security](https://www.augmentcode.com/security).
## What gets indexed
Augment will index all the files in your workspace, except for the files that match patterns in your `.gitignore` file and the `.augmentignore` file. You can [view what files are indexed](/setup-augment/workspace-context#view-sync-status-in-visual-studio-code) in Workspace Context.
## Ignoring files with .augmentignore
The `.augmentignore` file is a list of file patterns that Augment will ignore when indexing your workspace. Create an `.augmentignore` file in the root of your workspace. You can use any glob pattern that is supported by the [gitignore](https://git-scm.com/docs/gitignore) file.
## Including files that are .gitignored
If you have a file or directory in your `.gitignore` that you want to indexed, you can add it to your `.augmentignore` file using the `!` prefix.
For example, you may want your `node_modules` indexed to provide Augment with context about the dependencies in their project, but it is typically included in their `.gitignore`. Add `!node_modules` to your `.augmentignore` file.
{" "}
in the status bar at the bottom right corner of your editor, and select
`Show History` from the command menu.
{" "}
in the action bar on the left side of your editor.
{" "}
in the status bar at the bottom right corner of your editor, and select
`Show History` from the command menu.
## Using Agent
To use Agent, simply type your request into the input box using natural language and click the submit button. You will see the default context including current workspace, current file, and Agent memories. You can add additional context by clicking
### Checkpoints
Checkpoints are automatically saved snapshots of your workspace as Agent implements the plan allowing you to easily revert back to a previous step. This enables Agent to continue working while you review code changes and commands results. To revert to a previous checkpoint, click the reverse arrow icon at the point you want to return to.
### Agent memories
Memories help the Agent remember important details about your workspace and your preferences for working in it. Memories are stored locally and are applied to all Agent requests. Memories can be added automatically by Agent, by clicking the remember button under a message, asking Agent to remember something, or by editing the Memories files directly.
### Agent modes
Agent can work in two modes: Manual or Auto. After Agent has made a plan from your request, Agent can implement that plan either automatically or with some manual approval from you.
**Manual mode**
In Manual mode, Agent will pause work when it needs to execute a terminal command or access external integrations. Manual mode allows you to review actions before they are executed. After reviewing the suggested action, click the blue play button to have Agent execute the command and continue working.
**Auto mode**
In Auto mode, Agent will implement the entire plan for you. Agent will edit files, execute terminal commands, and access tools like MCP servers automatically.
### Comparison to Chat
Agent takes Chat to the next level by allowing Augment to do things for you-that is create and make modifications directly to your codebase. Chat can explain code, create plans, and suggest changes which you can smartly apply one-by-one, but Agent takes it a step further by automatically implementing the entire plan and all code changes for you.
| What are you trying to do? | Chat | Agent |
| :----------------------------------------------- | :--: | :---: |
| Ask questions about your code | ☑️ | ✅ |
| Get advice on how to refactor code | ☑️ | ✅ |
| Add new features to selected lines of code | ☑️ | ✅ |
| Add new feature spanning multiple files | | ✅ |
| Document new features | | ✅ |
| Queue up tests for you in the terminal | | ✅ |
| Open Linear tickets or start a pull request | | ✅ |
| Start a new branch in GitHub from recent commits | | ✅ |
| Automatically perform tasks on your behalf | | ✅ |
### Use cases
Use Agent to handle various aspects of your software development workflow, from simple configuration changes to complex feature implementations. Agent supports your daily engineering tasks like:
* **Make quick edits** - Create a pull request to adjust configuration values like feature flags from FALSE to TRUE
* **Perform refactoring** - Move functions between files while maintaining coding conventions and ensuring bug-free operation
* **Start a first draft for new features** - Start a pull request (PR) with implementing entirely new functionality straight from a GitHub Issue or Linear Ticket
* **Branch from GitHub** - Open a PR from GitHub based on recent commits that creates a new branch
* **Add Pull Request descriptions** - Merge your PR into a branch then tell the agent to explain what the changes are and why they were made
* **Create test coverage** - Generate unit tests for your newly developed features
* **Generate documentation** - Produce comprehensive documentation for your libraries and features
* **Start a README** - Write a README for a new feature or updated function that you just wrote
* **Track development progress** - Review and summarize your recent Git commits for better visibility with the GitHub integration
## Next steps
* [Configure Agent Integrations](/setup-augment/agent-integrations)
* [Configure other tools with MCP](/setup-augment/mcp)
# Using Chat
Source: https://docs.augmentcode.com/using-augment/chat
Use Chat to explore your codebase, quickly get up to speed on unfamiliar code, and get help working through a technical problem.
export const win = {
openPanel: "Ctrl L",
commandsPalette: "Ctrl Shift A",
completions: {
toggle: "Ctrl Alt A",
toggleIntelliJ: "Ctrl Alt 9",
accept: "Tab",
reject: "Esc",
acceptNextWord: "Ctrl →"
},
instructions: {
start: "Ctrl I",
accept: "Return",
reject: "Esc"
},
suggestions: {
goToNext: "Ctrl ;",
goToPrevious: "Ctrl Shift ;",
accept: "Enter",
reject: "Backspace",
undo: "Ctrl Z",
redo: "Ctrl Y"
}
};
export const mac = {
openPanel: "Cmd L",
commandsPalette: "Cmd Shift A",
completions: {
toggle: "Cmd Option A",
toggleIntelliJ: "Cmd Option 9",
accept: "Tab",
reject: "Esc",
acceptNextWord: "Cmd →"
},
instructions: {
start: "Cmd I",
accept: "Return",
reject: "Esc"
},
suggestions: {
goToNext: "Cmd ;",
goToPrevious: "Cmd Shift ;",
accept: "Enter",
reject: "Backspace",
undo: "Cmd Z",
redo: "Cmd Shift Z"
}
};
export const DeleteIcon = () =>
## Accessing Chat
Access the Chat sidebar by clicking the Augment icon in the sidebar or the status bar. You can also open Chat by using one of the keyboard shortcuts below.
**Keyboard Shortcuts**
| Platform | Shortcut |
| :------------ | :------------------------------------ |
| MacOS |
## Using actions in Chat
To use a quick action, you an use a
## Using code blocks from within Chat
Whenever Chat responds with code, you will have the option to add the code to your codebase. The most common option will be shown as a button and you can access the other options by clicking the overflow menu icon
#### Adding user guidelines
You can add user guidelines by clicking in the status bar at the bottom right corner of your IDE, then selecting in the status bar at the bottom right corner of your IDE, then selecting 
Your change will be made as a diff, so you can review the suggested updates before modifying your code. Use the following shortcuts or click the options in the UI to accept or reject the changes.
When Next Edit has a suggestion available, you will see a gutter icon and a summary
of the change in gray at the end of the line.
To jump to the next suggestion, press 
By default, Next Edit will briefly highlight which parts of the existing code will
change before applying the change and highlighting the new code. Use Undo
(
1. **Editor Title Icon** (Top Right): Changes colors when next edits are available.
Click on the 
4. **Hint Box** (Bottom Left) - appears when the next suggestion is off screen with
brief summary of the change and the keybinding to press (typically
## Adding Augment to Channels
Mention