Skip to content

Commit 00e8387

Browse files
committed
feat: draft tasks docs
1 parent 4095330 commit 00e8387

File tree

12 files changed

+248
-109
lines changed

12 files changed

+248
-109
lines changed

docs/ai-coder/coming-soon.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Coming soon

docs/ai-coder/custom-agents.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
11
# Custom Agents
22

3-
> [!NOTE]
4-
>
5-
> This functionality is in beta and is evolving rapidly.
6-
>
7-
> When using any AI tool for development, exercise a level of caution appropriate to your use case and environment.
8-
> Always review AI-generated content before using it in critical systems.
9-
>
10-
> Join our [Discord channel](https://discord.gg/coder) or
11-
> [contact us](https://coder.com/contact) to get help or share feedback.
12-
13-
Custom agents beyond the ones listed in the [Coder registry](https://registry.coder.com/modules?tag=agent) can be used with Coder.
3+
Custom agents beyond the ones listed in the [Coder registry](https://registry.coder.com/modules?tag=agent) can be used with Coder Tasks.
144

155
## Prerequisites
166

docs/ai-coder/ide-agents.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document coming soon on how to pre-install IDE agents, configure your LLM provider, etc.

docs/ai-coder/index.md

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,19 @@
1-
# Use AI Coding Agents in Coder Workspaces
1+
# Run AI Coding Agents in Coder
22

3-
> [!NOTE]
4-
>
5-
> This functionality is in beta and is evolving rapidly.
6-
>
7-
> When using any AI tool for development, exercise a level of caution appropriate to your use case and environment.
8-
> Always review AI-generated content before using it in critical systems.
9-
>
10-
> Join our [Discord channel](https://discord.gg/coder) or
11-
> [contact us](https://coder.com/contact) to get help or share feedback.
3+
Learn how to run & manage coding agents with Coder, both alongside existing workspaces and for background task execution.
124

13-
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:
5+
## Agents in the IDE
146

15-
- Protyping web applications or landing pages
16-
- Researching / onboarding to a codebase
17-
- Assisting with lightweight refactors
18-
- Writing tests and draft documentation
19-
- Small, well-defined chores
7+
Coder [integrates with IDEs](../user-guides/workspace-access/index.md) such as Cursor, Windsurf, and Zed that include built-in coding agents to work alongside developers. Additionally, template admins can [pre-install extensions](https://registry.coder.com/modules/coder/vscode-web) for agents such as GitHub Copilot and Roo Code.
208

21-
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.
9+
These agents work well inside existing Coder workspaces as they can simply be enabled via an extension or are built-into the editor.
2210

23-
![AI Agents in Coder](../images/guides/ai-agents/landing.png)
11+
## Agents with Coder Tasks (Beta)
2412

25-
## Prerequisites
13+
In cases where the IDE is secondary, such as protyping or long-running background jobs, agents like Claude Code or Aider are better for the job and new SaaS interfaces like [Devin](https://devin.ai) and [ChatGPT Codex](https://openai.com/index/introducing-codex/) are emerging.
2614

27-
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.
15+
[Coder Tasks](./tasks.md) is a new interface inside Coder to run and manage coding agents with a chat-based UI. Unlike SaaS-based products, Coder Tasks is self-hosted (included in your Coder deployment) and allows you to run any terminal-based agent such as Claude Code or Codex's Open Source CLI.
2816

29-
- A [Coder deployment](../install/index.md) with v2.21.0 or later
30-
- A Coder [template](../admin/templates/index.md) for your project(s).
31-
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI)
32-
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents
33-
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents
17+
![Coder Tasks UI](../images/guides/ai-agents/tasks-ui.png)
3418

35-
## Table of Contents
36-
37-
<children></children>
19+
[Learn more about Coder Tasks](./tasks.md)

docs/ai-coder/index.old.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Use AI Coding Agents in Coder Workspaces
2+
3+
> [!NOTE]
4+
>
5+
> This functionality is in beta and is evolving rapidly.
6+
>
7+
> When using any AI tool for development, exercise a level of caution appropriate to your use case and environment.
8+
> Always review AI-generated content before using it in critical systems.
9+
>
10+
> Join our [Discord channel](https://discord.gg/coder) or
11+
> [contact us](https://coder.com/contact) to get help or share feedback.
12+
13+
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:
14+
15+
- Protyping web applications or landing pages
16+
- Researching / onboarding to a codebase
17+
- Assisting with lightweight refactors
18+
- Writing tests and draft documentation
19+
- Small, well-defined chores
20+
21+
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.
22+
23+
![AI Agents in Coder](../images/guides/ai-agents/landing.png)
24+
25+
## Prerequisites
26+
27+
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.
28+
29+
- A [Coder deployment](../install/index.md) with v2.21.0 or later
30+
- A Coder [template](../admin/templates/index.md) for your project(s).
31+
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI)
32+
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents
33+
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents
34+
35+
## Table of Contents
36+
37+
<children></children>

docs/ai-coder/mcp-servers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Docs on MCP Servers

docs/ai-coder/tasks.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Coder Tasks (Beta)
2+
3+
Coder Tasks is an interface for running & managing coding agents such as Claude Code and Aider.
4+
5+
![Tasks UI](../images/guides/ai-agents/tasks-ui.png)
6+
7+
Coder Tasks is best for cases where the IDE is secondary, such as prototyping or running long-running background jobs. However, tasks run inside full workspaces so developers can [connect via an IDE](../user-guides/workspace-access) to take a task to completion.
8+
9+
> [!NOTE]
10+
> Coder Tasks is free and open source. If you are a Coder Premium customer or want to run hundreds of tasks in the background, [contact us](https://coder.com/contact) for roadmap information and volume pricing.
11+
12+
## Supported Agents (and Models)
13+
14+
Any terminal-based agent that supports Model Context Protocol (MCP) can be integrated with Coder Tasks, including your own custom agents.
15+
16+
Out of the box, agents like Claude Code, Aider, Goose, and Amazon Q are supported with built-in modules that can be added to a template. [See all agent modules in the Registry](https://registry.coder.com/modules?search=tag%3Aagent)
17+
18+
Enterprise LLM Providers such as AWS Bedrock, GCP Vertex and proxies such as LiteLLM can be used as well in order to keep intellectual property private. Self-hosted models such as llama4 can also be configured with specific agents, such as Aider and Goose.
19+
20+
## Architecture
21+
22+
Each task runs inside its own Coder workspace for isolation purposes. Agents like Claude Code also run in the workspace, and can be pre-installed via a module in the Coder Template. Agents then communicate with your LLM provider, so no GPUs are directly required in your workspaces for inference.
23+
24+
<div class="tabs">
25+
26+
## High-Level
27+
28+
![High-Level Architecture](../images/guides/ai-agents/architecture-high-level.png)
29+
30+
## In-Depth
31+
32+
Coming soon!
33+
34+
</div>
35+
36+
Coder's [built-in modules for agents](https://registry.coder.com/modules?search=tag%3Aagent) will pre-install the agent alongside [AgentAPI](https://github.com/coder/agentapi), an open source project developed by Coder, is installed alongside the agent inside the workspace for improved status chat, status reporting & updates, regardless of which agent you use.
37+
38+
## Getting Started with Tasks
39+
40+
### Option 1&rpar; Import and Modify Our Example Template
41+
42+
Our example template is the best way to experiment with Tasks with a [real world demo app](https://github.com/gothinkster/realworld). The application is running in the background and you can experiment with coding agents.
43+
44+
![Tasks UI with realworld app](../images/guides/ai-agents/realworld-ui.png)
45+
46+
Try prompts such as:
47+
48+
- "rewrite the backend in go"
49+
- "document the project structure"
50+
- "change the primary color theme to purple"
51+
52+
To import the template and begin configuring it, follow the [documentation in the Coder Registry](https://comingsoon.com)
53+
54+
### Option 2&rpar; Create or Duplicate Your Own Template
55+
56+
Because Tasks run unpredictable AI agents, often for background tasks, we recommend creating a seperate template for Coder Tasks with limited permissions.
57+
58+
You can always duplicate your existing template, then apply seperate network policies/firewalls/permissions to the template. From there, follow the docs for one of our [built-in modules for agents](https://registry.coder.com/modules?search=tag%3Aagent) in order to add it to your template, configure your LLM provider.
59+
60+
Alternatively, follow our guide for [custom agents](./custom-agents.md)
61+
62+
## Next Steps
63+
64+
<children></children>

docs/ai-coder/use-cases.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Coming Soon
Loading
537 KB
Loading
1.05 MB
Loading

0 commit comments

Comments
 (0)