|
1 | | -# code-server |
| 1 | +# Claude Code Server |
2 | 2 |
|
3 | | -[](https://github.com/coder/code-server/discussions) [](https://coder.com/community) [](https://twitter.com/coderhq) [](https://discord.com/invite/coder) [](https://codecov.io/gh/coder/code-server) [](https://coder.com/docs/code-server/latest) |
| 3 | + |
| 4 | + |
| 5 | +**Browser-based VS Code with Claude Code CLI pre-installed** |
| 6 | + |
| 7 | +[](https://railway.com/template/claude-code-server) |
4 | 8 |
|
5 | 9 |  |
6 | 10 |
|
7 | | -Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and |
8 | | -access it in the browser. |
| 11 | +Deploy a full VS Code development environment in the cloud with Claude Code CLI ready to go. Access it from any browser, on any device. Code with AI assistance anywhere. |
| 12 | + |
| 13 | +--- |
9 | 14 |
|
10 | | - |
11 | | - |
| 15 | +## Features |
12 | 16 |
|
13 | | -## Highlights |
| 17 | +- **Claude Code CLI Pre-installed** – Start AI-assisted coding immediately with `claude` or `claude-auto` (YOLO mode) |
| 18 | +- **Browser-Based VS Code** – Full IDE experience accessible from any device |
| 19 | +- **Persistent Storage** – Your extensions, settings, and projects survive redeploys |
| 20 | +- **Non-Root Security** – Runs as the `clauder` user with optional sudo access |
| 21 | +- **One-Click Deploy** – Deploy to Railway in 60 seconds |
14 | 22 |
|
15 | | -- Code on any device with a consistent development environment |
16 | | -- Use cloud servers to speed up tests, compilations, downloads, and more |
17 | | -- Preserve battery life when you're on the go; all intensive tasks run on your |
18 | | - server |
| 23 | +--- |
19 | 24 |
|
20 | | -## Requirements |
| 25 | +## Quick Start |
21 | 26 |
|
22 | | -See [requirements](https://coder.com/docs/code-server/latest/requirements) for minimum specs, as well as instructions |
23 | | -on how to set up a Google VM on which you can install code-server. |
| 27 | +### Deploy to Railway |
24 | 28 |
|
25 | | -**TL;DR:** Linux machine with WebSockets enabled, 1 GB RAM, and 2 vCPUs |
| 29 | +Click the button above, or: |
26 | 30 |
|
27 | | -## Getting started |
| 31 | +1. Go to [Railway Templates](https://railway.com/templates) |
| 32 | +2. Search for "Claude Code Server" |
| 33 | +3. Click **Deploy** and set your `PASSWORD` |
| 34 | +4. Attach a volume to `/home/clauder` |
| 35 | +5. Open the generated domain in your browser |
28 | 36 |
|
29 | | -There are five ways to get started: |
| 37 | +### First Login |
30 | 38 |
|
31 | | -1. Using the [install |
32 | | - script](https://github.com/coder/code-server/blob/main/install.sh), which |
33 | | - automates most of the process. The script uses the system package manager if |
34 | | - possible. |
35 | | -2. Manually [installing |
36 | | - code-server](https://coder.com/docs/code-server/latest/install) |
37 | | -3. Deploy code-server to your team with [coder/coder](https://cdr.co/coder-github) |
38 | | -4. Using our one-click buttons and guides to [deploy code-server to a cloud |
39 | | - provider](https://github.com/coder/deploy-code-server) ⚡ |
40 | | -5. Using the [code-server feature for |
41 | | - devcontainers](https://github.com/coder/devcontainer-features/blob/main/src/code-server/README.md), |
42 | | - if you already use devcontainers in your project. |
| 39 | +1. Enter the password you set |
| 40 | +2. Open the terminal in VS Code |
| 41 | +3. Run `claude` to start coding with AI |
43 | 42 |
|
44 | | -If you use the install script, you can preview what occurs during the install |
45 | | -process: |
| 43 | +--- |
46 | 44 |
|
47 | | -```bash |
48 | | -curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run |
49 | | -``` |
| 45 | +## Configuration |
50 | 46 |
|
51 | | -To install, run: |
| 47 | +### Required Variables |
52 | 48 |
|
53 | | -```bash |
54 | | -curl -fsSL https://code-server.dev/install.sh | sh |
55 | | -``` |
| 49 | +| Variable | Description | |
| 50 | +|------------|------------------------------------| |
| 51 | +| `PASSWORD` | Login password for the web IDE | |
56 | 52 |
|
57 | | -When done, the install script prints out instructions for running and starting |
58 | | -code-server. |
| 53 | +### Optional Variables |
59 | 54 |
|
60 | | -> **Note** |
61 | | -> To manage code-server for a team on your infrastructure, see: [coder/coder](https://cdr.co/coder-github) |
| 55 | +| Variable | Default | Description | |
| 56 | +|----------------|--------------------------------|------------------------------------------| |
| 57 | +| `CLAUDER_HOME` | `/home/clauder` | Volume mount path | |
| 58 | +| `RUN_AS_USER` | `clauder` | Set to `root` if you need root access | |
| 59 | +| `APP_NAME` | `Claude Code Server` | Login page title | |
| 60 | +| `WELCOME_TEXT` | `Welcome to Claude Code Server`| Login page message | |
62 | 61 |
|
63 | | -We also have an in-depth [setup and |
64 | | -configuration](https://coder.com/docs/code-server/latest/guide) guide. |
| 62 | +### Volume Configuration |
65 | 63 |
|
66 | | -## Questions? |
| 64 | +> ⚠️ **CRITICAL**: Without a volume, ALL data is lost on every redeploy! |
67 | 65 |
|
68 | | -See answers to [frequently asked |
69 | | -questions](https://coder.com/docs/code-server/latest/FAQ). |
| 66 | +| Setting | Value | |
| 67 | +|----------------|------------------| |
| 68 | +| **Mount Path** | `/home/clauder` | |
| 69 | +| **Size** | 5GB+ recommended | |
70 | 70 |
|
71 | | -## Want to help? |
| 71 | +--- |
72 | 72 |
|
73 | | -See [Contributing](https://coder.com/docs/code-server/latest/CONTRIBUTING) for |
74 | | -details. |
| 73 | +## Built With |
75 | 74 |
|
76 | | -## Hiring |
| 75 | +- [code-server](https://github.com/coder/code-server) – VS Code in the browser |
| 76 | +- [Claude Code CLI](https://claude.ai/code) – AI coding assistant by Anthropic |
77 | 77 |
|
78 | | -Interested in [working at Coder](https://coder.com/careers)? Check out [our open |
79 | | -positions](https://coder.com/careers#openings)! |
| 78 | +--- |
80 | 79 |
|
81 | | -## For Teams |
| 80 | +## License |
82 | 81 |
|
83 | | -We develop [coder/coder](https://cdr.co/coder-github) to help teams to |
84 | | -adopt remote development. |
| 82 | +MIT |
0 commit comments