Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coder/sshcode
Run VS Code on any server over SSH.
https://github.com/coder/sshcode
Last synced: 3 months ago
JSON representation
Run VS Code on any server over SSH.
- Host: GitHub
- URL: https://github.com/coder/sshcode
- Owner: coder
- License: mit
- Archived: true
- Created: 2019-04-18T19:09:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-10T18:36:45.000Z (over 4 years ago)
- Last Synced: 2024-04-15T07:16:44.324Z (8 months ago)
- Language: Go
- Homepage:
- Size: 780 KB
- Stars: 5,744
- Watchers: 80
- Forks: 231
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - coder/sshcode - Run VS Code on any server over SSH. (Go)
README
# sshcode
**This project has been deprecated in favour of the [code-server install script](https://github.com/cdr/code-server#quick-install)**
**See the discussion in [#185](https://github.com/cdr/sshcode/issues/185)**
---
[](https://github.com/cdr/sshcode/issues)
[](https://github.com/cdr/sshcode/releases/latest)
[](https://github.com/cdr/sshcode/blob/master/LICENSE)
[](https://discord.gg/zxSwN8Z)
[](https://travis-ci.org/cdr/sshcode)
`sshcode` is a CLI to automatically install and run [code-server](https://github.com/cdr/code-server) over SSH.
It uploads your extensions and settings automatically, so you can seamlessly use
remote servers as [VS Code](https://code.visualstudio.com) hosts.
If you have Chrome installed, it opens the browser in app mode. That means
there's no keybind conflicts, address bar, or indication that you're coding within a browser.
**It feels just like native VS Code.**
## Install
**Have Chrome installed for the best experience.**
Install with `go`:
```bash
go get -u go.coder.com/sshcode
```
Or, grab a [pre-built binary](https://github.com/cdr/sshcode/releases).
### OS Support
We currently support:
- Linux
- MacOS
- WSL
For the remote server, we currently only support Linux `x86_64` (64-bit)
servers with `glibc`. `musl` libc (which is most notably used by Alpine Linux)
is currently not supported on the remote server:
[#122](https://github.com/cdr/sshcode/issues/122).
## Usage
```bash
sshcode [email protected]
# Starts code-server on dev.kwc.io and opens in a new browser window.
```
You can specify a remote directory as the second argument:
```bash
sshcode [email protected] "~/projects/sourcegraph"
```
## Extensions & Settings Sync
By default, `sshcode` will `rsync` your local VS Code settings and extensions
to the remote server every time you connect.
This operation may take a while on a slow connections, but will be fast
on follow-up connections to the same server.
To disable this feature entirely, pass the `--skipsync` flag.
### Custom settings directories
If you're using an alternate release of VS Code such as VS Code Insiders, you
must specify your settings directories through the `VSCODE_CONFIG_DIR` and
`VSCODE_EXTENSIONS_DIR` environment variables.
The following will make `sshcode` work with VS Code Insiders:
**MacOS**
```bash
export VSCODE_CONFIG_DIR="$HOME/Library/Application Support/Code - Insiders/User"
export VSCODE_EXTENSIONS_DIR="$HOME/.vscode-insiders/extensions"
```
**Linux**
```bash
export VSCODE_CONFIG_DIR="$HOME/.config/Code - Insiders/User"
export VSCODE_EXTENSIONS_DIR="$HOME/.vscode-insiders/extensions"
```
### Sync-back
By default, VS Code changes on the remote server won't be synced back
when the connection closes. To synchronize back to local when the connection ends,
pass the `-b` flag.