SSH-Panel

This Sublime Text plugin allow you to browse and edit files on SSH servers

servers that support any openssh available

此处中文文档

Multiple connections	Status infomation

File Operation	Icon adaptation

File Navigation	SSH interactive terminal

Installation

1. Install Package

• Use Package Control(recommend)

Open Command Panel Select Package Control: install and type "SSH-Panel" to Install

• or manual install

download project zip file and extract to "{package path}/SSH-Panel"

2. Install dependency (very important)

if Linux,need libffi

# if Debian / Ubuntu
sudo apt-get install libffi-dev
# if Fedora / CentOS / RHEL
sudo yum install libffi-devel
# if Arch / Manjaro `untest`
sudo pacman -S libffi
# if Opensuse `untest`
sudo zypper install libffi-devel

if MAC/Apple Silicon,need libffi

# you can install from Homebrew
brew install libffi
# Since brew does not add a default search path for downloaded files, a link is required
# link libffi.dylib to /usr/local/lib/
sudo ln -s $(brew --prefix libffi)/lib/libffi.dylib /usr/local/lib/libffi.dylib
# or link to ~/lib
# mkdir -p ~/lib
# ln -s $(brew --prefix libffi)/lib/libffi.dylib ~/lib/libffi.dylib

Due to the influence of the MacOS SIP mechanism, it may not be possible to create a link in paths such as /usr/lib. In order to enable libffi.dylib to be loaded correctly by Sublime Text, you can also use install_name_tool to replace @rapth, if the above methods fail to work ,please try the following method:

# step 1
# install libffi from Homebrew
brew install libffi
ls -al $(brew --prefix libffi)/lib/libffi.8.dylib # check install
# install Xcode Command Line Tools
xcode-select --install
xcode-select -p # check install
install_name_tool -help

# step 2
# running ssh_panel_install_dependencies command in sublime_text console

# step 3
# Locate the directory where _cffi_backend.cpython-38-darwin.so is located and enter it
cd "~/Library/Application Support/Sublime Text"
cd $(dirname $(find . -name "_cffi_backend.cpython-38-darwin.so" | head -1))

# step 4
cp $(brew --prefix libffi)/lib/libffi.8.dylib .
install_name_tool -change @rpath/libffi.8.dylib @loader_path/libffi.8.dylib ./_cffi_backend.cpython-38-darwin.so

# step 5
# restart sublime text

install python library

• auto install with ssh_panel_install_dependencies(recommend) open console and exec window.run_command('ssh_panel_install_dependencies'),it will automatically install the required dependencies

you can choose download source from github(default) or gitee

window.run_command('ssh_panel_install_dependencies',args={"source":"github"}) # download from https://gitee.com/Haiquan27/SSH-Panel-doc-annex/releases/download/public/
window.run_command('ssh_panel_install_dependencies',args={"source":"gitee"})  # download from https://gitee.com/Haiquan27/SSH-Panel-doc-annex/releases/download/public/

• or manual install

1. download this projectlocally
2. Select the required file and copy it to the corresponding loading path of sublime text based on your system platform and sublime text version

3. restart sublime text

Settings

Setup service connect parameter

open command palette and select SSH-Panel: Edit Settings command to edit settings file

parameter description:

• default_connect_settings All connect use default parameter values
• server_settings Specify preferences for connections

path:

• remote_path The path on the remote host. You can use the environment variable of the remote host ,like "$HOME" or "%userprofile%",value is path name or path list

  Each remote root path will be mapped to the subdirectory of local_path. The subdirectory name is the summary string generated by the path name

• local_path Local directory for synchronization,if empty will automatically generated in the user's home directory.can use the local environment variable

string "{auto_generate}" will be replaced with the UUID string generated from configuration and timestamp to generate a unique UUID path
After the first connection, this path will be save to the user configuration and using at next connection

connect and authentication:

• network_timeout The number of timeout seconds used to authenticate and connect to the remote host
• port SSH service port of remote host,default is 22
• sftp_shell Configure whether the session supports shell
  • When the connection is complete, we will try to execute "echo ~" to the sftp shell. The return result will determine the OS platform of the target server to ensure the correct path delimiter is set, and the values of the environment variables will also be obtained through the "env" command
  • When shell permissions are disabled in an SFTP session, if 'sftp_sthell' is true, it will consume a timeout of shell failures when connecting and obtain user ID
  • Set 'sftp_sthell' to false to avoid this situation, and the path delimiter setting will no longer depend on the shell and the environment variables used in 'remote_path' will be unavailable
• known_hosts_file know_hosts file path at local,if filled it will:
  • use the host key algorithm recorded in known_hosts_file when connecting
  • if host not recorded in known_hosts_file, confirm whether to add and save the host public_key when connecting
  • warn and force close connect when public_key obtained from remote host not matches public_key recorded in known_host_file
• username user name on remote host
• hostname remote host IP address or domain name
• always_fingerprint_confirm confirm server fingerprint every time,if known_hosts_file is set wile use AA to verify the host fingerprint
• jump_host connect with jump host like [ssh -J] If used, the value must be a key in server_settings; otherwise, set ""

Connect to jump host and then establishing a TCP forwarding to the ultimate destination from there

• keepalive Server Alive Interval (second)

if your server uses password authentication,option is:

• password password plaintext
• save_password save password plaintext in settings file,if is false the password will be deleted in the settings after connecting

if your server uses private and public_key authentication,option is:

• private_key used to set the encryption method and private key path when logged in to the server with the key
  • key algorithm available "RSAKey","ECDSAKey","Ed25519Key"
  • You can directly specify it using the key path, for example "private_key":"~/.ssh/id_rsa",The key type will be automatically detected
  • Or explicitly specify this item with a list of 2 elements like [{RSAKey/ECDSAKey/Ed25519Key},{private key path}]
  • !! if you sublime version < 4000 the command to generate the key must contain the [-m PEM] parameter or use a tool to convert the existing private key file format
• "need_passphrase" tells the plug-in whether a passphrase is set when generating a key pair, value is bool

if your server uses gssapi authentication,option is:

• gss_host remote host IP address or domain name,if used, the hostname option is not used
• gss_auth enable gss authentication ,valus is bool
• gss_kex enable gss kex,valus is bool
• gss_deleg_creds gss deleg creds
• gss_trust_dns gss trust dns

miscellaneous

• umask *nix file system umask for Add File and Add Folder
• terminus_encoding The character encoding of the terminal, for example, when the remote host is Windows, set this option to the commonly used language character encoding in the region. Please select the character encoding based on the CHCP code see details
• new_window open new window when connect created
• reconnect_on_start whether to automatically open the last closed connection when starting sublime text
• style_css Custom CSS Style,value is sublime resource,default is Packages/SSH-Panel/style.css see details
• file_reload Execute file synchronization,chiose from auto | always | never
  • auto if file already get in local,it not will be load afterwards,or else it will be loaded once
  • always whenever a file is clicked,always be reload
  • never never reload file,even when clicked
• icon_style Icon style displayed in front of a directory or file,value is choice in emjio | none | image
• icon_theme if "icon_style":"image",this value represents the path of the theme package where the icon is located,Example:
  • "Packages/" Match from all path
  • "Packages/Theme - Default/" Match within a specific Theme path
  • "Packages/A File Icon/icons/color" if A File Icon already installed,color icons can be used
  • "Packages/A File Icon/icons/mono" if A File Icon already installed,mono icons can be used
• icon_quality if "icon_style":"image",This value is used to specify the resolution prefix used by the displayed icon, which is generally defined before the icon file name in most theme packs,chiose from "" | "@2x" | "@3x"
• icon_color if "icon_style":"image",this value is used to specify the color of icons for general files and directories,but it will not affect the icons in the theme pack,chiose from "blue" | "green" | "white" | "yellow" | "gray"
• nav_bar_color_offset change color of the directory panel,value range is -16777215~+16777215(-0xffffff~+0xffffff) type is string,this value will be added with the RGB color of the current view background to get a new RGB color，used to distinguish the display of navigation panel views

  if you not want to change the background color value can be set to "0"

• quiet_log the pop-up message panel is not displayed immediately when a message is obtained
• debug_mode Debug enable switch

Example

"server_settings":{
	// Connect Debian Linux,use password
	"Debian_test":{
		"username":"root",
		"hostname":"192.168.1.100",
		"password":"",
		"save_password":false,
		"remote_path":[ // Add multiple paths
			"$HOME/Project", // remote system variables
			"/var/log"
		],
		"local_path":"~/SFTP-Local/{auto_generate}"
		// ...
	},
	// Connect Ubuntu Linux，ssh port is 2244
	// Use RSA key authentication
	// Specify local synchronization path
	"Ubuntu":{
		"username":"test",
		"hostname":"TestServer", // NetBIOS / DNS Name
		"port":2244,
		"private_key":"~/.ssh/id_rsa",
		// "private_key":["RSAKey","~/.ssh/id_rsa"], // explicitly specify
		"need_passphrase":false,
		"remote_path":[
			"/etc/apache2"
		],
		"local_path":"~/SFTP-Local/Ubuntu" // specially designated
		// ...
	},
	// Connect Windows Server 2016
	// Use Password
	// Save Password
	"Windows Server 2016":{
		"username":"Administrator",
		"hostname":"192.168.1.120",
		"password":"pasSSssswd@#120120",
		"save_password":true,
		"terminus_encoding":"GB2312" // terminal character encoding
		"remote_path":"D:\\Project" // support string path
		"local_path":"~/SFTP-Local/{auto_generate}"
	}
	// Connect with jump host
	"Windows Server 2016 [with jump_host]":{
		"username":"Administrator",
		"hostname":"192.168.1.120",
		"password":"pasSSssswd@#120120",
		"save_password":true,
		"jump_host": "Debian_test" // Use the name already defined in server_settings
		"terminus_encoding":"GB2312"
		"remote_path":"D:\\Project"
		"local_path":"~/SFTP-Local/{auto_generate}"
	}
	// ...
},

Using

open command palette and select SSH-Panel: Connect Server command

after select you server name to connect

you can edit and view server information on the pop-up directory panel

quick button:

Click the ip@username at the top of the navigation view to show quick button

• [?] :Help
• [I] :show server Infomation
• [R] :Refresh and sync file list
• [E] :Edit settings
• [N] :path Navigator
• [P] :show status Panel
• [T] :pseudo Terminal
• [$] :SSH interactive terminal(need installed Terminus)
• [+] :add new root path
• [x] :remove root path from view
• [...] or ☰ button on the right side of the directory or file to view attribute, delete or create a new one

Style coustom

you can set style_css option to control display in HTML style of output_panel and navigation_view

Create file "Packages\User\SSH-Panel\style.css" in sublime package path and set "style_css":"Packages\User\SSH-Panel\style.css"

css class

<!-- the following class will be load -->
<!-- The available syntax rules follow https://www.sublimetext.com/docs/minihtml.html -->
.keyword{}
.keyword_error{}
.symbol{}
.title_bar{}
.res_dir{}
.res_file{}
.res_focus{}
.operation_menu{}
.res_link{}
.res_link_error{}
.warning{}
.error{}
.info{}
.debug{}
.no_accessible{}

Terminus encoding

Feedback

welcome report issues and commit code.

if you like this can give me star :)