sprdp / remote-browser Goto Github PK

View Code? Open in Web Editor NEW

22.0 4.0 3.0 905 KB

A remote file explorer extension for VSCode.

License: MIT License

TypeScript 100.00%

vsode sftp

remote-browser's Introduction

remote-browser

A lightweight extension that allows you to browse and edit remote files over SFTP.

Features

Explorer-like view of any directory on a remote machine
Simple browsing interface separate from your current workspace.
Edit files locally and automatically sync them on save.
Supports multiple authentication modes.

Usage

set remoteBrowser.connectionOptions in User Settings
If passwordless auth is not available/not successful, you will be prompted for a password.

Extension Commands

Connect: Connect to remote machine.
Disconnect: Disconnect from remote machine.
Change Path: Change root path on the remote machine. Default root is the User's $HOME.

Extension Settings

remoteBrowser.connectionOptions: supports a subset of ssh2:ConnectConfig opts from the ssh2 library.
Example Config:

    "remoteBrowser.connectionOptions": {
        "host": "12.34.56.78",  // MANDATORY
        "username": "remoteuser", // MANDATORY
        "privateKey": "C:/Users/myuser/.ssh/id_rsa",  // Path to private key on local machine
        "localHostname": "myhost",
        "localUsername": "myuser",   // Identify as myuser@myhost
        "defaultPath": "/usr/local/bin" // Default directory to start in on connect (Absolute path)
    },
    // Optional array to configure additional connections 
    "remoteBrowser.additionalConnections": [{
        "host": "12.34.56.79",  
        "username": "remoteuser2", 
    }],

remoteBrowser.tmpFolder: Path to emporary folder for storing downloaded files

See the User Settings file for more info.

Notes

The extenstion relies on ssh2-sftp-client for remote connections.
Depending on your workflow, the extension is most effective when used along with an ssh client running in the terminal. Even better if you also use remote-vscode.

Roadmap

Tests
More Sort options.
Multiple server configurations.
Improved filtering.
More robust error handling

Contributing

Feel free to open an issue or drop a pull request!

Release Notes

0.7

Bottom status bar now displays file saving status.
Added a defaultPath option which specifies a default directory to cd into on initial connect.

0.6

Added support for multiple connections.
Fixed issue of password prompt being undismissable.
Fixed issue of files of the same name in different folders being considered the same.

0.5.6

Bug fixes. Thanks to @ronsano

0.5.5

Adds large file support. Thanks to @kimulimuli

0.5.3

Added a default sort - Folders first and alphabetical.
Added a filter option that allows filtering the current root folder by specifying a regex to test all filenames for. Might change this to a glob in the future.

0.5.2

Added context menu option - Make root (Use on any subdirectory to make it the new root for the explorer tree)
Fixed Bug where the '..'back option wasn't getting updated on root change.

0.5.1

Changed privateKey connection option to be a file path instead of an actual key string.
Fixed config file not being read after initialization.

0.5.0

Initial release

remote-browser's People

Contributors

Stargazers

Watchers

Forkers

kimulimuli udplus jackiotyu

remote-browser's Issues

"Error: check console" but there's no console

When I try to connect I get a notification saying "remote-browser : Error in connection. Check console for details" but I can't find any console output anywhere to find any details.

Meke root error

Hello! why i cant make root command?
Use ftp. Click right button on remote folder and choise make root. Always get this error:
https://yadi.sk/i/kYPKGCrWmvDyDQ

command 'remoteBrowser.connect' not found

Quite simply, when I try to use the remote-browser: Connect command I get a error command 'remoteBrowser.connect' not found.

Uninstalling and installing again does not change anything.

OSX Sierra (10.12.6 (16G1510))
VSCode is 1.25.1 (1dfc5e557209371715f655691b1235b6b26a06be)

Text within files are duplicated when opened via Remote Browser

When I open a file on a server via remote-browser the text within the file is duplicated.
For example if there is a text file that has the text:

This is a test.

If the file is opened via remote-browser, it opens as:

This is a test. This is a test.

OS: Windows 10 Version 1803 (OS Build 17134.590)
Visual Studio Code: Version 1.32.1

Passphrase not asked for encrypted private Key

remote-browser ERROR: Error: Encrypted private key detected, but no passphrase given

How can i set the passphrase, i just get not asked for it?

I update thr vscode to 1.31.0, i can connect the remote device.
But when i click the file in 'remote-browser',it just open a empty file with the correct file name and path.
I don't konw it's my problem or something else.

Empty files cannot be opened

Issue opening empty files while connect to remote

Remote File Not Fully Loaded

When selecting a large file in the 'REMOTE BROWSER' view only a portion of the file is loaded in the editor. Expectation is that the full file is loaded or if the file is to large that a suitable warning is displayed indicating that the entire file could not be loaded. Only 64K of the file is transferred to the local temp folder.

Using remote-browser 0.5.4 in VS Code 1.24.1

Same name file problem

When I open a remote file like a/a.txt and b/a,txt ,it just has one tab open and it may rewrite the file in the remote.
It would be nice to open a new tab when opening a different path and same name file

command 'remoteBrowser.filter' not found

After an recent High Sierra update borked my sshfs set up, I am trying to get your remote browser to serve a similar function, but I keep getting the following error.

command 'remoteBrowser.filter' not found.

Thoughts?