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

9 10 11
- 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
12

A
Anmol Sethi 已提交
13
## Getting Started
14

15
There are two ways to get started:
16

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

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

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

26
To install, run:
27 28

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

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

34
We also have an in-depth [setup and configuration](./doc/guide.md) guide.
35

J
JK 已提交
36
### Cloud Program ☁️
A
Anmol Sethi 已提交
37

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

A
Anmol Sethi 已提交
41 42 43
- TLS
- Authentication
- Port Forwarding
44

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

A
Anmol Sethi 已提交
50
## FAQ
A
Asher 已提交
51

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

54
## Want to help?
O
Onilton Maciel 已提交
55

56
See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details.
O
Onilton Maciel 已提交
57

58 59
## Hiring

60 61
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.
62

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

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

J
jae 已提交
68
## For Organizations
69

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