Go to file
Asher 02f9af1731
Merge pull request #2737 from cdr/health-test
Fix healthz socket
2021-02-18 11:38:00 -06:00
.github Squashed 'lib/vscode/' changes from e5a624b788..3e344b17b7 2021-02-09 16:06:38 +00:00
.tours refactor: rename doc to docs 2021-02-03 09:46:35 -07:00
ci feat: update release template w/doc and dev 2021-02-12 16:22:32 -07:00
docs fixup: fmt install.md 2021-02-12 16:22:32 -07:00
lib/vscode Resolve browser telemetry conflict 2021-02-09 11:11:38 -06:00
src Fix health socket not getting client messages 2021-02-16 15:01:46 -06:00
test Fix health socket not getting client messages 2021-02-16 15:01:46 -06:00
typings Delegate authentication to plugins 2021-02-12 16:50:23 -06: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 refactor: remove mocha 2021-01-21 10:10:33 -07:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore refactor: rename doc to docs 2021-02-03 09:46:35 -07:00
.ignore Rename dev/container -> dev/image 2020-06-03 15:45:16 -04: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 chore: update code coverage badge 2021-02-12 16:22:32 -07:00
ThirdPartyNotices.txt Squashed 'lib/vscode/' changes from e5a624b788..3e344b17b7 2021-02-09 16:06:38 +00:00
install.sh chore(install.sh): update to v3.9.0 2021-02-12 16:22:31 -07:00
package.json chore: update package.json version 2021-02-12 16:22:31 -07:00
tsconfig.json chore: update ts config and jest config 2021-01-25 16:34:32 -07:00
yarn.lock feat: use compression in express server (#2680) 2021-02-12 14:27:33 -06:00

README.md

code-server · "GitHub Discussions" "Join us on Slack" Twitter Follow

Lines

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

For a good experience, we recommend at least:

  • 1 GB of RAM
  • 2 cores

You can use whatever linux distribution floats your boat but in our guide we assume Debian on Google Cloud.

Getting Started

There are two 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; see Installation for instructions applicable to most use cases

If you choose to 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.

Cloud Program ☁️

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 to Coder Cloud, you can access your IDE at https://valmar-jon.cdr.co

FAQ

See ./docs/FAQ.md.

Want to help?

See CONTRIBUTING for details.

Hiring

We (@cdr) are looking for engineers to help maintain code-server, innovate on open source, and streamline dev workflows.

Our main office is in Austin, Texas. Remote is ok as long as you're in North America or Europe.

Please get in touch with your resume/GitHub if interested.

For Organizations

Visit our website for more information about remote development for your organization or enterprise.