-
Notifications
You must be signed in to change notification settings - Fork 1k
docs: update Coder tasks doc to include Identity and Permission instructions #19710
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
matifali
wants to merge
5
commits into
main
Choose a base branch
from
atif/coder-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.
Draft
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
64fb886
Update AI tasks doc to include new coding agents
matifali 5435fd8
Update GITHUB_TOKEN assignment to use variable
matifali d1af71f
Apply suggestions from code review
matifali 4d5211e
Merge branch 'main' into atif/coder-tasks-docs
matifali f935d8b
Fix and align indentation in documentation examples
matifali 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
Next
Next commit
Update AI tasks doc to include new coding agents
Add Codex, Gemini, and enhanced enterprise LLM provider instructions to the Coder Tasks documentation. This includes updates on supported agents, integration configuration, and architecture details to support a broadened range of task management capabilities.
- Loading branch information
commit 64fb886234c3c739b11fb9b153d552f6354c5251
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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# 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 an interface for running & managing coding agents such as Claude Code, Codex, Gemini, and Aider, powered by Coder workspaces. | ||
|
||
 | ||
|
||
|
@@ -9,21 +9,25 @@ Coder Tasks is best for cases where the IDE is secondary, such as prototyping or | |
> [!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) | ||
## Supported Agents | ||
|
||
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 and Goose are supported with built-in modules that can be added to a template. [See all modules compatible with Tasks in the Registry](https://registry.coder.com/modules?search=tag%3Atasks). | ||
Out of the box, agents like Claude Code, Codex, Gemini, and Aider are supported with custom-built modules that can be added to a template to convert them into Coder Tasks. [See all modules compatible with Tasks in the Registry](https://registry.coder.com/modules?search=tag%3Atasks). | ||
|
||
## Enterprise LLM Providers and Proxies | ||
|
||
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. | ||
|
||
Configuration is Agent specific and further instructions can be found in the [Registry](https://registry.coder.com/modules?search=tag%3Atasks) for each of the supported agents. | ||
|
||
## 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. | ||
Each task runs inside its own Coder workspace for isolation purposes. Agents like Claude Code, Codex, and Aider 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. | ||
|
||
 | ||
|
||
Coder's [built-in modules for agents](https://registry.coder.com/modules?search=tag%3Atasks) 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. | ||
Coder's [custom-built modules for agents](https://registry.coder.com/modules?search=tag%3Atasks) 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 | ||
|
||
|
@@ -44,7 +48,15 @@ To import the template and begin configuring it, follow the [documentation in th | |
> [!NOTE] | ||
> The Tasks tab will appear automatically after you add a Tasks-compatible template and refresh the page. | ||
|
||
### Option 2) Create or Duplicate Your Own Template | ||
### Option 2) Use Any of Our Tasks Modules | ||
|
||
We have a growing collection of agent modules that enable Coder Tasks in any existing Coder template. To start, | ||
|
||
1. Find your favourite agent with Tasks support in Coder Regitsry | ||
1. Follow the instcrtion to edit your template and drop the agent module | ||
1. Refresh your browser to see Coder Tasks show up. | ||
|
||
### Option 3) Create or Duplicate Your Own Template | ||
|
||
A template becomes a Task template if it defines a `coder_ai_task` resource and a `coder_parameter` named `"AI Prompt"`. Coder analyzes template files during template version import to determine if these requirements are met. | ||
|
||
|
@@ -74,6 +86,39 @@ Because Tasks run unpredictable AI agents, often for background tasks, we recomm | |
|
||
Alternatively, follow our guide for [custom agents](./custom-agents.md). | ||
|
||
## Agent Identity and permissions | ||
|
||
Some users may wish to or are requiredto run agents with their own identity and permissions. | ||
|
||
### Git Identity | ||
|
||
You can make use of `.gitconfig` to configure the identity of the agent. For example, you can configure the author and committer identities separately. | ||
|
||
```tf | ||
resource "coder_agent" "main" { | ||
... | ||
env = { | ||
GIT_AUTHOR_NAME = "AI Bot" | ||
GIT_AUTHOR_EMAIL = "[email protected]" | ||
GIT_COMMITTER_NAME = "Jane Doe" | ||
GIT_COMMITTER_EMAIL = "[email protected]" | ||
} | ||
} | ||
``` | ||
|
||
### Permissions | ||
|
||
You have two options here to either choose the developer orchestrating the agent's permissions as you are already doing with [External Auth](https://coder.com/docs/admin/external-auth) or inject a Bot specific PAT if the tasks are started by a [headless system user](https://coder.com/docs/admin/users/headless-auth) as shown below: | ||
|
||
```tf | ||
resource "coder_agent" "main" { | ||
... | ||
env = { | ||
GITHUB_TOKEN = "ghp_1234567890abcdef" # Inject a Bot specific PAT | ||
matifali marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
``` | ||
|
||
## Customizing the Task UI | ||
|
||
The Task UI displays all workspace apps declared in a Task template. You can customize the app shown in the sidebar using the `sidebar_app.id` field on the `coder_ai_task` resource. | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.