mirror of
https://github.com/coder/code-server.git
synced 2026-03-30 00:02:16 +08:00
Added readme
This commit is contained in:
SAGE
parent
d0c8f78d77
commit
f148984d6d
110
README.md
110
README.md
@ -1,84 +1,82 @@
|
||||
# code-server
|
||||
# Claude Code Server
|
||||
|
||||
[](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)
|
||||
|
||||
|
||||
**Browser-based VS Code with Claude Code CLI pre-installed**
|
||||
|
||||
[](https://railway.com/template/claude-code-server)
|
||||
|
||||
|
||||
|
||||
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and
|
||||
access it in the browser.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Highlights
|
||||
## Features
|
||||
|
||||
- Code on any device with a consistent development environment
|
||||
- Use cloud servers to speed up tests, compilations, downloads, and more
|
||||
- Preserve battery life when you're on the go; all intensive tasks run on your
|
||||
server
|
||||
- **Claude Code CLI Pre-installed** – Start AI-assisted coding immediately with `claude` or `claude-auto` (YOLO mode)
|
||||
- **Browser-Based VS Code** – Full IDE experience accessible from any device
|
||||
- **Persistent Storage** – Your extensions, settings, and projects survive redeploys
|
||||
- **Non-Root Security** – Runs as the `clauder` user with optional sudo access
|
||||
- **One-Click Deploy** – Deploy to Railway in 60 seconds
|
||||
|
||||
## Requirements
|
||||
---
|
||||
|
||||
See [requirements](https://coder.com/docs/code-server/latest/requirements) for minimum specs, as well as instructions
|
||||
on how to set up a Google VM on which you can install code-server.
|
||||
## Quick Start
|
||||
|
||||
**TL;DR:** Linux machine with WebSockets enabled, 1 GB RAM, and 2 vCPUs
|
||||
### Deploy to Railway
|
||||
|
||||
## Getting started
|
||||
Click the button above, or:
|
||||
|
||||
There are five ways to get started:
|
||||
1. Go to [Railway Templates](https://railway.com/templates)
|
||||
2. Search for "Claude Code Server"
|
||||
3. Click **Deploy** and set your `PASSWORD`
|
||||
4. Attach a volume to `/home/clauder`
|
||||
5. Open the generated domain in your browser
|
||||
|
||||
1. Using the [install
|
||||
script](https://github.com/coder/code-server/blob/main/install.sh), which
|
||||
automates most of the process. The script uses the system package manager if
|
||||
possible.
|
||||
2. Manually [installing
|
||||
code-server](https://coder.com/docs/code-server/latest/install)
|
||||
3. Deploy code-server to your team with [coder/coder](https://cdr.co/coder-github)
|
||||
4. Using our one-click buttons and guides to [deploy code-server to a cloud
|
||||
provider](https://github.com/coder/deploy-code-server) ⚡
|
||||
5. Using the [code-server feature for
|
||||
devcontainers](https://github.com/coder/devcontainer-features/blob/main/src/code-server/README.md),
|
||||
if you already use devcontainers in your project.
|
||||
### First Login
|
||||
|
||||
If you use the install script, you can preview what occurs during the install
|
||||
process:
|
||||
1. Enter the password you set
|
||||
2. Open the terminal in VS Code
|
||||
3. Run `claude` to start coding with AI
|
||||
|
||||
```bash
|
||||
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
|
||||
```
|
||||
---
|
||||
|
||||
To install, run:
|
||||
## Configuration
|
||||
|
||||
```bash
|
||||
curl -fsSL https://code-server.dev/install.sh | sh
|
||||
```
|
||||
### Required Variables
|
||||
|
||||
When done, the install script prints out instructions for running and starting
|
||||
code-server.
|
||||
| Variable | Description |
|
||||
|------------|------------------------------------|
|
||||
| `PASSWORD` | Login password for the web IDE |
|
||||
|
||||
> **Note**
|
||||
> To manage code-server for a team on your infrastructure, see: [coder/coder](https://cdr.co/coder-github)
|
||||
### Optional Variables
|
||||
|
||||
We also have an in-depth [setup and
|
||||
configuration](https://coder.com/docs/code-server/latest/guide) guide.
|
||||
| Variable | Default | Description |
|
||||
|----------------|--------------------------------|------------------------------------------|
|
||||
| `CLAUDER_HOME` | `/home/clauder` | Volume mount path |
|
||||
| `RUN_AS_USER` | `clauder` | Set to `root` if you need root access |
|
||||
| `APP_NAME` | `Claude Code Server` | Login page title |
|
||||
| `WELCOME_TEXT` | `Welcome to Claude Code Server`| Login page message |
|
||||
|
||||
## Questions?
|
||||
### Volume Configuration
|
||||
|
||||
See answers to [frequently asked
|
||||
questions](https://coder.com/docs/code-server/latest/FAQ).
|
||||
> ⚠️ **CRITICAL**: Without a volume, ALL data is lost on every redeploy!
|
||||
|
||||
## Want to help?
|
||||
| Setting | Value |
|
||||
|----------------|------------------|
|
||||
| **Mount Path** | `/home/clauder` |
|
||||
| **Size** | 5GB+ recommended |
|
||||
|
||||
See [Contributing](https://coder.com/docs/code-server/latest/CONTRIBUTING) for
|
||||
details.
|
||||
---
|
||||
|
||||
## Hiring
|
||||
## Built With
|
||||
|
||||
Interested in [working at Coder](https://coder.com/careers)? Check out [our open
|
||||
positions](https://coder.com/careers#openings)!
|
||||
- [code-server](https://github.com/coder/code-server) – VS Code in the browser
|
||||
- [Claude Code CLI](https://claude.ai/code) – AI coding assistant by Anthropic
|
||||
|
||||
## For Teams
|
||||
---
|
||||
|
||||
We develop [coder/coder](https://cdr.co/coder-github) to help teams to
|
||||
adopt remote development.
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user