README.md 2.7 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

J
Joe Previte 已提交
3
![Lines](https://img.shields.io/badge/Coverage-40.7%25-green.svg)
4

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

J
Joe Previte 已提交
7
![Screenshot](./docs/assets/screenshot.png)
A
Anmol Sethi 已提交
8 9 10

## Highlights

11 12 13
- 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
14

A
Anmol Sethi 已提交
15
## Getting Started
16

17
There are two ways to get started:
18

19
1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible)
J
Joe Previte 已提交
20
2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases
A
Anmol Sethi 已提交
21

22
If you choose to use the install script, you can preview what occurs during the install process:
C
Colin Adler 已提交
23 24

```bash
25
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
26
```
27

28
To install, run:
29 30

```bash
A
Anmol Sethi 已提交
31
curl -fsSL https://code-server.dev/install.sh | sh
32 33
```

34
When done, the install script prints out instructions for running and starting code-server.
A
Anmol Sethi 已提交
35

J
Joe Previte 已提交
36
We also have an in-depth [setup and configuration](./docs/guide.md) guide.
37

J
JK 已提交
38
### Cloud Program ☁️
A
Anmol Sethi 已提交
39

A
v3.7.1  
Anmol Sethi 已提交
40
We're working on a cloud platform that makes deploying and managing code-server easier.
A
Anmol Sethi 已提交
41
Consider running code-server with the beta flag `--link` if you don't want to worry about
42

A
Anmol Sethi 已提交
43 44 45
- TLS
- Authentication
- Port Forwarding
46

47 48 49 50 51
```bash
$ code-server --link
Proxying code-server to Coder Cloud, you can access your IDE at https://valmar-jon.cdr.co
```

A
Anmol Sethi 已提交
52
## FAQ
A
Asher 已提交
53

J
Joe Previte 已提交
54
See [./docs/FAQ.md](./docs/FAQ.md).
A
Asher 已提交
55

56
## Want to help?
O
Onilton Maciel 已提交
57

J
Joe Previte 已提交
58
See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details.
O
Onilton Maciel 已提交
59

60 61
## Hiring

62 63
We ([@cdr](https://github.com/cdr)) are looking for engineers to help [maintain
code-server](https://jobs.lever.co/coder/e40becde-2cbd-4885-9029-e5c7b0a734b8), innovate on open source, and streamline dev workflows.
64

65
Our main office is in Austin, Texas. Remote is ok as long as
66
you're in North America or Europe.
67

68
Please get in [touch](mailto:jobs@coder.com) with your resume/GitHub if interested.
69

J
jae 已提交
70
## For Organizations
71

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