code-server/docs
Asher f74333cef3
Run formatter
Not sure why it keeps trying to indent the options though, in CI it
wants it flat.  Going to keep it flat for now until we figure it out.
2024-08-26 11:31:52 -08:00
..
assets Update screenshots (#6372) 2023-08-07 19:02:54 +00:00
CODE_OF_CONDUCT.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
CONTRIBUTING.md Update contributing docs 2024-07-03 13:33:02 -08:00
FAQ.md Add faq entry about web views 2024-07-11 11:52:23 -08:00
MAINTAINING.md Update contributing docs 2024-07-03 13:33:02 -08:00
README.md Improve README callout to coder/coder (#6579) 2023-12-12 14:23:54 -09:00
SECURITY.md Remove unused audit-ci dependency 2024-07-10 13:23:24 -08:00
android.md Update Code to 1.90.0 (#6824) 2024-06-06 15:02:13 -08:00
coder.md docs: add coder module as an installation method (#6692) 2024-02-28 22:06:49 +00:00
collaboration.md release: 4.7.0 (#5546) 2022-09-09 15:15:39 -07:00
guide.md Run formatter 2024-08-26 11:31:52 -08:00
helm.md release: 4.8.0 (#5698) 2022-10-24 16:23:03 -07:00
install.md Add `.local` mount to example Docker command (#6419) 2023-09-22 17:07:07 -08:00
ios.md Update ios.md (#5079) 2022-04-12 11:32:49 -07:00
ipad.md refactor: update prettier and doctoc (#5605) 2022-10-13 22:16:55 +00:00
manifest.json Remove deprecated --link (#6018) 2023-02-13 16:52:48 -06:00
npm.md Update Code to 1.90.0 (#6824) 2024-06-06 15:02:13 -08:00
requirements.md Improve README callout to coder/coder (#6579) 2023-12-12 14:23:54 -09:00
termux.md Update Code to 1.90.0 (#6824) 2024-06-06 15:02:13 -08:00
triage.md docs: Update some more links (#4806) 2022-02-01 09:45:19 -07:00
upgrade.md refactor(docs): clean up and restructure 2021-07-12 14:03:09 -05:00

README.md

code-server

"GitHub Discussions" "Join us on Slack" Twitter Follow codecov See latest

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

Screenshot 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 vCPUs

Getting started

There are four 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. Deploy code-server to your team with coder/coder
  4. 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.

Note To manage code-server for a team on your infrastructure, see: coder/coder

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

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 Teams

We develop coder/coder to help teams to adopt remote development.