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

Skip to content

Commit a5fdcdd

Browse files
blink-so[bot]blink-so[bot]
committed
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.
1 parent 0d406fd commit a5fdcdd

File tree

1 file changed

+61
-36
lines changed

1 file changed

+61
-36
lines changed

‎docs/tutorials/quickstart.md

Lines changed: 61 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Get Started
22

3-
**Keywords:** install, setup, get started, quickstart, templates, workspaces, tasks, users
3+
**Keywords:** install, setup, get started, quickstart, templates, workspaces,
4+
tasks, users
45

5-
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!
6+
Follow the steps in this guide to get your first Coder development environment
7+
running in under 10 minutes. This guide covers the essential concepts and walks
8+
you through creating your first workspace and running VS Code from it. You can
9+
also get Claude Code up and running in the background!
610

711
## What You'll Build
812

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

1721
## Understanding Coder: 30-Second Overview
1822

19-
Before diving in, here are the four concepts that power Coder explained through a cooking analogy:
23+
Before diving in, here are the four concepts that power Coder explained through
24+
a cooking analogy:
2025

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

29-
**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.
34+
**First time here?** Coder separates how an environment is defined (Admin’s job)
35+
from where you do your day-to-day coding (Developer’s job). As a developer,
36+
you’ll use templates to launch workspaces, and as an admin, you’ll create and
37+
manage those templates for others.
3038

3139
## Prerequisites
3240

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

4856
For more details, visit:
49-
5057
- [Linux instructions](https://docs.docker.com/desktop/install/linux-install/)
5158
- [Mac instructions](https://docs.docker.com/desktop/install/mac-install/)
5259

@@ -77,7 +84,8 @@ is installed.
7784

7885
## Step 2: Install & Start Coder
7986

80-
The `coder` CLI is all you need to install. It let's you run both the Coder server as well as the client.
87+
The `coder` CLI is all you need to install. It let's you run both the Coder
88+
server as well as the client.
8189

8290
<div class="tabs">
8391

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

127-
- If you get a browser warning similar to `Secure Site Not Available`, you
128-
can ignore the warning and continue to the setup page.
135+
- If you get a browser warning similar to `Secure Site Not Available`, you can
136+
ignore the warning and continue to the setup page.
129137

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

136143
## Step 3: Initial Setup
137144

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

143-
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.
150+
You can also choose to **Continue with GitHub** instead of creating an admin
151+
account. The first user that signs in is automatically granted admin
152+
permissions.
144153

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

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

153162
2. **Choose a starter template:**
154163

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

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

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

170179
1. Click **"Save"**
171180

172-
**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.
181+
**What just happened?** You defined a template — a reusable blueprint for dev
182+
environments — in your Coder deployment. It's now stored in your organization's
183+
template list, where you and any teammates in the same org can create workspaces
184+
from it. Let's launch one.
173185

174186
## Step 5: Launch your Workspace
175187

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

185197
## Step 6: Connect your IDE
186198

187-
Select **VS Code Desktop** to install the Coder extension and connect to your Coder workspace.
199+
Select **VS Code Desktop** to install the Coder extension and connect to your
200+
Coder workspace.
188201

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

220233
### What's Next?
221234

222-
Now that you have your own workspace running, you can start exploring more advanced capabilities that Coder offers.
235+
Now that you have your own workspace running, you can start exploring more
236+
advanced capabilities that Coder offers.
223237

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

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

230244
### Get Coder Tasks Running
231245

232-
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.
246+
Coder Tasks is an interface that allows you to run and manage coding agents like
247+
Claude Code. Tasks become available when a template has the `coder_ai_task`
248+
resource and `coder_parameter` named `AI Prompt` defined in its source code.
249+
Subsequently, any existing template can become a Task template by adding in that
250+
resource and parameter.
233251

234-
Let's try turning the **Docker Containers** template into a Task template running Claude Code:
252+
Let's try turning the **Docker Containers** template into a Task template
253+
running Claude Code:
235254

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

240260
```hcl
241261
# Claude API Key variable (filled in during template build)
@@ -267,19 +287,24 @@ resource "coder_app" "claude-code" {
267287
# Claude AI task
268288
resource "coder_ai_task" "claude-code" {
269289
count = data.coder_parameter.ai_prompt.value != "" ? 1 : 0
270-
290+
271291
sidebar_app {
272292
id = coder_app.claude-code.id
273293
}
274294
}
275295
276296
```
277297

278-
1. **Build the Template**: Click "Build version". This will process your template updates. After it finishes building successfully:
279-
1. **Activate the Template**: Click "Promote Version" on the new version to make it the active template version.
298+
1. **Build the Template**: Click "Build version". This will process your
299+
template updates. After it finishes building successfully:
300+
1. **Activate the Template**: Click "Promote Version" on the new version to make
301+
it the active template version.
280302
1. **Create a Task**: Click "Create Task".
281-
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
282-
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!
303+
1. Once your workspace is running, navigate to the **Tasks** tab in the upper
304+
left hand corner. Type in a message or coding request like "Help me write a
305+
HelloWorld application in Python". Click **Run Task** to start the task
306+
1. The task will open VS Code with Claude Code running in the left sidebar. You
307+
are now successfully using Coder Tasks with Claude Code!
283308

284309
## Troubleshooting
285310

0 commit comments

Comments
 (0)