Documentation Index
Fetch the complete documentation index at: https://docs.augmentcode.com/llms.txt
Use this file to discover all available pages before exploring further.
Quickstart
First-run setup is a single guided flow: connect a couple of integrations, pick where your agents run, and start a session. Skip anything you’re not ready for and finish it later in Settings.Connect GitHub
Click “Connect GitHub” to install the Augment Code GitHub App. An administrator picks which repositories Cosmos can access.Once installed, agents can open PRs, comment on them, and read code from any repo you grant access to.
Connect Slack (Optional)
Click “Connect Slack” to authorize Cosmos to read and post in channels. The administrator specifies which channels Cosmos has access to.Now your Experts can post in those channels, react to messages, and reply in threads.
Connect Linear (Optional)
Click “Connect Linear” to allow Cosmos to access your projects, tickets, and events — including label changes such as moving a ticket from Backlog to In Progress.Agents can now read issues, post comments, and react to status changes —
Backlog → In Progress is the usual trigger.Pick Where Your Agents Run
Choose one of two options:
| Option | Description |
|---|---|
| Self-hosted | One command on your laptop, VM, or server. Fastest path if your repo and tooling are already there. |
| Cloud | We host the VM. Start from a base image (or bring your own), point it at your repos. |
Choose a Starting Environment (Cloud only)
If you chose Cloud, pick a base image to start from. You can customize it later or bring your own.
| Environment | Description |
|---|---|
| Cosmos Default | Ubuntu 24.04 with Python 3.12 and Node.js 22 installed |
| TypeScript 6.0 | Dev Container running Debian 12 with TypeScript 6.0 and Node 22 |
| Go 1.24 | Official Go 1.24 development environment with Node 22 |
| PHP 8.4 | Official PHP 8.4 development environment with Node 22 |
| Ruby 3.4 | Official Ruby 3.4 development environment with Node 22 |
| Rust 1.95 | Official Rust 1.95 development environment with Node 22 |
Add Repositories
A dropdown lets you select which repositories to clone into your environment. These are the repos shared via the GitHub integration. Add multiple repos to let Cosmos work across projects — you can add more later. Click “Next” when done, or “Skip for now” to continue without selecting repos.
Name Your Environment
Give your environment a name you’ll recognize later (e.g.
weather-app-repo). Optionally add a description that will appear on the environments list (e.g. Pre-configured with Python 3.12, NumPy, and Jupyter). Click “Create Environment” when ready.Cosmos provisions your environment automatically. A progress dialog shows each stage:- ✅ VM started
- ⏳ Cloning repositories…
- ⏳ Creating snapshot…
- ⏳ Finishing up…
Pick Your Experts
Choose one or more Experts to install. If you don’t know what to pick, install PR Author — it carries a PR from
git checkout -b through merge, including the CI-failure cleanup nobody wants to do.