UNPKG

code-server

Version:

Run VS Code on a remote server.

github.com/coder/code-server

coder/code-server

83 lines (56 loc) • 3.35 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# code-server [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/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://coder.com/community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) [![Discord](https://img.shields.io/discord/747933592273027093)](https://discord.com/invite/coder) [![codecov](https://codecov.io/gh/coder/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/coder/code-server) [![See latest](https://img.shields.io/static/v1?label=Docs&message=see%20latest&color=blue)](https://coder.com/docs/code-server/latest) Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. ![Screenshot](./assets/screenshot-1.png) ![Screenshot](./assets/screenshot-2.png) ## Highlights - 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 ## Requirements See [requirements](https://coder.com/docs/code-server/latest/requirements) for minimum specs, as well as instructions on how to set up a Google VM on which you can install code-server. **TL;DR:** Linux machine with WebSockets enabled, 1 GB RAM, and 2 vCPUs ## Getting started There are five ways to get started: 1. Using the [install script](https://github.com/coder/code-server/blob/main/install.sh), which automates most of the process. The script uses the system package manager if possible. 2. Manually [installing code-server](https://coder.com/docs/code-server/latest/install) 3. Deploy code-server to your team with [coder/coder](https://cdr.co/coder-github) 4. Using our one-click buttons and guides to [deploy code-server to a cloud provider](https://github.com/coder/deploy-code-server) ⚡ 5. Using the [code-server feature for devcontainers](https://github.com/coder/devcontainer-features/blob/main/src/code-server/README.md), if you already use devcontainers in your project. If you use the install script, you can preview what occurs during the install process: ```bash curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run ``` To install, run: ```bash curl -fsSL https://code-server.dev/install.sh | sh ``` When done, the install script prints out instructions for running and starting code-server. > **Note** > To manage code-server for a team on your infrastructure, see: [coder/coder](https://cdr.co/coder-github) We also have an in-depth [setup and configuration](https://coder.com/docs/code-server/latest/guide) guide. ## Questions? See answers to [frequently asked questions](https://coder.com/docs/code-server/latest/FAQ). ## Want to help? See [Contributing](https://coder.com/docs/code-server/latest/CONTRIBUTING) for details. ## Hiring Interested in [working at Coder](https://coder.com/careers)? Check out [our open positions](https://coder.com/careers#openings)! ## For Teams We develop [coder/coder](https://cdr.co/coder-github) to help teams to adopt remote development.