code-server/README.md

59 lines
1.9 KiB
Markdown
Raw Normal View History

2020-02-19 08:07:01 +08:00
# code-server
2019-01-08 08:46:19 +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
2020-05-22 10:16:16 +08:00
![Screenshot](./doc/assets/screenshot.png)
## Highlights
2020-05-23 03:38:03 +08:00
- **Code everywhere**
- Code on your Chromebook, tablet, and laptop with a consistent development environment.
- Develop on a Linux machine and pick up from any device with a web browser.
- **Server-powered**
- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
- Preserve battery life when you're on the go as all intensive tasks runs on your server.
- Make use of a spare computer you have lying around and turn it into a full development environment.
2020-05-18 08:47:33 +08:00
## Getting Started
2020-05-18 04:53:08 +08:00
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
2020-05-23 03:38:03 +08:00
We have a [script](./install.sh) to install code-server for Linux and macOS.
2020-05-22 11:53:02 +08:00
2020-05-22 10:16:16 +08:00
It tries to use the system package manager if possible.
2020-05-22 05:10:29 +08:00
First run to print out 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 05:10:29 +08:00
Now to actually install:
```bash
2020-05-22 05:10:29 +08:00
curl -fsSL https://code-server.dev/install.sh | sh
```
2020-05-22 10:16:16 +08:00
The install script will print out how to run and start using code-server.
2020-05-23 03:38:03 +08:00
If you believe an install script used with `curl | sh` is insecure, please give
[this wonderful blogpost](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) by
[sandstorm.io](https://sandstorm.io) a read.
2020-05-22 10:16:16 +08:00
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
We also highly recommend reading the [FAQ](./doc/FAQ.md) on the [Differences compared to VS Code](./doc/FAQ.md#differences-compared-to-vs-code).
2020-02-19 08:07:01 +08:00
## FAQ
2020-02-19 08:07:01 +08:00
See [./doc/FAQ.md](./doc/FAQ.md).
2019-01-08 08:46:19 +08:00
2020-03-20 05:53:31 +08:00
## Contributing
See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).
## Enterprise
2019-09-27 22:39:29 +08:00
2020-05-18 05:57:59 +08:00
Visit [our website](https://coder.com) for more information about our
2020-02-19 08:07:01 +08:00
enterprise offerings.