/termscp

๐Ÿ–ฅ A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3/SMB

Primary LanguageRustMIT LicenseMIT

termscp

~ A feature rich terminal file transfer ~

Website ยท Installation ยท User manual

English   Deutsch   Espaรฑol   Franรงais   Italiano   ็ฎ€ไฝ“ไธญๆ–‡

Developed by @veeso

Current version: 0.12.0 (16/05/2023)

License-MIT Repo stars Downloads counter Latest version Ko-fi

Linux CI MacOS CI Windows CI Coveralls


About termscp ๐Ÿ–ฅ

Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/S3. 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 is Linux, MacOS, FreeBSD, NetBSD and Windows compatible.

Explorer


Features ๐ŸŽ

  • ๐Ÿ“ Different communication protocols
    • SFTP
    • SCP
    • FTP and FTPS
    • S3
    • SMB
  • ๐Ÿ–ฅ Explore and operate on the remote and on the local machine file system with a handy UI
    • Create, remove, rename, search, view and edit files
  • โญ Connect to your favourite hosts through built-in bookmarks and recent connections
  • ๐Ÿ“ View and edit files with your favourite applications
  • ๐Ÿ’ SFTP/SCP authentication with SSH keys and username/password
  • ๐Ÿง Compatible with Windows, Linux, FreeBSD, NetBSD and MacOS
  • ๐ŸŽจ Make it yours!
    • Themes
    • Custom file explorer format
    • Customizable text editor
    • Customizable file sorting
    • and many other parameters...
  • ๐Ÿ“ซ Get notified via Desktop Notifications when a large file has been transferred
  • ๐Ÿ”ญ Keep file changes synchronized with the remote host
  • ๐Ÿ” Save your password in your operating system key vault
  • ๐Ÿฆ€ Rust-powered
  • ๐Ÿ‘€ Developed keeping an eye on performance
  • ๐Ÿฆ„ Frequent awesome updates

Get started ๐Ÿš€

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.

If you are a Linux, a FreeBSD or a MacOS user this simple shell script will install termscp on your system with a single command:

curl -sSLf http://get-termscp.veeso.dev | sh

โ— MacOs installation requires Homebrew, otherwise the Rust compiler will be installed

while if you're a Windows user, you can install termscp with Chocolatey:

choco install termscp

NetBSD users can install termscp from the official repositories.

pkgin install termscp

For more information or other platforms, please visit termscp.veeso.dev to view all installation methods.

โš ๏ธ If you're looking on how to update termscp just run termscp from CLI with: (sudo) termscp --update โš ๏ธ

Requirements โ—

  • Linux users:
    • libdbus-1
    • pkg-config
    • libsmbclient
  • FreeBSD or, NetBSD users:
    • dbus
    • pkgconf
    • libsmbclient

Optional Requirements โœ”๏ธ

These requirements are not forced required to run termscp, but to enjoy all of its features

  • Linux/FreeBSD users:
    • To open files via V (at least one of these)
      • xdg-open
      • gio
      • gnome-open
      • kde-open
  • Linux users:
  • WSL users
    • To open files via V (at least one of these)

Support the developer โ˜•

If you like termscp and you're grateful for the work I've done, please consider a little donation ๐Ÿฅณ

You can make a donation with one of these platforms:

ko-fi PayPal bitcoin


User manual ๐Ÿ“š

The user manual can be found on the termscp's website or on Github.


Upcoming Features ๐Ÿงช

For 2023 there will be two major updates during the year.

Along to new features, termscp developments is now focused on UX and performance improvements, so if you have any suggestion, feel free to open an issue.


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.

An appreciated contribution would be a translation of the user manual and readme in other languages

Please follow our contributing guidelines


Changelog โณ

View termscp's changelog HERE


Powered by ๐Ÿ’ช

termscp is powered by these awesome projects:


Gallery ๐ŸŽฌ

Termscp Home

Auth

Bookmarks

Bookmarks

Setup

Setup

Text editor

TextEditor


License ๐Ÿ“ƒ

termscp is licensed under the MIT license.

You can read the entire license HERE