Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add about Remote - SSH for remote dev. #17430

Merged
merged 2 commits into from Mar 2, 2021
Merged

docs: Add about Remote - SSH for remote dev. #17430

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a0f4c2
docs: Document using VSCode Remote - SSH for remote dev.
Riken-Shah Mar 1, 2021
d21a5d0
docs: Fix formatting for rmate instructions.
timabbott Mar 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 23 additions & 15 deletions docs/development/remote.md
View file
Open in desktop
Expand Up @@ -181,32 +181,40 @@ you prefer for development in general.

If you use [TextMate](https://macromates.com), Atom, VS Code, or a
similar GUI editor, tools like
[VSCode Remote - SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh) and
[rmate](https://github.com/textmate/rmate) that are designed to
integrate that editor with remote development over SSH allow you to
develop remotely from the comfort of your local machine.

Similar packages/extensions exist for other popular code editors as
well; contributions of precise documentation for them are welcome!

To set up [rmate](https://github.com/textmate/rmate) for VS Code:
- [VSCode Remote - SSH][vscode-remote-ssh]: Lets you use Visual Studio
Code against a remote repository with a similar user experience to
developing locally.

[vscode-remote-ssh]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh

- [rmate](https://github.com/textmate/rmate) for TextMate + VS Code:
1. Install the extension
[Remote VSCode](https://marketplace.visualstudio.com/items?itemName=rafaelmaiolla.remote-vscode).
[Remote VSCode](https://marketplace.visualstudio.com/items?itemName=rafaelmaiolla.remote-vscode).
2. On your remote machine, run:
```
$ mkdir -p ~/bin
$ curl -Lo ~/bin/rmate https://raw.githubusercontent.com/textmate/rmate/master/bin/rmate
$ chmod a+x ~/bin/rmate
```
3. Make sure the remote server is running in VS Code (you can force-start through the Command Palette).
```
$ mkdir -p ~/bin
$ curl -Lo ~/bin/rmate https://raw.githubusercontent.com/textmate/rmate/master/bin/rmate
$ chmod a+x ~/bin/rmate
```
3. Make sure the remote server is running in VS Code (you can
force-start through the Command Palette).
4. SSH to your remote machine using
```
$ ssh -R 52698:localhost:52698 user@example.org
```
```
$ ssh -R 52698:localhost:52698 user@example.org
```
5. On your remote machine, run
```
$ rmate [options] file
```
and the file should open up in VS Code. Any changes you make now will be saved remotely.
```
$ rmate [options] file
```
and the file should open up in VS Code. Any changes you make now will be saved remotely.

##### Command line editors

Expand Down