Skip to content
/ termscp Public

🖥 A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3/SMB

License

Notifications You must be signed in to change notification settings

veeso/termscp

Repository files navigation

termscp

termscp logo

~ A feature rich terminal file transfer ~

Website · Installation · User manual

English   Brazilian Portuguese   Deutsch   Español   Français   Italiano   简体中文

Developed by @veeso

Current version: 0.16.0 (14/10/2024)

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

Linux CI MacOS CI Windows CI


About termscp 🖥

Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP/Kube/S3/WebDAV. 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
    • Kube
    • S3
    • SMB
    • WebDAV
  • 🖥 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 --proto '=https' --tlsv1.2 -sSLf "https://git.io/JBhDb" | 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

Arch Linux users can install termscp from the official repositories.

pacman -S 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


User manual 📚

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


Upcoming Features 🧪

See Milestones


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