Go to file
Joe Previte e2f585f368
docs: add --edge to install section (#5767)
This adds documentation for the flag `--edge` which we've had for a
while but forgot to document.

Fixes #5717

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-11-10 11:50:37 -07:00
.github chore(deps): update minor dependency updates (#5720) 2022-11-09 14:03:07 -07:00
.tours docs: rename master to main in all github doc links (#5190) 2022-05-11 14:39:57 -07:00
ci refactor: get version dynamically (#5753) 2022-11-08 22:45:01 +00:00
docs docs: add --edge to install section (#5767) 2022-11-10 11:50:37 -07:00
lib chore: upgrade Code to 1.73.0 (#5751) 2022-11-09 22:10:03 +00:00
patches chore: upgrade Code to 1.73.0 (#5751) 2022-11-09 22:10:03 +00:00
src chore: upgrade Code to 1.73.0 (#5751) 2022-11-09 22:10:03 +00:00
test chore: upgrade Code to 1.73.0 (#5751) 2022-11-09 22:10:03 +00:00
typings chore(deps): update dependency @types/node to v16 (#5170) 2022-08-10 16:15:52 -05:00
.dockerignore Simplify packaging and improve scripts 2020-05-08 01:04:24 -04:00
.editorconfig Revert .editorconfig (#4640) 2021-12-16 15:30:07 -06:00
.eslintrc.yaml chore: replace eslint-import-resolver-alias with eslint-import-resolver-typescript (#4546) 2021-12-07 14:39:01 -07:00
.gitattributes browser: Add favicon.afdesign 2021-01-08 23:03:34 -05:00
.gitignore chore(Code): upgrade to 1.65 (#5047) 2022-03-30 18:33:58 -05:00
.gitmodules chore: move to patches (#4997) 2022-03-22 15:07:14 -05:00
.node-version chore: upgrade developmemt node version to v16 (#5167) 2022-05-06 09:57:19 -05:00
.nvmrc chore: Update dependency requirements. Fix node version manager. 2021-07-21 14:32:16 -04:00
.prettierignore chore: prettierignore updates and setup-helm upgrade (#5721) 2022-10-28 16:15:19 +00:00
.prettierrc.yaml chore(prettier): ignore lib/vscode (#5347) 2022-07-15 21:13:13 +00:00
CHANGELOG.md release: v4.8.3 (#5762) 2022-11-07 19:47:40 +00:00
LICENSE chore: remove file ext. from LICENSE (#5070) 2022-04-07 10:36:33 -07:00
ThirdPartyNotices.txt Add ThirdPartyNotices.txt 2020-07-16 19:01:09 -06:00
flake.lock chore: add flake for development with Nix (#5509) 2022-08-29 09:41:29 -07:00
flake.nix Improve getting started Coder CTA (#5752) 2022-11-07 11:06:51 -07:00
install.sh Improve getting started Coder CTA (#5752) 2022-11-07 11:06:51 -07:00
package.json chore(deps): update minor dependency updates (#5720) 2022-11-09 14:03:07 -07:00
renovate.json chore(rennovate): ignore updates for express (#5044) 2022-03-30 13:25:37 -07:00
tsconfig.json chore: move Code to a submodule (#4990) 2022-03-14 21:37:29 -05:00
yarn.lock chore(deps): update minor dependency updates (#5720) 2022-11-09 14:03:07 -07:00

docs/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

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 Organizations

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