Thanks to visit codestin.com
Credit goes to github.com

Skip to content
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 Sep 9, 2025
cde865d
rest of quickstart
david-fraley Sep 9, 2025
a69b0fb
start of tasks docs
david-fraley Sep 9, 2025
3ff6dac
continued work on tasks
david-fraley Sep 10, 2025
a99a6e5
Updated tasks quickstart section
david-fraley Sep 10, 2025
b74cef8
docs: fix markdown formatting issues in quickstart.md
blink-so[bot] Sep 10, 2025
5d943d7
add back whats next
david-fraley Sep 10, 2025
0d406fd
docs: fix typos and formatting in quickstart.md
blink-so[bot] Sep 10, 2025
a5fdcdd
docs: format quickstart.md with prettier
blink-so[bot] Sep 10, 2025
e3ec375
docs: format markdown tables in quickstart.md
blink-so[bot] Sep 10, 2025
c349ac0
Update tasks how-to
david-fraley Sep 12, 2025
0e1984d
add pic, remove keywords
david-fraley Sep 12, 2025
a211e2a
add note about docker running in background
david-fraley Sep 12, 2025
62ef23a
added picture for changing directories
david-fraley Sep 12, 2025
4e4d27e
revert title change. it'll come later
david-fraley Sep 12, 2025
a0502e6
Merge branch 'main' into david-fraley/update-quickstart
david-fraley Sep 12, 2025
91cb305
minor nit
david-fraley Sep 12, 2025
8dc67ae
updated concepts section
david-fraley Sep 12, 2025
4ef89f0
format
david-fraley Sep 12, 2025
302079d
more format
david-fraley Sep 12, 2025
5ef4945
Fix typo
david-fraley Sep 12, 2025
018f7db
more formats
david-fraley Sep 12, 2025
9bc326e
docs: fix trailing whitespace in quickstart.md
blink-so[bot] Sep 12, 2025
dbe130a
docs: add missing newline at end of quickstart.md
blink-so[bot] Sep 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: format quickstart.md with prettier
- Align table columns for better readability
- Fix line wrapping for better markdown formatting

These changes resolve the fmt CI check failure.
  • Loading branch information
blink-so[bot] committed Sep 10, 2025
commit a5fdcdd42bb086a627d5244a80fbb479c8c4ee47
97 changes: 61 additions & 36 deletions docs/tutorials/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Get Started

**Keywords:** install, setup, get started, quickstart, templates, workspaces, tasks, users
**Keywords:** install, setup, get started, quickstart, templates, workspaces,
tasks, users

Follow the steps in this guide to get your first Coder development environment running in under 10 minutes. This guide covers the essential concepts and walks you through creating your first workspace and running VS Code from it. You can also get Claude Code up and running in the background!
Follow the steps in this guide to get your first Coder development environment
running in under 10 minutes. This guide covers the essential concepts and walks
you through creating your first workspace and running VS Code from it. You can
also get Claude Code up and running in the background!

## What You'll Build

Expand All @@ -16,17 +20,21 @@ In this quickstart, you'll:

## Understanding Coder: 30-Second Overview

Before diving in, here are the four concepts that power Coder explained through a cooking analogy:
Before diving in, here are the four concepts that power Coder explained through
a cooking analogy:

| Component | What It Is | Real-World Analogy |
|-----------|------------|-------------------|
| **You** | The engineer/developer/builder working | The head chef cooking the meal |
| **Templates** | A Terraform blueprint that defines your dev environment (OS, tools, resources) | Recipe for a meal |
| **Workspaces** | The actual running environment created from the template | The cooked meal |
| **Tasks** | AI-powered coding agents that run inside a workspace | Your sous chef helping you cook the meal |
| **Users** | A developer who launches the workspace from a template and does their work inside it | The people eating the meal |
| Component | What It Is | Real-World Analogy |
| -------------- | ------------------------------------------------------------------------------------ | ---------------------------------------- |
| **You** | The engineer/developer/builder working | The head chef cooking the meal |
| **Templates** | A Terraform blueprint that defines your dev environment (OS, tools, resources) | Recipe for a meal |
| **Workspaces** | The actual running environment created from the template | The cooked meal |
| **Tasks** | AI-powered coding agents that run inside a workspace | Your sous chef helping you cook the meal |
| **Users** | A developer who launches the workspace from a template and does their work inside it | The people eating the meal |

**First time here?** Coder separates how an environment is defined (Admin’s job) from where you do your day-to-day coding (Developer’s job). As a developer, you’ll use templates to launch workspaces, and as an admin, you’ll create and manage those templates for others.
**First time here?** Coder separates how an environment is defined (Admin’s job)
from where you do your day-to-day coding (Developer’s job). As a developer,
you’ll use templates to launch workspaces, and as an admin, you’ll create and
manage those templates for others.

## Prerequisites

Expand All @@ -46,7 +54,6 @@ Before diving in, here are the four concepts that power Coder explained through
```

For more details, visit:

- [Linux instructions](https://docs.docker.com/desktop/install/linux-install/)
- [Mac instructions](https://docs.docker.com/desktop/install/mac-install/)

Expand Down Expand Up @@ -77,7 +84,8 @@ is installed.

## Step 2: Install & Start Coder

The `coder` CLI is all you need to install. It let's you run both the Coder server as well as the client.
The `coder` CLI is all you need to install. It let's you run both the Coder
server as well as the client.

<div class="tabs">

Expand Down Expand Up @@ -124,14 +132,13 @@ is installed.
Coder will attempt to open the setup page in your browser. If it doesn't open
automatically, go to <http://localhost:3000>.

- If you get a browser warning similar to `Secure Site Not Available`, you
can ignore the warning and continue to the setup page.
- If you get a browser warning similar to `Secure Site Not Available`, you can
ignore the warning and continue to the setup page.

If your Coder server is on a network or cloud device, or you are having
trouble viewing the page, locate the web UI URL in Coder logs in your
terminal. It looks like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`.
It's one of the first lines of output, so you might have to scroll up to find
it.
If your Coder server is on a network or cloud device, or you are having trouble
viewing the page, locate the web UI URL in Coder logs in your terminal. It looks
like `https://<CUSTOM-STRING>.<TUNNEL>.try.coder.app`. It's one of the first
lines of output, so you might have to scroll up to find it.

## Step 3: Initial Setup

Expand All @@ -140,7 +147,9 @@ it.
- Email: `[email protected]`
- Password: Choose a strong password

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.
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.

![Welcome to Coder - Create admin user](../images/screenshots/welcome-create-admin-user.png)

Expand All @@ -152,11 +161,11 @@ Templates define what's in your development environment. Let's start simple:

2. **Choose a starter template:**

| Starter | Best For | Includes |
|---------|----------|----------|
| Starter | Best For | Includes |
| ----------------------------------- | ------------------------------------------------------- | ------------------------------------------------------ |
| **Docker Containers** (Recommended) | Getting started quickly, local development, prototyping | Ubuntu container with common dev tools, Docker runtime |
| **Kubernetes (Deployment)** | Cloud-native teams, scalable workspaces | Pod-based workspaces, Kubernetes orchestration |
| **AWS EC2 (Linux)** | Teams needing full VMs, AWS-native infrastructure | Full EC2 instances with AWS integration |
| **Kubernetes (Deployment)** | Cloud-native teams, scalable workspaces | Pod-based workspaces, Kubernetes orchestration |
| **AWS EC2 (Linux)** | Teams needing full VMs, AWS-native infrastructure | Full EC2 instances with AWS integration |

3. Click **"Use template"** on **Docker Containers**

Expand All @@ -169,7 +178,10 @@ Templates define what's in your development environment. Let's start simple:

1. Click **"Save"**

**What just happened?** You defined a template — a reusable blueprint for dev environments — in your Coder deployment. It's now stored in your organization's template list, where you and any teammates in the same org can create workspaces from it. Let's launch one.
**What just happened?** You defined a template — a reusable blueprint for dev
environments — in your Coder deployment. It's now stored in your organization's
template list, where you and any teammates in the same org can create workspaces
from it. Let's launch one.

## Step 5: Launch your Workspace

Expand All @@ -184,7 +196,8 @@ Templates define what's in your development environment. Let's start simple:

## Step 6: Connect your IDE

Select **VS Code Desktop** to install the Coder extension and connect to your Coder workspace.
Select **VS Code Desktop** to install the Coder extension and connect to your
Coder workspace.

After VS Code loads the remote environment, you can select **Open Folder** to
explore directories in the Docker container or work on something new.
Expand Down Expand Up @@ -219,7 +232,8 @@ You now have:

### What's Next?

Now that you have your own workspace running, you can start exploring more advanced capabilities that Coder offers.
Now that you have your own workspace running, you can start exploring more
advanced capabilities that Coder offers.

- [Learn more about running Coder Tasks and our recommended Best Practices](https://coder.com/docs/ai-coder/best-practices)

Expand All @@ -229,13 +243,19 @@ Now that you have your own workspace running, you can start exploring more advan

### Get Coder Tasks Running

Coder Tasks is an interface that allows you to run and manage coding agents like Claude Code. Tasks become available 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 coding agents like
Claude Code. Tasks become available 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.

Let's try turning the **Docker Containers** template into a Task template running Claude Code:
Let's try turning the **Docker Containers** template into a Task template
running Claude Code:

1. Head to **Templates**
1. Click into the template, and then click **Source Code** -> **Edit**
1. Add the following code snippit to the bottom of the terraform. This defines the `coder_ai_task` resource and `coder_parameter`
1. Add the following code snippit to the bottom of the terraform. This defines
the `coder_ai_task` resource and `coder_parameter`

```hcl
# Claude API Key variable (filled in during template build)
Expand Down Expand Up @@ -267,19 +287,24 @@ resource "coder_app" "claude-code" {
# 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. **Build the Template**: Click "Build version". This will process your template updates. After it finishes building successfully:
1. **Activate the Template**: Click "Promote Version" on the new version to make it the active template version.
1. **Build the Template**: Click "Build version". This will process your
template updates. After it finishes building successfully:
1. **Activate the Template**: Click "Promote Version" on the new version to make
it the active template version.
1. **Create a Task**: Click "Create Task".
1. Once your workspace is running, navigate to the **Tasks** tab in the upper left hand corner. Type in a message or coding request like "Help me write a HelloWorld application in Python". Click **Run Task** to start the task
1. The task will open VS Code with Claude Code running in the left sidebar. You are now successfully using Coder Tasks with Claude Code!
1. Once your workspace is running, navigate to the **Tasks** tab in the upper
left hand corner. Type in a message or coding request like "Help me write a
HelloWorld application in Python". Click **Run Task** to start the task
1. The task will open VS Code with Claude Code running in the left sidebar. You
are now successfully using Coder Tasks with Claude Code!

## Troubleshooting

Expand Down
Loading