README.md 2.5 KB
Newer Older
B
Ben Potter 已提交
1
# code-server · [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
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
- **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.
14
  - Preserve battery life when you're on the go as all intensive tasks run on your server.
A
Anmol Sethi 已提交
15
  - 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

23
We have a [script](./install.sh) to install code-server for Linux, macOS and FreeBSD.
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
## Hiring

55
We ([@cdr](https://github.com/cdr)) are looking for engineers to help maintain
56 57
code-server, innovate on open source and streamline dev workflows.

58
Our main office is in Austin, Texas. Remote is ok as long as
59
you're in North America or Europe.
60

K
Kyle Carberry 已提交
61
Please get in [touch](mailto:jobs@coder.com) with your resume/github if interested.
62

63 64 65
We're also hiring someone specifically to help maintain code-server.
See the listing [here](https://jobs.lever.co/coder/e40becde-2cbd-4885-9029-e5c7b0a734b8).

J
jae 已提交
66
## For Organizations
67

J
jae 已提交
68
Visit [our website](https://coder.com) for more information about remote development for your organization or enterprise.