VS Code in the browser
Go to file
Anmol Sethi 41d625abb6
Revamp README.md with new installation options
2020-05-12 21:26:36 -04:00
.github Fixes for CI from @code-asher's review 2020-05-08 16:45:59 -04:00
ci Revamp README.md with new installation options 2020-05-12 21:26:36 -04:00
doc Configuration file bug fixes based on @code-asher's review 2020-05-12 19:59:54 -04:00
lib Update VS Code to fix infinite refresh 2020-05-05 12:33:09 -05:00
src Improve password handling 2020-05-12 19:59:55 -04:00
test Add default config file and improve config/data directory detection 2020-05-12 19:59:54 -04:00
typings/httpolyglot Format and lint 2020-02-14 20:00:19 -05:00
.dockerignore Simplify packaging and improve scripts 2020-05-08 01:04:24 -04:00
.editorconfig Add back .editorconfig 2020-02-19 14:22:14 -05:00
.eslintrc.yaml Improve password handling 2020-05-12 19:59:55 -04:00
.gitignore Simplify packaging and improve scripts 2020-05-08 01:04:24 -04:00
.gitmodules Implement new structure 2020-02-04 14:31:44 -06:00
.prettierrc.yaml Shake CI and docs up 2020-02-14 19:46:17 -05:00
.stylelintrc.yaml Fix bugs in CI 2020-02-18 19:06:35 -05:00
LICENSE.txt Shake CI and docs up 2020-02-14 19:46:17 -05:00
README.md Revamp README.md with new installation options 2020-05-12 21:26:36 -04:00
package.json Improve password handling 2020-05-12 19:59:55 -04:00
tsconfig.json Format and lint 2020-02-14 20:00:19 -05:00
yarn.lock Add default config file and improve config/data directory detection 2020-05-12 19:59:54 -04:00

README.md

code-server

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

  • Code anywhere: Code on your Chromebook, tablet, and laptop with a consistent dev environment. Develop on a Linux machine and pick up from any device with a web browser.
  • Server-powered: Take advantage of large cloud servers to speed up tests, compilations, downloads, and more. Preserve battery life when you're on the go since all intensive tasks runs on your server. Make use of a spare computer you have lying around and turn it into a full development environment.

Example gif

Getting started

For a proper setup and walkthrough, please see ./doc/guide.md.

Debian, Ubuntu

curl -sSOL https://github.com/cdr/code-server/releases/download/3.3.0/code-server_3.3.0_amd64.deb
sudo dpkg -i code-server_3.3.0_amd64.deb
sudo systemctl enable --now code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml

Fedora, Red Hat, SUSE

curl -sSOL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-amd64.rpm
sudo dnf install code-server-3.3.0-amd64.rpm
sudo systemctl enable --now code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml

npm

npm install -g code-server
code-server

macOS

brew install code-server
brew service start code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml

SSH

You can use sshcode to start and use code-server on any Linux machine over SSH.

sshcode user@dev.coder.com
# Downloads and installs code-server on dev.coder.com and opens it in a new browser window.

Digital Ocean

Create a Droplet

Docker

docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" -u "$(id -u):$(id -g)" codercom/code-server:latest

This will start a code-server container and expose it at http://127.0.0.1:8080. It will also mount your current directory into the container as /home/coder/project and forward your UID/GID so that all file system operations occur as your user outside the container.

Self contained releases

We publish self contained archives for every release on github. They bundle the node binary and node_modules.

  1. Download the latest release archive for your system from github
  2. Unpack the release
  3. You can run code-server by executing bin/code-server

Add the code-server bin directory to your $PATH to easily execute it without the full path every time.

Here is an example script for installing and using a self-contained code-server release on Linux:

curl -sSL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-linux-amd64.tar.gz | sudo tar -C /opt -xz
PATH="$PATH:/opt/code-server-3.3.0-linux-amd64/bin"
code-server

FAQ

See ./doc/FAQ.md.

Contributing

See ./doc/CONTRIBUTING.md.

Enterprise

Visit our enterprise page for more information about our enterprise offerings.