VS Code in the browser
Go to file
Joe Previte 608871eba1
wip: change name back to goHome
2021-03-16 14:26:04 -07:00
.github refactor: remove --home flag/feature 2021-03-16 14:25:28 -07:00
.tours refactor: rename doc to docs 2021-02-03 09:46:35 -07:00
ci refactor: remove --home flag/feature 2021-03-16 14:25:28 -07:00
docs refactor: remove --home flag/feature 2021-03-16 14:25:28 -07:00
lib/vscode refactor: change goHome test to helpAbout 2021-03-16 14:25:28 -07:00
src refactor: remove --home flag/feature 2021-03-16 14:25:28 -07:00
test wip: change name back to goHome 2021-03-16 14:26:04 -07: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 feat: add test/videos & /screenshots to gitignore 2021-02-22 13:41:09 -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 Merge pull request #2843 from bpmct/deploy 2021-03-09 17:04:46 -05:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
install.sh chore: bump version to 3.9.1 2021-03-05 14:05:31 -07:00
package.json feat: update node version engine in package.json 2021-03-10 10:47:47 -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 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 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.