README.md 1.8 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 22
### Quick Install

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

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

First run to print out the install process:
C
Colin Adler 已提交
28 29

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

A
Anmol Sethi 已提交
33
Now to actually install:
34 35

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

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

A
Anmol Sethi 已提交
41
### Manual Install
A
Anmol Sethi 已提交
42

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
## FAQ
A
Asher 已提交
46

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

O
Onilton Maciel 已提交
49 50 51 52
## Contributing

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

53 54 55
## Hiring

We're looking for an engineer to help maintain code-server and
A
Anmol Sethi 已提交
56
innovate on open source.
57 58 59 60 61 62

Our main office is in Austin, Texas. Remote is ok as long as
you're in Canada, the US, Australia or the UK.

Please get in [touch](mailto:anmol@coder.com) if interested.

K
Kyle Carberry 已提交
63
## Enterprise
64

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