-
Notifications
You must be signed in to change notification settings - Fork 929
feat: draft tasks docs #18659
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
bpmct
wants to merge
4
commits into
main
Choose a base branch
from
tasks-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+248
−109
Draft
feat: draft tasks docs #18659
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Coming soon |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Document coming soon on how to pre-install IDE agents, configure your LLM provider, etc. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,19 @@ | ||
# Use AI Coding Agents in Coder Workspaces | ||
# Run AI Coding Agents in Coder | ||
|
||
> [!NOTE] | ||
> | ||
> This functionality is in beta and is evolving rapidly. | ||
> | ||
> When using any AI tool for development, exercise a level of caution appropriate to your use case and environment. | ||
> Always review AI-generated content before using it in critical systems. | ||
> | ||
> Join our [Discord channel](https://discord.gg/coder) or | ||
> [contact us](https://coder.com/contact) to get help or share feedback. | ||
Learn how to run & manage coding agents with Coder, both alongside existing workspaces and for background task execution. | ||
|
||
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: | ||
## Agents in the IDE | ||
|
||
- Protyping web applications or landing pages | ||
- Researching / onboarding to a codebase | ||
- Assisting with lightweight refactors | ||
- Writing tests and draft documentation | ||
- Small, well-defined chores | ||
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. | ||
|
||
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. | ||
These agents work well inside existing Coder workspaces as they can simply be enabled via an extension or are built-into the editor. | ||
|
||
 | ||
## Agents with Coder Tasks (Beta) | ||
|
||
## Prerequisites | ||
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. | ||
|
||
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. | ||
[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. | ||
|
||
- A [Coder deployment](../install/index.md) with v2.21.0 or later | ||
- A Coder [template](../admin/templates/index.md) for your project(s). | ||
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI) | ||
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents | ||
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents | ||
 | ||
|
||
## Table of Contents | ||
|
||
<children></children> | ||
[Learn more about Coder Tasks](./tasks.md) to how to get started and best practices. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Use AI Coding Agents in Coder Workspaces | ||
|
||
> [!NOTE] | ||
> | ||
> This functionality is in beta and is evolving rapidly. | ||
> | ||
> When using any AI tool for development, exercise a level of caution appropriate to your use case and environment. | ||
> Always review AI-generated content before using it in critical systems. | ||
> | ||
> Join our [Discord channel](https://discord.gg/coder) or | ||
> [contact us](https://coder.com/contact) to get help or share feedback. | ||
|
||
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: | ||
|
||
- Protyping web applications or landing pages | ||
- Researching / onboarding to a codebase | ||
- Assisting with lightweight refactors | ||
- Writing tests and draft documentation | ||
- Small, well-defined chores | ||
|
||
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. | ||
|
||
 | ||
|
||
## Prerequisites | ||
|
||
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. | ||
|
||
- A [Coder deployment](../install/index.md) with v2.21.0 or later | ||
- A Coder [template](../admin/templates/index.md) for your project(s). | ||
- Access to at least one ML model (e.g. Anthropic Claude, Google Gemini, OpenAI) | ||
- Cloud Model Providers (AWS Bedrock, GCP Vertex AI, Azure OpenAI) are supported with some agents | ||
- Self-hosted models (e.g. llama3) and AI proxies (OpenRouter) are supported with some agents | ||
|
||
## Table of Contents | ||
|
||
<children></children> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Docs on MCP Servers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Coder Tasks (Beta) | ||
|
||
Coder Tasks is an interface for running & managing coding agents such as Claude Code and Aider, powered by Coder workspaces. | ||
|
||
 | ||
|
||
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. | ||
|
||
> [!NOTE] | ||
> 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. | ||
|
||
## Supported Agents (and Models) | ||
|
||
Any terminal-based agent that supports Model Context Protocol (MCP) can be integrated with Coder Tasks, including your own custom agents. | ||
|
||
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) | ||
|
||
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. | ||
|
||
## Architecture | ||
|
||
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. | ||
|
||
<div class="tabs"> | ||
|
||
## High-Level | ||
|
||
 | ||
|
||
## In-Depth | ||
|
||
Coming soon! | ||
|
||
</div> | ||
|
||
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). AgentAPI is an open source project developed by Coder which improves status reporting and the Chat UI, regardless of which agent you use. | ||
|
||
## Getting Started with Tasks | ||
|
||
### Option 1) Import and Modify Our Example Template | ||
|
||
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. | ||
|
||
 | ||
|
||
Try prompts such as: | ||
|
||
- "rewrite the backend in go" | ||
- "document the project structure" | ||
- "change the primary color theme to purple" | ||
|
||
To import the template and begin configuring it, follow the [documentation in the Coder Registry](https://comingsoon.com) | ||
|
||
### Option 2) Create or Duplicate Your Own Template | ||
|
||
Because Tasks run unpredictable AI agents, often for background tasks, we recommend creating a seperate template for Coder Tasks with limited permissions. | ||
|
||
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. | ||
|
||
Alternatively, follow our guide for [custom agents](./custom-agents.md) | ||
|
||
## Next Steps | ||
|
||
<children></children> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Coming Soon |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://comingsoon.com Status: null Navigation timeout of 30000 ms exceeded