# termscp
[](https://opensource.org/licenses/MIT) [](https://github.com/veeso/termscp) [](https://crates.io/crates/termscp) [](https://crates.io/crates/termscp) [](https://docs.rs/termscp)
[](https://github.com/veeso/termscp/actions) [](https://github.com/veeso/termscp/actions) [](https://github.com/veeso/termscp/actions) [](https://coveralls.io/github/veeso/termscp)
~ A feature rich terminal file transfer ~
Website
ยท
Installation
ยท
User manual
Developed by Christian Visintin
Current version: 0.5.0 (23/05/2021)
---
## 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.
---
## Features ๐
- ๐ Different communication protocols support
- 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
- 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 or a MacOS user this simple shell script will install termscp on your system with a single command:
```sh
curl --proto '=https' --tlsv1.2 -sSf "https://raw.githubusercontent.com/veeso/termscp/main/install.sh" | 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.
---
## Buy me a coffee โ
If you like termscp and you'd love to see the project to grow, please consider a little donation ๐ฅณ
[](https://www.buymeacoffee.com/veeso)
---
## Documentation ๐
The developer documentation can be found on Rust Docs at
---
## Known issues ๐งป
- `NoSuchFileOrDirectory` on connect (WSL1): 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 ๐งช
Major termscp updates will now be seasonal, so expect 4 major updates during the year.
- **Keyring-rs on Linux ๐**: Planned for the *summer update*, check for updates in [this issue](https://github.com/veeso/termscp/issues/2)
- **Samba Support ๐**: This will require a long time to be implemented, since I'm thinking of implementing a Rust native samba library from scratch, since I don't want to add new C-bindings. It'll maybe included in the *summer update*.
- **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
- **Configuration profile for bookmarks ๐**: I would like to, but I still have to analyze it.
- **AWS S3 support ๐ชฃ**: There is already a library for AWS S3, but this is really on bottom of my implementation list at the moment, due to interest and I don't really have a system where to test it.
Along to new features, termscp developments is now focused on UI 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.
Please follow [our contributing guidelines](CONTRIBUTING.md)
---
## Changelog โณ
View termscp's changelog [HERE](CHANGELOG.md)
---
## Powered by ๐ช
termscp is powered by these aweseome projects:
- [bytesize](https://github.com/hyunsik/bytesize)
- [crossterm](https://github.com/crossterm-rs/crossterm)
- [edit](https://github.com/milkey-mouse/edit)
- [keyring-rs](https://github.com/hwchen/keyring-rs)
- [rpassword](https://github.com/conradkleinespel/rpassword)
- [rust-ftp](https://github.com/mattnenterprise/rust-ftp)
- [ssh2-rs](https://github.com/alexcrichton/ssh2-rs)
- [textwrap](https://github.com/mgeisler/textwrap)
- [tui-rs](https://github.com/fdehau/tui-rs)
- [tui-realm](https://github.com/veeso/tui-realm)
- [whoami](https://github.com/libcala/whoami)
- [wildmatch](https://github.com/becheran/wildmatch)
---
## Gallery ๐ฌ
> Termscp Home
> Bookmarks
> Setup
> Text editor
---
## License ๐
termscp is licensed under the MIT license.
You can read the entire license [HERE](LICENSE)