2021-06-25 01:10:00 +08:00
# code-server
2019-01-08 08:46:19 +08:00
2021-06-25 00:56:46 +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.10.2/docs)
2021-01-26 01:34:51 +08:00
2020-05-18 04:53:08 +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-06-25 00:21:28 +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
- 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-02-10 13:41:36 +08:00
## Requirements
For a good experience, we recommend at least:
- 1 GB of RAM
- 2 cores
2021-06-25 00:21:28 +08: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 13:41:36 +08:00
2020-05-18 08:47:33 +08:00
## Getting Started
2020-05-12 13:46:38 +08:00
2021-03-09 05:24:35 +08:00
There are three ways you can get started:
2020-05-12 13:46:38 +08:00
2021-06-25 00:21:28 +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 code-server; see [Installation ](./install.md ) for instructions applicable to most use cases
2021-03-09 07:58:43 +08: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-05 04:31:01 +08:00
2020-10-30 05:21:47 +08:00
If you choose to 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
```
2020-10-30 05:21:47 +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-06-25 00:21:28 +08:00
We also have an in-depth [setup and configuration ](./guide.md ) guide.
2020-05-22 03:17:02 +08:00
2021-03-09 07:58:43 +08:00
### code-server --link
2020-10-22 04:45:53 +08:00
2020-11-17 06:18:12 +08:00
We're working on a cloud platform that makes deploying and managing code-server easier.
2020-12-09 07:38:20 +08:00
Consider running code-server with the beta flag `--link` if you don't want to worry about
2020-10-14 07:25:09 +08:00
2020-10-22 04:45:53 +08:00
- TLS
- Authentication
- Port Forwarding
2020-10-14 07:25:09 +08:00
2020-11-04 07:23:41 +08:00
```bash
$ code-server --link
2021-03-17 10:59:30 +08:00
Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
2020-11-04 07:23:41 +08:00
```
2020-02-19 08:07:01 +08:00
## FAQ
2019-10-24 00:49:05 +08:00
2021-06-25 00:21:28 +08:00
See [./FAQ.md ](./FAQ.md ).
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-06-25 00:21:28 +08:00
See [CONTRIBUTING ](./CONTRIBUTING.md ) for details.
2020-03-20 05:53:31 +08:00
2020-06-10 06:10:28 +08:00
## Hiring
2021-03-18 04:43:57 +08:00
Interested in [working at Coder ](https://coder.com )? Check out [our open positions ](https://jobs.lever.co/coder )!
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-06-21 23:51:55 +08:00
Want remote development for your organization or enterprise? Visit
[our website ](https://coder.com ) to learn more about Coder.
