VS Code in the browser
Go to file
Joe Previte cc50e7f72b
Merge pull request #3771 from cdr/dependabot/npm_and_yarn/typescript-eslint/eslint-plugin-4.28.3
chore(deps-dev): bump @typescript-eslint/eslint-plugin from 4.28.2 to 4.28.3
2021-07-13 10:56:31 -07:00
.github Check for bashisms in install script 2021-07-13 12:28:40 -05:00
.tours chore: update node to v14 (#3481) 2021-06-01 22:49:03 +05:30
ci Add installer unit tests 2021-07-13 12:22:00 -05:00
docs Add installer unit tests 2021-07-13 12:22:00 -05:00
lib/vscode fix: openFolder by using command ID for Explorer 2021-07-06 14:05:27 -07:00
src fix: check path is string in pathToFsPath 2021-07-12 16:39:42 -07:00
test Add installer unit tests 2021-07-13 12:22:00 -05:00
typings refactor: parse options with multiple = in cli 2021-06-08 14:33:17 -07: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 fix: remove eslint-plugin-jest-playwright 2021-04-29 10:46:14 -07:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07: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
CHANGELOG.md refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07:00
LICENSE.txt Shake CI and docs up 2020-02-14 19:46:17 -05:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
install.sh Avoid root when prefix is writable 2021-07-13 12:22:06 -05:00
package.json Add installer unit tests 2021-07-13 12:22:00 -05:00
tsconfig.json refactor: migrate parcel to browserify 2021-06-28 11:41:45 -07:00
yarn.lock Merge pull request #3771 from cdr/dependabot/npm_and_yarn/typescript-eslint/eslint-plugin-4.28.3 2021-07-13 10:56:31 -07:00

docs/README.md

code-server

"GitHub Discussions" "Join us on Slack" Twitter Follow codecov See v3.10.2 docs

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

Screenshot

Highlights

  • 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

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 CPUs

Getting started

There are three 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. Using our one-click buttons and guides to deploy code-server to a cloud provider

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.

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

We're working on a cloud platform that makes deploying and managing code-server easier. Consider running code-server with the beta flag --link if you don't want to worry about:

  • TLS
  • Authentication
  • Port forwarding
$ code-server --link
Proxying code-server, you can access your IDE at https://example.cdr.co

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 Organizations

Want remote development for your organization or enterprise? Visit our website to learn more about Coder.