#command-line-utility #scp-client #sftp-client #ftp-client #winscp

bin+lib termscp

TermSCP is a SCP/SFTP/FTPS client for command line with an integrated UI to explore the remote file system. Basically WinSCP on a terminal.

12 unstable releases (3 breaking)

new 0.4.2 Apr 13, 2021
0.4.1 Apr 7, 2021
0.4.0 Mar 27, 2021
0.3.3 Feb 28, 2021
0.1.3 Dec 14, 2020

#78 in Command line utilities

Download history 3/week @ 2020-12-25 5/week @ 2021-01-01 18/week @ 2021-01-08 32/week @ 2021-01-15 27/week @ 2021-01-22 6/week @ 2021-01-29 12/week @ 2021-02-05 34/week @ 2021-02-12 11/week @ 2021-02-19 23/week @ 2021-02-26 5/week @ 2021-03-05 3/week @ 2021-03-12 21/week @ 2021-03-19 39/week @ 2021-03-26 38/week @ 2021-04-02 25/week @ 2021-04-09

87 downloads per month

MIT license

1MB
17K SLoC

TermSCP

License: MIT Stars Downloads Crates.io Docs

Build Build Build

~ Basically, WinSCP on a terminal ~
Developed by Christian Visintin
Current version: 0.4.2 (13/04/2021)



About TermSCP ๐Ÿ–ฅ

TermSCP is basically a porting of WinSCP to terminal. So basically is a terminal utility with an TUI to connect to a remote server to retrieve and upload files and to interact with the local file system. It works both on Linux, MacOS, BSD and Windows and supports SFTP, SCP, FTP and FTPS.

Explorer


Why TermSCP ๐Ÿค”

It happens quite often to me, when using SCP at work to forget the path of a file on a remote machine, which forces me to connect through SSH, gather the file path and finally download it through SCP. I could use WinSCP, but I use Linux and I pratically use the terminal for everything, so I wanted something like WinSCP on my terminal. Yeah, I know there is midnight commander too, but actually I don't like it very much tbh (and hasn't a decent support for scp).

Features ๐ŸŽ

  • Different communication protocols support
    • SFTP
    • SCP
    • FTP and FTPS
  • Compatible with Windows, Linux, BSD and MacOS
  • Handy user interface to explore and operate on the remote and on the local machine file system
    • Create, remove, rename, search, view and edit files
  • Bookmarks and recent connections can be saved to access quickly to your favourite hosts
  • Supports text editors to view and edit text files
  • Supports both SFTP/SCP authentication through SSH keys and username/password
  • Customizations:
    • Custom file explorer format
    • Customizable text editor
    • Customizable file sorting
  • SSH key storage
  • Written in Rust
  • Easy to extend with new file transfers protocols
  • Developed keeping an eye on performance

Installation ๐Ÿ› 

If you're considering to install TermSCP I want to thank you ๐Ÿ’› ! I hope you will enjoy TermSCP!
If you want to contribute to this project, don't forget to check out our contribute guide. Read More

Cargo ๐Ÿฆ€

# Install termscp through cargo
cargo install termscp

Requirements:

  • Linux
    • pkg-config
    • libssh2
    • openssl

Deb package ๐Ÿ“ฆ

Get deb package from HERE or run wget https://github.com/veeso/termscp/releases/latest/download/termscp_0.4.2_amd64.deb

then install through dpkg:

dpkg -i termscp_*.deb
# Or even better with gdebi
gdebi termscp_*.deb

RPM package ๐Ÿ“ฆ

Get rpm package from HERE or run wget https://github.com/veeso/termscp/releases/latest/download/termscp-0.4.2-1.x86_64.rpm

then install through rpm:

rpm -U termscp_*.rpm

AUR Package ๐Ÿ”ผ

On Arch Linux based distribution, you can install termscp using for istance yay, which I recommend to install AUR packages.

yay -S termscp

Chocolatey ๐Ÿซ

You can install TermSCP on Windows using chocolatey

Start PowerShell as administrator and run

choco install termscp

Alternatively you can download the ZIP file from HERE

and then with PowerShell started with administrator previleges, run:

choco install termscp -s .

Brew ๐Ÿป

You can install TermSCP on MacOS using brew

From your terminal run

brew install veeso/termscp/termscp

Usage โ“

TermSCP can be started with the following options:

termscp [options]... [protocol://user@address:port:wrkdir] [local-wrkdir]

  • -P, --password <password> if address is provided, password will be this argument
  • -v, --version Print version info
  • -h, --help Print help page

TermSCP can be started in two different mode, if no extra arguments is provided, TermSCP will show the authentication form, where the user will be able to provide the parameters required to connect to the remote peer.

Alternatively, the user can provide an address as argument to skip the authentication form and starting directly the connection to the remote server.

If address argument is provided you can also provide the start working directory for local host

Address argument ๐ŸŒŽ

The address argument has the following syntax:

[protocol://][username@]<address>[:port][:wrkdir]

Let's see some example of this particular syntax, since it's very comfortable and you'll probably going to use this instead of the other one...

  • Connect using default protocol (defined in configuration) to 192.168.1.31, port if not provided is default for the selected protocol (in this case depends on your configuration); username is current user's name

    termscp 192.168.1.31
    
  • Connect using default protocol (defined in configuration) to 192.168.1.31; username is root

    termscp root@192.168.1.31
    
  • Connect using scp to 192.168.1.31, port is 4022; username is omar

    termscp scp://omar@192.168.1.31:4022
    
  • Connect using scp to 192.168.1.31, port is 4022; username is omar. You will start in directory /tmp

    termscp scp://omar@192.168.1.31:4022:/tmp
    

How Password can be provided ๐Ÿ”

You have probably noticed, that, when providing the address as argument, there's no way to provide the password. Password can be basically provided through 3 ways when address argument is provided:

  • -P, --password option: just use this CLI option providing the password. I strongly unrecommend this method, since it's very unsecure (since you might keep the password in the shell history)
  • Via sshpass: you can provide password via sshpass, e.g. sshpass -f ~/.ssh/topsecret.key termscp cvisintin@192.168.1.31
  • You will be prompted for it: if you don't use any of the previous methods, you will be prompted for the password, as happens with the more classics tools such as scp, ssh, etc.

Bookmarks โญ

In TermSCP it is possible to save favourites hosts, which can be then loaded quickly from the main layout of termscp. TermSCP will also save the last 16 hosts you connected to. This feature allows you to load all the parameters required to connect to a certain remote, simply selecting the bookmark in the tab under the authentication form.

Bookmarks will be saved, if possible at:

  • $HOME/.config/termscp/ on Linux/BSD
  • $HOME/Library/Application Support/termscp on MacOs
  • FOLDERID_RoamingAppData\termscp\ on Windows

For bookmarks only (this won't apply to recent hosts) it is also possible to save the password used to authenticate. The password is not saved by default and must be specified through the prompt when saving a new Bookmark.

I was very undecided about storing passwords in termscp. The reason? Saving a password on your computer might give access to a hacker to any server you've registered. But I must admit by myself that for many machines typing the password everytime is really boring, also many times I have to work with machines in LAN, which wouldn't provide any advantage to an attacker, So I came out with a good compromise for passwords.

I warmly suggest you to follow these guidelines in order to decide whether you should or you shouldn't save passwords:

  • DON'T save passwords for machines which are exposed on the internet, save passwords only for machines in LAN
  • Make sure your machine is protected by attackers. If possible encrypt your disk and don't leave your PC unlocked while you're away.
  • Preferably, save passwords only when a compromising of the target machine wouldn't be a problem.

To create a bookmark, just fulfill the authentication form and then input <CTRL+S>; you'll then be asked to give a name to your bookmark, and tadah, the bookmark has been created. If you go to gallery, there is a GIF showing how bookmarks work ๐Ÿ’ช.

Are my passwords Safe ๐Ÿ˜ˆ

Well, kinda. As said before, bookmarks are saved in your configuration directory along with passwords. Passwords are obviously not plain text, they are encrypted with AES-128. Does this make them safe? Well, depends on your operating system:

On Windows and MacOS the passwords are stored, if possible (but should be), in respectively the Windows Vault and the Keychain. This is actually super-safe and is directly managed by your operating system.

On Linux and BSD, on the other hand, the key used to encrypt your passwords is stored on your drive (at $HOME/.config/termscp). It is then, still possible to retrieve the key to decrypt passwords. Luckily, the location of the key guarantees your key can't be read by users different from yours, but yeah, I still wouldn't save the password for a server exposed on the internet ๐Ÿ˜‰. Actually keyring-rs, supports Linux, but for different reasons I preferred not to make it available for this configuration. If you want to read more about my decision read this issue, while if you think this might have been implemented differently feel free to open an issue with your proposal.


Text Editor โœ

TermSCP has, as you might have noticed, many features, one of these is the possibility to view and edit text file. It doesn't matter if the file is located on the local host or on the remote host, termscp provides the possibility to open a file in your favourite text editor. In case the file is located on remote host, the file will be first downloaded into your temporary file directory and then, only if changes were made to the file, re-uploaded to the remote host. TermSCP checks if you made changes to the file verifying the last modification time of the file.

Just a reminder: you can edit only textual file; binary files are not supported.

How do I configure the text editor ๐Ÿฆฅ

Text editor is automatically found using this awesome crate, if you want to change the text editor to use, change it in termscp configuration. View more


Configuration โš™๏ธ

TermSCP supports some user defined parameters, which can be defined in the configuration. Underhood termscp has a TOML file and some other directories where all the parameters will be saved, but don't worry, you won't touch any of these files, since I made possible to configure termscp from its user interface entirely.

termscp, like for bookmarks, just requires to have these paths accessible:

  • $HOME/.config/termscp/ on Linux/BSD
  • $HOME/Library/Application Support/termscp on MacOs
  • FOLDERID_RoamingAppData\termscp\ on Windows

To access configuration, you just have to press <CTRL+C> from the home of termscp.

These parameters can be changed:

  • Default Protocol: the default protocol is the default value for the file transfer protocol to be used in termscp. This applies for the login page and for the address CLI argument.
  • Text Editor: the text editor to use. By default termscp will find the default editor for you; with this option you can force an editor to be used (e.g. vim). Also GUI editors are supported, unless they nohup from the parent process so if you ask: yes, you can use notepad.exe, and no: Visual Studio Code doesn't work.
  • Show Hidden Files: select whether hidden files shall be displayed by default. You will be able to decide whether to show or not hidden files at runtime pressing A anyway.
  • Check for updates: if set to yes, termscp will fetch the Github API to check if there is a new version of termscp available.
  • Group Dirs: select whether directories should be groupped or not in file explorers. If Display first is selected, directories will be sorted using the configured method but displayed before files, viceversa if Display last is selected.

SSH Key Storage ๐Ÿ”

Along with configuration, termscp provides also an essential feature for SFTP/SCP clients: the SSH key storage.

You can access the SSH key storage, from configuration moving to the SSH Keys tab, once there you can:

  • Add a new key: just press <CTRL+N> and you will be prompted to create a new key. Provide the hostname/ip address and the username associated to the key and finally a text editor will open up: paste the PRIVATE ssh key into the text editor, save and quit.
  • Remove an existing key: just press <DEL> or <CTRL+E> on the key you want to remove, to delete persistently the key from termscp.
  • Edit an existing key: just press <ENTER> on the key you want to edit, to change the private key.

Q: Wait, my private key is protected with password, can I use it?
A: Of course you can. The password provided for authentication in termscp, is valid both for username/password authentication and for RSA key authentication.

File Explorer Format

It is possible through configuration to define a custom format for the file explorer. This field, with name File formatter syntax will define how the file entries will be displayed in the file explorer. The syntax for the formatter is the following {KEY1}... {KEY2:LENGTH}... {KEY3:LENGTH:EXTRA} {KEYn}.... Each key in bracket will be replaced with the related attribute, while everything outside brackets will be left unchanged.

  • The key name is mandatory and must be one of the keys below
  • The length describes the length reserved to display the field. Static attributes doesn't support this (GROUP, PEX, SIZE, USER)
  • Extra is supported only by some parameters and is an additional options. See keys to check if extra is supported.

These are the keys supported by the formatter:

  • ATIME: Last access time (with default syntax %b %d %Y %H:%M); Extra might be provided as the time syntax (e.g. {ATIME:8:%H:%M})
  • CTIME: Creation time (with syntax %b %d %Y %H:%M); Extra might be provided as the time syntax (e.g. {CTIME:8:%H:%M})
  • GROUP: Owner group
  • MTIME: Last change time (with syntax %b %d %Y %H:%M); Extra might be provided as the time syntax (e.g. {MTIME:8:%H:%M})
  • NAME: File name (Elided if longer than 24)
  • PEX: File permissions (UNIX format)
  • SIZE: File size (omitted for directories)
  • SYMLINK: Symlink (if any -> {FILE_PATH})
  • USER: Owner user

If left empty, the default formatter syntax will be used: {NAME:24} {PEX} {USER} {SIZE} {MTIME:17:%b %d %Y %H:%M}


Keybindings โŒจ

Key Command Reminder
<ESC> Disconnect from remote; return to authentication page
<TAB> Switch between log tab and explorer
<BACKSPACE> Go to previous directory in stack
<RIGHT> Move to remote explorer tab
<LEFT> Move to local explorer tab
<UP> Move up in selected list
<DOWN> Move down in selected list
<PGUP> Move up in selected list by 8 rows
<PGDOWN> Move down in selected list by 8 rows
<ENTER> Enter directory
<SPACE> Upload / download selected file
<A> Toggle hidden files All
<B> Sort files by Bubblesort?
<C> Copy file/directory Copy
<D> Make directory Directory
<E> Delete file (Same as DEL) Erase
<F> Search for files (wild match is supported) Find
<G> Go to supplied path Go to
<H> Show help Help
<I> Show info about selected file or directory Info
<L> Reload current directory's content List
<N> Create new file with provided name New
<O> Edit file; see Text editor Open
<Q> Quit TermSCP Quit
<R> Rename file Rename
<S> Save file as... Save
<U> Go to parent directory Upper
<X> Execute a command eXecute
<DEL> Delete file
<CTRL+C> Abort file transfer process

Documentation ๐Ÿ“š

The developer documentation can be found on Rust Docs at https://docs.rs/termscp


Known issues ๐Ÿงป

  • NoSuchFileOrDirectory on connect (WSL): I know about this issue and it's a glitch of WSL I guess. Don't worry about it, just move the termscp executable into another PATH location, such as /usr/bin, or install it through the appropriate package format (e.g. deb).

Upcoming Features ๐Ÿงช

  • Themes provider ๐ŸŽจ: I'm still thinking about how I will implement this, but basically the idea is to have a configuration file where it will be possible to define the color schema for the entire application. I haven't planned this release yet
  • Local and remote file explorer format ๐Ÿƒ: From 0.5.0 you will be able to customize the file format for both local and remote hosts.
  • Synchronized browsing of local and remote directories โŒš: See Issue 8
  • Group file select ๐Ÿคฉ: Possibility to select a group of files in explorers to operate on

No other new feature is planned at the moment. I actually think that termscp is getting mature and now I should focus upcoming updates more on bug fixing and code/performance improvements than on new features. Anyway there are some ideas which I'd like to implement. If you want to start working on them, feel free to open a PR:

  • Amazon S3 support
  • Samba support
  • Themes provider

Contributing and issues ๐Ÿค๐Ÿป

Contributions, bug reports, new features and questions are welcome! ๐Ÿ˜‰ If you have any question or concern, or you want to suggest a new feature, or you want just want to improve termscp, feel free to open an issue or a PR.

Please follow our contributing guidelines


Changelog โณ

View TermSCP's changelog HERE


Powered by ๐Ÿš€

TermSCP is powered by these aweseome projects:


Gallery ๐ŸŽฌ

Termscp Home

Auth

Bookmarks

Bookmarks

Setup

Setup

Text editor

TextEditor


Buy me a coffee โ˜•

If you like termscp and you'd love to see the project to grow, please consider a little donation ๐Ÿฅณ

Buy-me-a-coffee


License ๐Ÿ“ƒ

termscp is licensed under the MIT license since version 0.4.0.

You can read the entire license HERE

Older version (0.1.0 ~ 0.3.3) are licensed under the GPL-V3 license

Dependencies

~16MB
~356K SLoC