maxmustermann/termscp
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
788 commits 3 branches 17 tags 17 MiB
Rust 98.8%
Shell 1.2%
Go to file
veeso d04dd831e4 README
2021-05-23 15:56:18 +02:00
.github Logging docs 2021-05-17 22:35:28 +02:00
assets/images [ImgBot] Optimize images 2021-05-23 13:46:14 +00:00
dist AUR pkgs 2021-05-23 15:52:18 +02:00
docs Migrated documentation to website 2021-05-22 16:03:07 +02:00
src Fixed new ssh key box 2021-05-22 10:53:51 +02:00
.gitignore working on 0.3.1... 2021-01-16 10:31:24 +01:00
Cargo.lock Logging setup 2021-05-16 10:36:16 +02:00
Cargo.toml Docs 2021-05-23 14:47:55 +02:00
CHANGELOG.md Going to release 0.5.0 2021-05-23 15:42:51 +02:00
CODE_OF_CONDUCT.md Project initialized 2020-11-07 17:48:41 +01:00
codecov.yml Removed codecov path fix 2021-04-05 09:40:57 +02:00
CONTRIBUTING.md Logging docs 2021-05-17 22:35:28 +02:00
install.sh Going to release 0.5.0 2021-05-23 15:42:51 +02:00
LICENSE License changed to MIT 2021-03-26 22:25:10 +01:00
README.md README 2021-05-23 15:56:18 +02:00

README.md

termscp

~ A feature rich terminal file transfer ~

Website · Installation · User manual

Developed by @veeso

Current version: 0.5.0 (23/05/2021)

License: MIT Stars Downloads Crates.io Docs

Build Build Build Coverage Status

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

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

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

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.

For more information or other platforms, please visit veeso.github.io 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 🥳

Buy-me-a-coffee

Documentation 📚

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

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
  • 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

Changelog ⏳

View termscp's changelog HERE

Powered by 💪

termscp is powered by these aweseome 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