# termscp
~ A feature rich terminal file transfer ~
Website ยท Installation ยท User manual
Developed by @veeso
Current version: 0.6.0 (23/07/2021)
[![License: MIT](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/licenses/MIT) [![Stars](https://img.shields.io/github/stars/veeso/termscp.svg)](https://github.com/veeso/termscp) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.6.0-orange.svg)](https://crates.io/crates/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp) [![Linux](https://github.com/veeso/termscp/workflows/Linux/badge.svg)](https://github.com/veeso/termscp/actions) [![MacOs](https://github.com/veeso/termscp/workflows/MacOS/badge.svg)](https://github.com/veeso/termscp/actions) [![Windows](https://github.com/veeso/termscp/workflows/Windows/badge.svg)](https://github.com/veeso/termscp/actions) [![FreeBSD](https://github.com/veeso/termscp/workflows/FreeBSD/badge.svg)](https://github.com/veeso/termscp/actions) [![Coverage Status](https://coveralls.io/repos/github/veeso/termscp/badge.svg)](https://coveralls.io/github/veeso/termscp) --- ## About termscp ๐ฅ Termscp is a feature rich terminal file transfer and explorer, with support for SCP/SFTP/FTP. 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**, **BSD** and **Windows** compatible and supports SFTP, SCP, FTP and FTPS. ![Explorer](assets/images/explorer.gif) --- ## Features ๐ - ๐ Different communication protocols - SFTP - SCP - FTP and FTPS - ๐ฅ 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 text files with your favourite text editor - ๐ SFTP/SCP authentication through SSH keys and username/password - ๐ง Compatible with Windows, Linux, BSD and MacOS - โ Customizable - Themes - Custom file explorer format - Customizable text editor - Customizable file sorting - ๐ Save your password in your operating system key vault - ๐ฆ Rust-powered - ๐ค Easy to extend with new file transfers protocols - ๐ 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. [Read More](CONTRIBUTING.md) 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: ```sh curl --proto '=https' --tlsv1.2 -sSLf "https://git.io/JBhDb" | sh ``` while if you're a Windows user, you can install termscp with [Chocolatey](https://chocolatey.org/). For more information or other platforms, please visit [veeso.github.io](https://veeso.github.io/termscp/#get-started) to view all installation methods. ### Requirements โ - **Linux** users: - libssh - libdbus-1 - **BSD** users: - libssh ### Optional Requirements โ๏ธ These requirements are not forcely required to run termscp, but to enjoy all of its features - **Linux/BSD** 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](docs/man.md#linux-keyring) - **WSL** users - To **open** files via `V` (at least one of these) - [wslu](https://github.com/wslutilities/wslu) --- ## 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](https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=&slug=veeso&button_colour=404040&font_colour=ffffff&font_family=Comic&outline_colour=ffffff&coffee_colour=FFDD00)](https://www.buymeacoffee.com/veeso) --- ## Documentation ๐ The developer documentation can be found on Rust Docs at