Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liximomo/vscode-remote-fs
Working with any file in everywhere with vscode.
https://github.com/liximomo/vscode-remote-fs
Last synced: 4 days ago
JSON representation
Working with any file in everywhere with vscode.
- Host: GitHub
- URL: https://github.com/liximomo/vscode-remote-fs
- Owner: liximomo
- License: mit
- Created: 2018-05-09T11:52:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T20:39:06.000Z (about 2 years ago)
- Last Synced: 2024-12-11T08:41:28.644Z (13 days ago)
- Language: TypeScript
- Homepage:
- Size: 231 KB
- Stars: 169
- Watchers: 9
- Forks: 17
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Remote File System for VS Code
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BY89QD47D7MPS&source=url) [](https://paypal.me/liximomo)
Working with any file in everywhere like they are in local with vscode.
## Features
* Open remote from `code` CLI.
* Provide multiple schemes(sftp, ftp). More is coming!
* Password/Passphrase Prompting.
* Multiple remote folders at once.
## Setup
1. Open User Settings.
* On Windows/Linux - File > Preferences > Settings
* On macOS - Code > Preferences > Settings
2. Add your remote configs to "remotefs.remote" in your User Settings.
3. `Cmd+Shift+P` open command palette(`Ctrl+Shift+P` on Windows/Linux), run `Remote FS: Add Folder to Workspace` command.
4. Enjoy it😘!
## Config
```json
{
"remotefs.remote": {
"dev": {
"scheme": "sftp",
"host": "host",
"username": "username",
"rootPath": "/path/to/somewhere"
},
"site": {
"scheme": "ftp",
"host": "host",
"username": "username"
},
"projectX": {
"scheme": "sftp",
"host": "host",
"username": "username",
"privateKeyPath": "/Users/xx/.ssh/id_rsa",
"rootPath": "/home/foo/some/projectx"
}
}
}
```
You can find extra options with auto complete(Ctrl+Space)!
You can also see the full config [here](https://github.com/liximomo/vscode-remote-fs/wiki/config).
## CLI
Once you've config your remote in User Setting. You can open any remote from `code` CLI in your terminal.
### Usage
```
code --folder-uri ://[/path]
```
### Example
Setting:
```
{
"remotefs.remote": {
"test": {
"scheme": "ftp",
"host": "host",
"username": "username"
},
"projectX": {
"scheme": "sftp",
"host": "host",
"username": "username",
"privateKeyPath": "/Users/xx/.ssh/id_rsa",
"rootPath": "/home/foo/some/projectx"
}
}
}
```
Open projectX at `rootPath`（/home/foo/some/projectx）.
```
code --folder-uri sftp://projectX/
```
Open projectX at `rootPath/dirA` (/home/foo/some/projectx/dirA).
```
code --folder-uri sftp://projectX/dirA
```
Open test at `rootPath`.
```
code --folder-uri ftp://test/
```
---
## Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
### Wechat
### Alipay
### PayPal
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BY89QD47D7MPS&source=url) [](https://paypal.me/liximomo)