code-server README

The project's README from github.com/coder/code-server. As one markdown file: README.md.

code-server

Twitter Follow Discord codecov See latest

Run VS Code on any machine anywhere and access it in the browser.

Screenshot Screenshot

Highlights

Requirements

See requirements for minimum specs, as well as instructions on how to set up a Google VM on which you can install code-server.

TL;DR: Linux machine with WebSockets enabled, 1 GB RAM, and 2 vCPUs

Getting started

There are five ways to get started:

  1. Using the install script, which automates most of the process. The script uses the system package manager if possible.
  2. Manually installing code-server
  3. Deploy code-server to your team with coder/coder
  4. Using our one-click buttons and guides to deploy code-server to a cloud provider ⚡
  5. Using the code-server feature for devcontainers, if you already use devcontainers in your project.

If you use the install script, you can preview what occurs during the install process:

curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run

To install, run:

curl -fsSL https://code-server.dev/install.sh | sh

When done, the install script prints out instructions for running and starting code-server.

Note To manage code-server for a team on your infrastructure, see: coder/coder

We also have an in-depth setup and configuration guide.

Questions?

See answers to frequently asked questions.

Want to help?

See Contributing for details.

Hiring

Interested in working at Coder? Check out our open positions!

For Teams

We develop coder/coder to help teams to adopt remote development.

code-server (coder/code-server)

Searching Database…

79.6K ·GitHub
Code-server
What is this?code-server runs VS Code on a remote machine and lets you access the full editor through a web browser, so you can code from any device.
Is this an editor I install locally, or something I run on a server?It is a server application: you install and run it on a Linux machine (a cloud VM, your own server, or a devcontainer), then open the VS Code UI in your browser from any device.
How do I get it running?The easiest way is the install script, which uses your system package manager; you can also install it manually, deploy it with coder/coder for teams, use one-click cloud deploy buttons, or add the devcontainers feature.
What kind of machine do I need to run it on?A Linux machine with WebSockets enabled, at least 1 GB RAM and 2 vCPUs.
Does it work on Windows or macOS servers?The stated requirement is a Linux machine, so it's built to be hosted on Linux rather than Windows or macOS servers.
Who is this for, solo devs or whole teams?It works for individuals who just want a consistent dev environment on the go, and for teams, who can deploy it centrally using the companion coder/coder project.
Why run VS Code remotely instead of locally?It lets heavy tasks like compiling, testing, and downloading run on a powerful cloud server instead of your laptop, saving battery and letting you work from any device with a browser.
Can I use it with my existing devcontainer setup?Yes, there is a dedicated code-server feature for devcontainers if your project already uses them.
Is there a managed or hosted way to run this for a company?Coder, the company behind code-server, offers coder/coder specifically to deploy and manage code-server across a team's infrastructure.
What are similar projects?coder, core, gitpod, devpod, agentbox, rocketride-server, claudecodeui, devbox
Which topics is it in?development-environment, remote-development, ide, vscode, cloud, devops, productivity, server, docker, typescript, self-hosted, cli
Creator
coder
Size
53.7 MB
Stars
79.6K
Updated
CommitOct 14Releasev4.141.0Oct 08
Age
7y
Commits · 90 Days