2021-06-24 16:55:02 +00:00
# code-server ·
2019-01-08 00:46:19 +00:00
2021-06-24 16:55:02 +00:00
< div class = "badges" >
[](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.10.2/docs)
< / div >
2021-01-25 17:34:51 +00:00
2020-05-17 20:53:08 +00:00
Run [VS Code ](https://github.com/Microsoft/vscode ) on any machine anywhere and access it in the browser.
2019-03-06 01:45:21 +00:00
2021-06-24 16:21:28 +00:00
2020-05-22 02:16:16 +00:00
## Highlights
2020-10-29 21:21:47 +00:00
- 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
2020-05-12 05:46:38 +00:00
2021-02-10 05:41:36 +00:00
## Requirements
For a good experience, we recommend at least:
- 1 GB of RAM
- 2 cores
2021-06-24 16:21:28 +00:00
You can use whatever linux distribution floats your boat but in our [guide ](./guide.md ) we assume Debian on Google Cloud.
2021-02-10 05:41:36 +00:00
2020-05-18 00:47:33 +00:00
## Getting Started
2020-05-12 05:46:38 +00:00
2021-03-08 21:24:35 +00:00
There are three ways you can get started:
2020-05-12 05:46:38 +00:00
2021-06-24 16:21:28 +00: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 code-server; see [Installation ](./install.md ) for instructions applicable to most use cases
2021-03-08 23:58:43 +00:00
3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider ](https://github.com/cdr/deploy-code-server ) ⚡
2020-06-04 20:31:01 +00:00
2020-10-29 21:21:47 +00:00
If you choose to use the install script, you can preview what occurs during the install process:
2020-05-20 03:41:28 +00:00
```bash
2020-05-27 19:48:03 +00:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
2020-05-21 19:17:02 +00:00
```
2019-09-18 18:21:38 +00:00
2020-10-29 21:21:47 +00:00
To install, run:
2020-05-12 05:46:38 +00:00
```bash
2020-05-21 21:10:29 +00:00
curl -fsSL https://code-server.dev/install.sh | sh
2020-05-12 05:46:38 +00:00
```
2020-10-29 21:21:47 +00:00
When done, the install script prints out instructions for running and starting code-server.
2020-05-22 19:38:03 +00:00
2021-06-24 16:21:28 +00:00
We also have an in-depth [setup and configuration ](./guide.md ) guide.
2020-05-21 19:17:02 +00:00
2021-03-08 23:58:43 +00:00
### code-server --link
2020-10-21 20:45:53 +00:00
2020-11-16 22:18:12 +00:00
We're working on a cloud platform that makes deploying and managing code-server easier.
2020-12-08 23:38:20 +00:00
Consider running code-server with the beta flag `--link` if you don't want to worry about
2020-10-13 23:25:09 +00:00
2020-10-21 20:45:53 +00:00
- TLS
- Authentication
- Port Forwarding
2020-10-13 23:25:09 +00:00
2020-11-03 23:23:41 +00:00
```bash
$ code-server --link
2021-03-17 02:59:30 +00:00
Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
2020-11-03 23:23:41 +00:00
```
2020-02-19 00:07:01 +00:00
## FAQ
2019-10-23 16:49:05 +00:00
2021-06-24 16:21:28 +00:00
See [./FAQ.md ](./FAQ.md ).
2019-01-08 00:46:19 +00:00
2020-10-29 21:21:47 +00:00
## Want to help?
2020-03-19 21:53:31 +00:00
2021-06-24 16:21:28 +00:00
See [CONTRIBUTING ](./CONTRIBUTING.md ) for details.
2020-03-19 21:53:31 +00:00
2020-06-09 22:10:28 +00:00
## Hiring
2021-03-17 20:43:57 +00:00
Interested in [working at Coder ](https://coder.com )? Check out [our open positions ](https://jobs.lever.co/coder )!
2020-08-28 22:39:51 +00:00
2020-07-29 17:37:19 +00:00
## For Organizations
2019-09-27 14:39:29 +00:00
2021-06-21 15:51:55 +00:00
Want remote development for your organization or enterprise? Visit
[our website ](https://coder.com ) to learn more about Coder.
