Go to file
Joe Previte 02134c01f6
Update README.md
Co-authored-by: Jonathan Yu <jonathan@coder.com>
2021-03-17 13:43:57 -07:00
.github Merge pull request #2901 from cdr/jsjoeio-update-bug-template 2021-03-17 17:48:12 +00:00
.tours refactor: rename doc to docs 2021-02-03 09:46:35 -07:00
ci chore: update formatting w/new prettier sh plugin 2021-03-15 15:36:31 -07:00
docs chore: update formatting w/new prettier sh plugin 2021-03-15 15:36:31 -07:00
lib/vscode chore: update vulnerable dependencies (#2861) 2021-03-12 01:46:40 +05:30
src Merge pull request #2906 from bpmct/rename-cloud 2021-03-17 18:28:14 +00:00
test Replace fs-extra with fs.promises 2021-03-16 12:51:08 -05: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 Add code-server alias to eslint 2021-02-09 13:33:31 -06:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore chore: update gitignore with test dirs 2021-03-12 12:00:57 -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
LICENSE.txt Shake CI and docs up 2020-02-14 19:46:17 -05:00
README.md Update README.md 2021-03-17 13:43:57 -07:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
install.sh chore: update formatting w/new prettier sh plugin 2021-03-15 15:36:31 -07:00
package.json chore(deps-dev): bump stylelint-config-recommended from 3.0.0 to 4.0.0 2021-03-17 11:05:31 +00:00
tsconfig.json chore: update ts config and jest config 2021-01-25 16:34:32 -07:00
yarn.lock chore(deps): bump proxy-agent from 4.0.0 to 4.0.1 (#2908) 2021-03-17 12:40:57 -05:00

README.md

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

Lines See latest 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

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 three ways you can 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
  3. Use our one-click buttons and guides to deploy code-server to a popular cloud provider

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.

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://valmar-jon.cdr.co

FAQ

See ./docs/FAQ.md.

Want to help?

See CONTRIBUTING for details.

Hiring

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

For Organizations

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