code-server/README.md

79 lines
2.8 KiB
Markdown
Raw Normal View History

2020-10-07 04:29:53 +07:00
# 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)
2019-01-08 07:46:19 +07:00
2020-05-18 03:53:08 +07:00
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
2019-03-06 08:45:21 +07:00
2020-05-22 09:16:16 +07:00
![Screenshot](./doc/assets/screenshot.png)
## Highlights
2020-05-23 02:38:03 +07:00
- **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.
2020-09-11 06:01:39 +07:00
- Preserve battery life when you're on the go as all intensive tasks run on your server.
2020-05-23 02:38:03 +07:00
- Make use of a spare computer you have lying around and turn it into a full development environment.
2020-05-18 07:47:33 +07:00
## Getting Started
2020-05-18 03:53:08 +07:00
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
2020-06-05 03:31:01 +07:00
### Quick Install
2020-06-13 21:56:50 +07:00
We have a [script](./install.sh) to install code-server for Linux, macOS and FreeBSD.
2020-05-22 10:53:02 +07:00
2020-05-22 09:16:16 +07:00
It tries to use the system package manager if possible.
2020-05-22 04:10:29 +07:00
First run to print out the install process:
2020-05-20 10:41:28 +07:00
```bash
2020-05-28 02:48:03 +07:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
```
2020-05-22 04:10:29 +07:00
Now to actually install:
```bash
2020-05-22 04:10:29 +07:00
curl -fsSL https://code-server.dev/install.sh | sh
```
2020-05-22 09:16:16 +07:00
The install script will print out how to run and start using code-server.
2020-06-05 03:31:01 +07:00
### Manual Install
2020-05-23 02:38:03 +07:00
2020-05-22 09:16:16 +07:00
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
2020-10-14 06:25:09 +07:00
### Alpha Program 🐣
2020-10-22 03:45:53 +07:00
2020-10-14 06:25:09 +07:00
We're working on a cloud platform to make deploying and managing code-server easier. If you don't want to worry about
2020-10-22 03:45:53 +07:00
- TLS
- Authentication
- Port Forwarding
2020-10-14 06:25:09 +07:00
consider [joining our alpha program](https://codercom.typeform.com/to/U4IKyv0W).
2020-02-19 07:07:01 +07:00
## FAQ
2020-02-19 07:07:01 +07:00
See [./doc/FAQ.md](./doc/FAQ.md).
2019-01-08 07:46:19 +07:00
2020-03-20 04:53:31 +07:00
## Contributing
See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).
2020-06-10 05:10:28 +07:00
## Hiring
2020-09-11 06:01:39 +07:00
We ([@cdr](https://github.com/cdr)) are looking for engineers to help maintain
code-server, innovate on open source and streamline dev workflows.
2020-06-10 05:10:28 +07:00
Our main office is in Austin, Texas. Remote is ok as long as
you're in North America or Europe.
2020-06-10 05:10:28 +07:00
2020-06-26 03:01:34 +07:00
Please get in [touch](mailto:jobs@coder.com) with your resume/github if interested.
2020-06-10 05:10:28 +07:00
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).
2020-07-30 00:37:19 +07:00
## For Organizations
2019-09-27 21:39:29 +07:00
2020-07-30 00:37:19 +07:00
Visit [our website](https://coder.com) for more information about remote development for your organization or enterprise.