Skip to content

Commit 10ea7a6

Browse files
authored
Merge pull request #1 from sphinxcode/dev
Pushed to main
2 parents 14e44df + f148984 commit 10ea7a6

File tree

2 files changed

+100
-56
lines changed

2 files changed

+100
-56
lines changed

.github/workflows/deploy-image.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Builds and pushes the Docker image to GitHub Container Registry
2+
name: Publish Docker Image
3+
4+
on:
5+
push:
6+
branches: [main]
7+
workflow_dispatch:
8+
9+
env:
10+
REGISTRY: ghcr.io
11+
IMAGE_NAME: ${{ github.repository }}
12+
13+
jobs:
14+
build-and-push:
15+
runs-on: ubuntu-latest
16+
permissions:
17+
contents: read
18+
packages: write
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
24+
- name: Log in to the Container registry
25+
uses: docker/login-action@v3
26+
with:
27+
registry: ${{ env.REGISTRY }}
28+
username: ${{ github.actor }}
29+
password: ${{ secrets.GITHUB_TOKEN }}
30+
31+
- name: Extract metadata (tags, labels) for Docker
32+
id: meta
33+
uses: docker/metadata-action@v5
34+
with:
35+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
36+
tags: |
37+
type=raw,value=latest
38+
type=sha,prefix=
39+
40+
- name: Build and push Docker image
41+
uses: docker/build-push-action@v5
42+
with:
43+
context: .
44+
push: true
45+
tags: ${{ steps.meta.outputs.tags }}
46+
labels: ${{ steps.meta.outputs.labels }}

README.md

Lines changed: 54 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,82 @@
1-
# code-server
1+
# Claude Code Server
22

3-
[!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://coder.com/community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![Discord](https://img.shields.io/discord/747933592273027093)](https://discord.com/invite/coder) [![codecov](https://codecov.io/gh/coder/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/coder/code-server) [![See latest](https://img.shields.io/static/v1?label=Docs&message=see%20latest&color=blue)](https://coder.com/docs/code-server/latest)
3+
![Claude Code Server Logo](https://raw.githubusercontent.com/sphinxcode/claude-code-server/refs/heads/main/public/claude-code-server-logo.png)
4+
5+
**Browser-based VS Code with Claude Code CLI pre-installed**
6+
7+
[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/template/claude-code-server)
48

59
![Mobile Mockup](https://raw.githubusercontent.com/sphinxcode/claude-code-server/refs/heads/main/public/iphone_mockup.png)
610

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+
---
914

10-
![Screenshot](./assets/screenshot-1.png)
11-
![Screenshot](./assets/screenshot-2.png)
15+
## Features
1216

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
1422

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+
---
1924

20-
## Requirements
25+
## Quick Start
2126

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
2428

25-
**TL;DR:** Linux machine with WebSockets enabled, 1 GB RAM, and 2 vCPUs
29+
Click the button above, or:
2630

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
2836

29-
There are five ways to get started:
37+
### First Login
3038

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
4342

44-
If you use the install script, you can preview what occurs during the install
45-
process:
43+
---
4644

47-
```bash
48-
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
49-
```
45+
## Configuration
5046

51-
To install, run:
47+
### Required Variables
5248

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

57-
When done, the install script prints out instructions for running and starting
58-
code-server.
53+
### Optional Variables
5954

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

63-
We also have an in-depth [setup and
64-
configuration](https://coder.com/docs/code-server/latest/guide) guide.
62+
### Volume Configuration
6563

66-
## Questions?
64+
> ⚠️ **CRITICAL**: Without a volume, ALL data is lost on every redeploy!
6765
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 |
7070

71-
## Want to help?
71+
---
7272

73-
See [Contributing](https://coder.com/docs/code-server/latest/CONTRIBUTING) for
74-
details.
73+
## Built With
7574

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
7777

78-
Interested in [working at Coder](https://coder.com/careers)? Check out [our open
79-
positions](https://coder.com/careers#openings)!
78+
---
8079

81-
## For Teams
80+
## License
8281

83-
We develop [coder/coder](https://cdr.co/coder-github) to help teams to
84-
adopt remote development.
82+
MIT

0 commit comments

Comments
 (0)