2021-06-25 01:10:00 +08:00
# code-server
2019-01-08 08:46:19 +08:00
2021-09-16 03:28:41 +08:00
[](https://github.com/cdr/code-server/discussions) [](https://cdr.co/join-community) [](https://twitter.com/coderhq) [](https://codecov.io/gh/cdr/code-server) [](https://github.com/cdr/code-server/tree/v3.12.0/docs)
2021-01-26 01:34:51 +08:00
2021-07-08 00:00:51 +08:00
Run [VS Code ](https://github.com/Microsoft/vscode ) on any machine anywhere and
access it in the browser.
2019-03-06 09:45:21 +08:00
2021-09-10 01:47:54 +08:00
2020-05-22 10:16:16 +08:00
## Highlights
2020-10-30 05:21:47 +08:00
- Code on any device with a consistent development environment
- Use cloud servers to speed up tests, compilations, downloads, and more
2021-07-08 00:00:51 +08:00
- Preserve battery life when you're on the go; all intensive tasks run on your
server
2020-05-12 13:46:38 +08:00
2021-11-10 01:30:27 +08:00
| 🔔 code-server is a free browser-based IDE while [Coder ](https://coder.com/ ), is our enterprise developer workspace platform. For more information, visit [Coder.com ](https://coder.com/docs/comparison )
| ---
2021-02-10 13:41:36 +08:00
## Requirements
2021-07-08 00:00:51 +08:00
See [requirements ](requirements.md ) for minimum specs, as well as instructions
on how to set up a Google VM on which you can install code-server.
2021-02-10 13:41:36 +08:00
2021-07-08 00:00:51 +08:00
**TL;DR:** Linux machine with WebSockets enabled, 1 GB RAM, and 2 CPUs
2021-02-10 13:41:36 +08:00
2021-07-08 00:00:51 +08:00
## Getting started
2021-02-10 13:41:36 +08:00
2021-07-08 00:00:51 +08:00
There are three ways to get started:
2020-05-12 13:46:38 +08:00
2021-07-08 00:00:51 +08:00
1. Using the [install
script](https://github.com/cdr/code-server/blob/main/install.sh), which
automates most of the process. The script uses the system package manager if
possible.
2. Manually [installing
2021-08-25 02:54:46 +08:00
code-server](https://coder.com/docs/code-server/latest/install)
2021-07-08 00:00:51 +08:00
3. Using our one-click buttons and guides to [deploy code-server to a cloud
provider](https://github.com/cdr/deploy-code-server) ⚡
2020-05-12 13:46:38 +08:00
2021-07-08 00:00:51 +08:00
If you use the install script, you can preview what occurs during the install
process:
2020-05-20 11:41:28 +08:00
```bash
2020-05-28 03:48:03 +08:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
2020-05-22 03:17:02 +08:00
```
2019-09-19 02:21:38 +08:00
2020-10-30 05:21:47 +08:00
To install, run:
2020-05-12 13:46:38 +08:00
```bash
2020-05-22 05:10:29 +08:00
curl -fsSL https://code-server.dev/install.sh | sh
2020-05-12 13:46:38 +08:00
```
2021-07-08 00:00:51 +08:00
When done, the install script prints out instructions for running and starting
code-server.
2020-05-23 03:38:03 +08:00
2021-07-08 00:00:51 +08:00
We also have an in-depth [setup and
2021-08-25 02:54:46 +08:00
configuration](https://coder.com/docs/code-server/latest/guide) guide.
2020-05-22 03:17:02 +08:00
2021-07-08 00:00:51 +08:00
## Questions?
2019-10-24 00:49:05 +08:00
2021-07-08 00:00:51 +08:00
See answers to [frequently asked
2021-08-25 02:54:46 +08:00
questions](https://coder.com/docs/code-server/latest/FAQ).
2019-01-08 08:46:19 +08:00
2020-10-30 05:21:47 +08:00
## Want to help?
2020-03-20 05:53:31 +08:00
2021-08-25 02:54:46 +08:00
See [Contributing ](https://coder.com/docs/code-server/latest/CONTRIBUTING ) for
2021-07-08 00:00:51 +08:00
details.
2020-03-20 05:53:31 +08:00
2020-06-10 06:10:28 +08:00
## Hiring
2021-07-08 00:00:51 +08:00
Interested in [working at Coder ](https://coder.com/careers )? Check out [our open
positions](https://coder.com/careers#openings)!
2020-08-29 06:39:51 +08:00
2020-07-30 01:37:19 +08:00
## For Organizations
2019-09-27 22:39:29 +08:00
2021-07-08 00:00:51 +08:00
Want remote development for your organization or enterprise? Visit [our
website](https://coder.com) to learn more about Coder.
