You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**You**| The engineer/developer/builder working | The head chef cooking the meal |
26
+
|**Templates**| A Terraform blueprint that defines your dev environment (OS, tools, resources) | Recipe for a meal |
27
+
|**Workspaces**| The actual running environment created from the template | The cooked meal |
28
+
|**Tasks**| AI-powered coding agents that run inside a workspace | Smart kitchen appliance that help you cook |
29
+
|**Users**| A developer who launches the workspace from a template and does their work inside it | The people eating the meal |
30
+
31
+
**Putting it Together:** Coder separates who _defines_ environments from who _uses_ them. Admins create and manage Templates, the recipes, while developers use those Templates to launch Workspaces, the meals. Inside those Workspaces, developers can also run Tasks, the smart kitchen appliance, to help speed up day-to-day work.
32
+
33
+
## Prerequisites
34
+
35
+
- A machine with 2+ CPU cores and 4GB+ RAM
36
+
- 10 minutes of your time
37
+
38
+
## Step 1: Install Docker and Setup Permissions
11
39
12
40
<divclass="tabs">
13
41
14
-
## Linux/macOS
42
+
###Linux/macOS
15
43
16
44
1. Install Docker:
17
45
@@ -20,7 +48,6 @@ persistent environment from your main device, a tablet, or your phone.
|**Docker Containers** (Recommended) | Getting started quickly, local development, prototyping | Ubuntu container with common dev tools, Docker runtime |
|**AWS EC2 (Linux)**| Teams needing full VMs, AWS-native infrastructure | Full EC2 instances with AWS integration |
106
162
107
-
1. For this guide, use a Docker container. Locate **Docker Containers** and
108
-
select **Use template**.
163
+
3. Click **"Use template"** on **Docker Containers**. Note: running this template requires Docker to be running in the background, so make sure Docker is running!
109
164
110
-
1. Give the template a **Name** that you'll recognize both in the Coder UI and
111
-
in command-line calls.
165
+
4.**Name your template:**
166
+
- Name: `quickstart`
167
+
- Display name: `quickstart doc template`
168
+
- Description: `Provision Docker containers as Coder workspaces`
112
169
113
-
The rest of the template details are optional, but will be helpful when you
**What just happened?** You defined a template — a reusable blueprint for dev
175
+
environments — in your Coder deployment. It's now stored in your organization's
176
+
template list, where you and any teammates in the same org can create workspaces
177
+
from it. Let's launch one.
178
+
179
+
## Step 5: Launch your Workspace
120
180
121
181
1. After the template is ready, select **Create Workspace**.
122
182
@@ -127,14 +187,16 @@ is installed.
127
187
_Workspace
128
188
is running_
129
189
130
-
1. Select **VS Code Desktop** to install the Coder extension and connect to your
131
-
Coder workspace.
190
+
## Step 6: Connect your IDE
132
191
133
-
## Work on some code
192
+
Select **VS Code Desktop** to install the Coder extension and connect to your
193
+
Coder workspace.
134
194
135
195
After VS Code loads the remote environment, you can select **Open Folder** to
136
196
explore directories in the Docker container or work on something new.
137
197
198
+

199
+
138
200
To clone an existing repository:
139
201
140
202
1. Select **Clone Repository** and enter the repository URL.
@@ -154,19 +216,71 @@ To clone an existing repository:
154
216
155
217
1. You are now using VS Code in your Coder environment!
156
218
157
-
## What's next?
219
+
## Success! You're Coding in Coder
220
+
221
+
You now have:
222
+
223
+
-**Coder server** running locally
224
+
-**A template** defining your environment
225
+
-**A workspace** running that environment
226
+
-**IDE access** to code remotely
227
+
228
+
### What's Next?
229
+
230
+
Now that you have your own workspace running, you can start exploring more
231
+
advanced capabilities that Coder offers.
158
232
159
-
Now that you have your own workspace, use the same template to set one up for a
160
-
teammate.
233
+
-[Learn more about running Coder Tasks and our recommended Best Practices](https://coder.com/docs/ai-coder/best-practices)
161
234
162
-
Go to **Templates** and select **Create Workspace** and continue from Step 7 in
163
-
[Configure Coder with a new workspace](#configure-coder-with-a-new-workspace).
235
+
-[Read about managing Workspaces for your team](https://coder.com/docs/user-guides/workspace-management)
164
236
165
-
After that, you can try to:
237
+
-[Read about implementing monitoring tools for your Coder Deployment](https://coder.com/docs/admin/monitoring)
238
+
239
+
### Get Coder Tasks Running
240
+
241
+
Coder Tasks is an interface that allows you to run and manage coding agents like
242
+
Claude Code within a given Workspace. Tasks become available when the Template for a Workspace has the `coder_ai_task` resource and `coder_parameter` named `AI Prompt` defined in its source code.
243
+
In other words, any existing template can become a Task template by adding in that
244
+
resource and parameter.
245
+
246
+
Coder maintains the [Tasks on Docker](https://registry.coder.com/templates/coder-labs/tasks-docker?_gl=1*19yewmn*_gcl_au*MTc0MzUwMTQ2NC4xNzU2MzA3MDkxLjk3NTM3MjgyNy4xNzU3Njg2NDY2LjE3NTc2ODc0Mzc.*_ga*NzUxMDI1NjIxLjE3NTYzMDcwOTE.*_ga_FTQQJCDWDM*czE3NTc3MDg4MDkkbzQ1JGcxJHQxNzU3NzA4ODE4JGo1MSRsMCRoMA..) template which has Anthropic's Claude Code agent built in with a sample application. Let's try using this template by pulling it from Coder's Registry of public templates, and pushing it to your local server:
247
+
248
+
1. In the upper right hand corner, click **Use this template**
249
+
1. Open a terminal on your machine
250
+
1. Ensure your CLI is authenticated with your Coder deployment by [logging in](https://coder.com/docs/reference/cli/login)
251
+
1. Create an [API Key with Anthropic](https://console.anthropic.com/)
252
+
1. Head to the [Tasks on Docker](https://registry.coder.com/templates/coder-labs/tasks-docker?_gl=1*19yewmn*_gcl_au*MTc0MzUwMTQ2NC4xNzU2MzA3MDkxLjk3NTM3MjgyNy4xNzU3Njg2NDY2LjE3NTc2ODc0Mzc.*_ga*NzUxMDI1NjIxLjE3NTYzMDcwOTE.*_ga_FTQQJCDWDM*czE3NTc3MDg4MDkkbzQ1JGcxJHQxNzU3NzA4ODE4JGo1MSRsMCRoMA..) template
253
+
1. Clone the Coder Registry repo to your local machine
254
+
255
+
```hcl
256
+
git clone https://github.com/coder/registry.git
257
+
```
258
+
259
+
1. Switch to the template directory
260
+
261
+
```hcl
262
+
cd registry/registry/coder-labs/templates/tasks-docker
263
+
```
264
+
265
+
1. Push the template to your Coder deployment. Note: this command differs from the registry since we're defining the Anthropic API Key as an environment variable
-[Deploy to Google Cloud Platform (GCP)](../install/cloud/compute-engine.md)
271
+
1.**Create the new Workspace**
272
+
1. In your Coder Deployment, click **Workspaces** in the upper left hand corner
273
+
1. Click **New workspace** and choose **tasks-docker**
274
+
1. Fill in the Workspace name. Add in an AI Prompt for Claude Code like "Make the background yellow". Click **Create workspace**
275
+
1.**See Tasks in action**
276
+
1. Once your workspace is running, click **View tasks** with your workspace. This will bring you to the Tasks view where you can see Claude Code (left panel), preview the sample application, and interact with the code in code-server. You might need to wait for Claude Code to finish changing the background color of the application.
277
+

278
+
1. Navigate to the **Tasks** tab in the upper left hand corner
279
+
1. Try typing in a new request to Claude Code: "make the background red"
280
+
1. Let's exit out of this specific Task view, so we can see all the running tasks
281
+
1. You can start a new task by prompting in the "Prompt your AI agent to start a task" box. You can select which template to run this from, so tasks-docker here, and that will spin up a new Workspace
282
+
283
+
Congratulation! You now have a Coder Task running. This demo has shown you how to spin up a task, and prompt Claude Code to change parts of your application. Learn more specifics about Coder Tasks [here](https://coder.com/docs/ai-coder/tasks).
0 commit comments