Skip to content

Commit a444273

Browse files
docs: add tutorials for using early access AI agent features (cherry-pick #17186) (#17208)
Cherry-picked docs: add tutorials for using early access AI agent features (#17186) Some content is still being merged, but the structure is still there Preview: https://coder.com/docs/@ai-features/tutorials/ai-agents Co-authored-by: Ben Potter <ben@coder.com>
1 parent e0b1082 commit a444273

20 files changed

+498
-0
lines changed
198 KB
Loading
128 KB
Loading
243 KB
Loading
Loading
175 KB
Loading
Loading
Loading

docs/manifest.json

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -693,6 +693,60 @@
693693
"description": "Learn how to install and run Coder quickly",
694694
"path": "./tutorials/quickstart.md"
695695
},
696+
{
697+
"title": "Run AI Coding Agents with Coder",
698+
"description": "Learn how to run and secure agents in Coder",
699+
"path": "./tutorials/ai-agents/README.md",
700+
"state": ["early access"],
701+
"children": [
702+
{
703+
"title": "Learn about coding agents",
704+
"description": "Learn about the different AI agents and their tradeoffs",
705+
"path": "./tutorials/ai-agents/agents.md"
706+
},
707+
{
708+
"title": "Create a Coder template for agents",
709+
"description": "Create a purpose-built template for your AI agents",
710+
"path": "./tutorials/ai-agents/create-template.md",
711+
"state": ["early access"]
712+
},
713+
{
714+
"title": "Integrate with your issue tracker",
715+
"description": "Assign tickets to AI agents and interact via code reviews",
716+
"path": "./tutorials/ai-agents/issue-tracker.md",
717+
"state": ["early access"]
718+
},
719+
{
720+
"title": "Best practices \u0026 adding tools via MCP",
721+
"description": "Improve results by adding tools to your agents",
722+
"path": "./tutorials/ai-agents/best-practices.md",
723+
"state": ["early access"]
724+
},
725+
{
726+
"title": "Supervise agents via Coder UI",
727+
"description": "Interact with agents via the Coder UI",
728+
"path": "./tutorials/ai-agents/coder-dashboard.md",
729+
"state": ["early access"]
730+
},
731+
{
732+
"title": "Supervise agents via the IDE",
733+
"description": "Interact with agents via VS Code or Cursor",
734+
"path": "./tutorials/ai-agents/ide-integration.md",
735+
"state": ["early access"]
736+
},
737+
{
738+
"title": "Programmatically manage agents",
739+
"description": "Manage agents via MCP, the Coder CLI, and/or REST API",
740+
"path": "./tutorials/ai-agents/headless.md",
741+
"state": ["early access"]
742+
},
743+
{
744+
"title": "Securing agents in Coder",
745+
"description": "Learn how to secure agents with boundaries",
746+
"path": "./tutorials/ai-agents/securing.md"
747+
}
748+
]
749+
},
696750
{
697751
"title": "Write a Template from Scratch",
698752
"description": "Learn how to author Coder templates",

docs/tutorials/ai-agents/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Run AI Agents in Coder (Early Access)
2+
3+
> [!NOTE]
4+
>
5+
> This functionality is in early access and subject to change. Do not run in
6+
> production as it is unstable. Instead, deploy these changes into a demo or
7+
> staging environment.
8+
>
9+
> Join our [Discord channel](https://discord.gg/coder) or
10+
> [contact us](https://coder.com/contact) to get help or share feedback.
11+
12+
AI Coding Agents such as [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview), [Goose](https://block.github.io/goose/), and [Aider](https://github.com/paul-gauthier/aider) are becoming increasingly popular for:
13+
14+
- Protyping web applications or landing pages
15+
- Researching / onboarding to a codebase
16+
- Assisting with lightweight refactors
17+
- Writing tests and documentation
18+
- Small, well-defined chores
19+
20+
With Coder, you can self-host AI agents in isolated development environments with proper context and tooling around your existing developer workflows. Whether you are a regulated enterprise or an individual developer, running AI agents at scale with Coder is much more productive and secure than running them locally.
21+
22+
![AI Agents in Coder](../../images/guides//ai-agents/landing.png)
23+
24+
## Prerequisites
25+
26+
Coder is free and open source for developers, with a [premium plan](https://coder.com/pricing) for enterprises. You can self-host a Coder deployment in your own cloud provider.
27+
28+
- A [Coder deployment](../../install/) with v2.21.0 or later
29+
- A Coder [template](../../admin/templates/) for your project(s).
30+
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI)
31+
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents
32+
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents
33+
34+
## Table of Contents
35+
36+
<children></children>

docs/tutorials/ai-agents/agents.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Coding Agents
2+
3+
> [!NOTE]
4+
>
5+
> This page is not exhaustive and the landscape is evolving rapidly. Please
6+
> [open an issue](https://github.com/coder/coder/issues/new) or submit a pull
7+
> request if you'd like to see your favorite agent added or updated.
8+
9+
There are several types of coding agents emerging:
10+
11+
- **Headless agents** can run without an IDE open and are great for rapid
12+
prototyping, background tasks, and chat-based supervision.
13+
- **In-IDE agents** require developers keep their IDE opens and are great for
14+
interactive, focused coding on more complex tasks.
15+
16+
## Headless agents
17+
18+
Headless agents can run without an IDE open, or alongside any IDE. They
19+
typically run as CLI commands or web apps. With Coder, developers can interact
20+
with agents via any preferred tool such as via PR comments, within the IDE,
21+
inside the Coder UI, or even via the REST API or an MCP client such as Claude
22+
Desktop or Cursor.
23+
24+
| Agent | Supported Models | Coder Support | Limitations |
25+
|---------------|---------------------------------------------------------|---------------------------|---------------------------------------------------------|
26+
| Claude Code ⭐ | Anthropic Models Only (+ AWS Bedrock and GCP Vertex AI) | First class integration ✅ | Beta (research preview) |
27+
| Goose | Most popular AI models + gateways | First class integration ✅ | Less effective compared to Claude Code |
28+
| Aider | Most popular AI models + gateways | In progress ⏳ | Can only run 1-2 defined commands (e.g. build and test) |
29+
| OpenHands | Most popular AI models + gateways | In progress ⏳ ⏳ | Challenging setup, no MCP support |
30+
31+
[Claude Code](https://github.com/anthropics/claude-code) is our recommended
32+
coding agent due to its strong performance on complex programming tasks.
33+
34+
> Note: Any agent can run in a Coder workspace via our
35+
> [MCP integration](./headless.md).
36+
37+
## In-IDE agents
38+
39+
Coding agents can also run within an IDE, such as VS Code, Cursor or Windsurf.
40+
These editors and extensions are fully supported in Coder and work well for more
41+
complex and focused tasks where an IDE is strictly required.
42+
43+
| Agent | Supported Models | Coder Support |
44+
|-----------------------------|-----------------------------------|--------------------------------------------------------------|
45+
| Cursor (Agent Mode) | Most popular AI models + gateways |[Cursor Module](https://registry.coder.com/modules/cursor) |
46+
| Windsurf (Agents and Flows) | Most popular AI models + gateways | ✅ via Remote SSH |
47+
| Cline | Most popular AI models + gateways | ✅ via VS Code Extension |
48+
49+
In-IDE agents do not require a special template as they are not used in a
50+
headless fashion. However, they can still be run in isolated Coder workspaces
51+
and report activity to the Coder UI.
52+
53+
## Next Steps
54+
55+
- [Create a Coder template for agents](./create-template.md)

0 commit comments

Comments
 (0)