README.md 1.9 KB
Newer Older
A
Anmol Sethi 已提交
1
# code-server
A
Asher 已提交
2

A
Anmol Sethi 已提交
3
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
4

A
Anmol Sethi 已提交
5 6 7 8
![Screenshot](./doc/assets/screenshot.png)

## Highlights

A
Anmol Sethi 已提交
9 10 11 12 13 14 15
- **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.
16

A
Anmol Sethi 已提交
17
## Getting Started
18

A
Anmol Sethi 已提交
19
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
20

A
Anmol Sethi 已提交
21
We have a [script](./install.sh) to install code-server for Linux and macOS.
A
Anmol Sethi 已提交
22

A
Anmol Sethi 已提交
23
It tries to use the system package manager if possible.
A
Anmol Sethi 已提交
24 25

First run to print out the install process:
C
Colin Adler 已提交
26 27

```bash
28
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
29
```
30

A
Anmol Sethi 已提交
31
Now to actually install:
32 33

```bash
A
Anmol Sethi 已提交
34
curl -fsSL https://code-server.dev/install.sh | sh
35 36
```

A
Anmol Sethi 已提交
37 38
The install script will print out how to run and start using code-server.

A
Anmol Sethi 已提交
39 40 41 42
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.

A
Anmol Sethi 已提交
43
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
44

A
Anmol Sethi 已提交
45 46
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).

A
Anmol Sethi 已提交
47
## FAQ
A
Asher 已提交
48

A
Anmol Sethi 已提交
49
See [./doc/FAQ.md](./doc/FAQ.md).
A
Asher 已提交
50

O
Onilton Maciel 已提交
51 52 53 54
## Contributing

See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).

K
Kyle Carberry 已提交
55
## Enterprise
56

A
v3.3.0  
Anmol Sethi 已提交
57
Visit [our website](https://coder.com) for more information about our
A
Anmol Sethi 已提交
58
enterprise offerings.