Skip to content

Commit e495996

Browse files
committed
docs: update README, CONTRIBUTING, and CLAUDE.md
Rewrite README to reflect current features (Tasks, Chat, multi-deployment, dev containers, keyring, OAuth, SSH tuning). Update CONTRIBUTING sidebar description. Add testing guidelines to CLAUDE.md. Deduplicate vite in lockfile.
1 parent 0467501 commit e495996

File tree

6 files changed

+226
-204
lines changed

6 files changed

+226
-204
lines changed

CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Comments explain what code does or why it exists:
2525
## Testing and Debugging
2626

2727
- Tests must comprehensively cover functionality
28+
- Test observable behavior and outputs, not implementation details - assert on
29+
return values rather than spying on internal calls
30+
- Keep tests idiomatic and concise - descriptive names, minimal setup, no
31+
shared mutable state between tests
2832
- Never mock behavior in end-to-end tests - use real data
2933
- Mock as little as possible in unit tests - try to use real data
3034
- Find root causes, not symptoms. Read error messages carefully before attempting fixes.

CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,17 @@ file to display network information.
6060

6161
## Other features
6262

63-
There is a sidebar that shows all the user's workspaces, and all users'
64-
workspaces if the user has the required permissions.
63+
The extension provides several sidebar panels:
6564

66-
There are also notifications for an outdated workspace and for workspaces that
67-
are close to shutting down.
65+
- **My Workspaces / All Workspaces** - tree views showing workspaces with status
66+
indicators, quick actions, and search.
67+
- **Coder Tasks** - a React webview for creating, monitoring, and managing AI
68+
agent tasks with real-time log streaming.
69+
- **Coder Chat** - an embedded chat UI for delegating tasks to AI coding agents
70+
(gated behind the `coder.agentsEnabled` context flag).
71+
72+
There are also notifications for outdated workspace templates and for workspaces
73+
that are close to shutting down.
6874

6975
## Webviews
7076

README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,39 @@
55
[!["Join us on
66
Discord"](https://badgen.net/discord/online-members/coder)](https://coder.com/chat?utm_source=github.com/coder/vscode-coder&utm_medium=github&utm_campaign=readme.md)
77

8-
The Coder Remote extension lets you open [Coder](https://github.com/coder/coder)
9-
workspaces with a single click.
8+
The Coder Remote extension connects your editor to
9+
[Coder](https://github.com/coder/coder) workspaces with a single click.
1010

11-
- Open workspaces from the dashboard in a single click.
12-
- Automatically start workspaces when opened.
13-
- No command-line or local dependencies required - just install your editor!
14-
- Works in air-gapped or restricted networks. Just connect to your Coder
15-
deployment!
16-
- Supports multiple editors: VS Code, Cursor, and Windsurf.
11+
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
1712

18-
> [!NOTE]
19-
> The extension builds on VS Code-provided implementations of SSH. Make
20-
> sure you have the correct SSH extension installed for your editor
21-
> (`ms-vscode-remote.remote-ssh` or `codeium.windsurf-remote-openssh` for Windsurf).
13+
## Features
14+
15+
- **One-click workspace access** - open workspaces from the Coder dashboard or
16+
the editor sidebar. Workspaces start automatically when opened.
17+
- **Multi-editor support** - works with VS Code, Cursor, Windsurf, and other
18+
VS Code forks.
19+
- **Workspace sidebar** - browse, search, and create workspaces. View agent
20+
metadata and app statuses at a glance.
21+
- **Coder Tasks** - create, monitor, and manage AI agent tasks directly from
22+
the sidebar with real-time log streaming.
23+
- **Coder Chat** - delegate development tasks to AI coding agents from the
24+
sidebar. Requires [Coder Agents](https://coder.com/docs/ai-coder/agents) to
25+
be enabled on your deployment.
26+
- **Multi-deployment support** - connect to multiple Coder deployments and
27+
switch between them without losing credentials.
28+
- **Dev container support** - open dev containers running inside workspaces.
29+
- **Secure authentication** - session tokens stored in the OS keyring
30+
(macOS/Windows), with optional OAuth 2.1 support.
31+
- **Air-gapped / restricted networks** - no external dependencies beyond your
32+
Coder deployment.
33+
- **Automatic SSH tuning** - applies recommended SSH settings for reliable
34+
long-lived connections and recovers from sleep/wake.
2235

23-
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
36+
> [!NOTE]
37+
> The extension builds on VS Code-provided implementations of SSH. Make sure you
38+
> have the correct SSH extension installed for your editor
39+
> (`ms-vscode-remote.remote-ssh`, `anysphere.remote-ssh` for Cursor, or
40+
> `codeium.windsurf-remote-openssh` for Windsurf).
2441
2542
## Getting Started
2643

@@ -34,11 +51,6 @@ ext install coder.coder-remote
3451
Alternatively, manually install the VSIX from the
3552
[latest release](https://github.com/coder/vscode-coder/releases/latest).
3653

37-
### Variables Reference
38-
39-
Coder uses `${userHome}` from VS Code's
54+
All extension settings are under the `coder.*` namespace in the Settings UI.
55+
Paths in settings accept `~` and `${userHome}` from VS Code's
4056
[variables reference](https://code.visualstudio.com/docs/editor/variables-reference).
41-
Use this when formatting paths in the Coder extension settings rather than `~`
42-
or `$HOME`.
43-
44-
Example: ${userHome}/foo/bar.baz

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@
562562
"@typescript-eslint/eslint-plugin": "^8.57.2",
563563
"@typescript-eslint/parser": "^8.57.2",
564564
"@vitejs/plugin-react": "catalog:",
565-
"@vitest/coverage-v8": "^4.1.1",
565+
"@vitest/coverage-v8": "^4.1.2",
566566
"@vscode/test-cli": "^0.0.12",
567567
"@vscode/test-electron": "^2.5.2",
568568
"@vscode/vsce": "^3.7.1",
@@ -589,7 +589,7 @@
589589
"typescript-eslint": "^8.57.2",
590590
"utf-8-validate": "^6.0.6",
591591
"vite": "catalog:",
592-
"vitest": "^4.1.1"
592+
"vitest": "^4.1.2"
593593
},
594594
"extensionPack": [
595595
"ms-vscode-remote.remote-ssh"

0 commit comments

Comments
 (0)