-
Notifications
You must be signed in to change notification settings - Fork 1k
docs: update Get Started Page to Include Tasks #19752
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
c2a8591
Update quickstart docker and coder install steps
david-fraley cde865d
rest of quickstart
david-fraley a69b0fb
start of tasks docs
david-fraley 3ff6dac
continued work on tasks
david-fraley a99a6e5
Updated tasks quickstart section
david-fraley b74cef8
docs: fix markdown formatting issues in quickstart.md
blink-so[bot] 5d943d7
add back whats next
david-fraley 0d406fd
docs: fix typos and formatting in quickstart.md
blink-so[bot] a5fdcdd
docs: format quickstart.md with prettier
blink-so[bot] e3ec375
docs: format markdown tables in quickstart.md
blink-so[bot] c349ac0
Update tasks how-to
david-fraley 0e1984d
add pic, remove keywords
david-fraley a211e2a
add note about docker running in background
david-fraley 62ef23a
added picture for changing directories
david-fraley 4e4d27e
revert title change. it'll come later
david-fraley a0502e6
Merge branch 'main' into david-fraley/update-quickstart
david-fraley 91cb305
minor nit
david-fraley 8dc67ae
updated concepts section
david-fraley 4ef89f0
format
david-fraley 302079d
more format
david-fraley 5ef4945
Fix typo
david-fraley 018f7db
more formats
david-fraley 9bc326e
docs: fix trailing whitespace in quickstart.md
blink-so[bot] dbe130a
docs: add missing newline at end of quickstart.md
blink-so[bot] 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
continued work on tasks
- Loading branch information
commit 3ff6daceb36ad6b59605c200f3c848edb198cf91
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 |
---|---|---|
|
@@ -139,7 +139,7 @@ it. | |
- Email: `[email protected]` | ||
- Password: Choose a strong password | ||
|
||
You can also choose to **Continue with GitHub** instead of creating an admin account | ||
You can also choose to **Continue with GitHub** instead of creating an admin account. The first user that signs in is automatically granted admin permissions. | ||
|
||
 | ||
|
||
|
@@ -217,35 +217,52 @@ You now have: | |
|
||
### Get Coder Tasks Running | ||
|
||
tbd @david | ||
Coder Tasks is an interface that allows you to run and manage coding agents like Claude Code. Tasks become avaialable when a template has the `coder_ai_task` resource and `coder_parameter` named `AI Prompt` defined in its source code. Subsequently, any existing template can become a Task template by adding in that resource and parameter. | ||
|
||
Coder Tasks is an interface that allows you to run and manage code agents like Claude Code. We define a task by modifying an existing template, and adding a `coder_ai_task` resource and `coder_parameter` named `AI Prompt`. In doing this, you can make any template a Task template by adding in that resource and parameter. | ||
|
||
Let's try turning the existing **Docker Containers** template into a Task template: | ||
Let's try turning the **Docker Containers** template into a Task template running Claude Code: | ||
1. Head to **Templates** | ||
2. by adding in the following at the botton modifying the template | ||
|
||
1. Click into the template, and then click **Source Code** -> **Edit** | ||
david-fraley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
1. Add the following code snippit to the bottom of the terraform. This defines the `coder_ai_task` resource and `coder_parameter` | ||
``` | ||
# Claude API Key parameter | ||
data "coder_parameter" "claude_api_key" { | ||
name = "claude_api_key" | ||
display_name = "Claude API Key" | ||
description = "Your Anthropic API key for Claude AI" | ||
type = "string" | ||
default = "" | ||
} | ||
|
||
# AI Prompt parameter (must be named exactly 'AI Prompt') | ||
data "coder_parameter" "ai_prompt" { | ||
name = "AI Prompt" | ||
type = "string" | ||
name = "AI Prompt" | ||
display_name = "AI Prompt" | ||
description = "Optional AI prompt to customize behavior" | ||
type = "string" | ||
default = "" | ||
} | ||
|
||
# Multiple coder_ai_tasks can be defined in a template | ||
resource "coder_ai_task" "claude-code" { | ||
# At most one coder ai task can be instantiated during a workspace build. | ||
# Coder fails the build if it would instantiate more than 1. | ||
count = data.coder_parameter.ai_prompt.value != "" ? 1 : 0 | ||
|
||
sidebar_app { | ||
# which app to display in the sidebar on the task page | ||
id = coder_app.claude-code.id | ||
} | ||
# Claude app | ||
resource "coder_app" "claude-code" { | ||
agent_id = coder_agent.main.id | ||
slug = "claude" | ||
display_name = "Claude" | ||
url = "https://claude.ai" | ||
icon = "https://claude.ai/favicon.ico" | ||
external = true | ||
} | ||
``` | ||
|
||
# Claude AI task | ||
resource "coder_ai_task" "claude-code" { | ||
count = data.coder_parameter.ai_prompt.value != "" ? 1 : 0 | ||
|
||
sidebar_app { | ||
id = coder_app.claude-code.id | ||
} | ||
} | ||
|
||
1. | ||
``` | ||
1. | ||
|
||
## Troubleshooting | ||
|
||
|
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.