termscp

~ A feature rich terminal file transfer ~

Website · Installation · User manual

         

Developed by @veeso

Current version: 0.8.0 (06/01/2022)

---

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 and Windows compatible.

---

Features 🎁

• 📁 Different communication protocols
  • SFTP
  • SCP
  • FTP and FTPS
  • Aws S3
• 🖥 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 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
• 🔐 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

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

choco install termscp

For more information or other platforms, please visit veeso.github.io 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:
  • libssh
  • libdbus-1
  • pkg-config
• FreeBSD users:
  • libssh
  • dbus
  • pkgconf

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:
  • A keyring manager: read more in the User manual
• WSL users
  • To open files via V (at least one of these)
    • wslu

---

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:

---

User manual and Documentation 📚

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

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

---

Upcoming Features 🧪

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

Planned for 🍓 Spring update 2022 🌹:

• File system watcher 🔭: The feature consists in the possibility to track some files in order to automatically sync them with remote host. For the implementation notify will be used.

Planned for future updates ⏲️:

• Translations 🌐: The feature consists in the possibility for the user to install the language pack for the language he prefers in order to replace the default English interface. The following language will be provided along to English:
  • 🇨🇳 Chinese
  • 🇫🇷 French
  • 🇩🇪 German
  • 🇮🇹 Italian
  • 🇳🇱 Dutch
  • 🇪🇸 Spanish
• Configuration profile for bookmarks 📚: Basically this feature adds the possibility to have a specific setup for a certain host, instead of having only one global configuration. (Maybe will be postponed to spring 2022).

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:

• bytesize
• crossterm
• edit
• keyring-rs
• open-rs
• remotefs
• rpassword
• self_update
• tui-rs
• tui-realm
• whoami
• wildmatch

---

Gallery 🎬

Termscp Home

Bookmarks

Setup

Text editor

---

License 📃

termscp is licensed under the MIT license.

You can read the entire license HERE