Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/veeso/termscp

🖥 A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3/SMB
https://github.com/veeso/termscp

aws-s3 command-line-tool command-line-utility ftp-client rust rust-crate rust-lang scp sftp sftp-client ssh-client terminal terminal-app tui tui-rs utility winscp winscp-equivalent-for-linux winscp-for-linux winscp-for-mac

Last synced: 4 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/veeso/termscp
Owner: veeso
License: mit
Created: 2020-11-07T16:03:06.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-11-13T16:06:38.000Z (about 1 month ago)
Last Synced: 2024-12-10T09:43:38.341Z (11 days ago)
Topics: aws-s3, command-line-tool, command-line-utility, ftp-client, rust, rust-crate, rust-lang, scp, sftp, sftp-client, ssh-client, terminal, terminal-app, tui, tui-rs, utility, winscp, winscp-equivalent-for-linux, winscp-for-linux, winscp-for-mac
Language: Rust
Homepage: https://termscp.veeso.dev
Size: 26.2 MB
Stars: 1,802
Watchers: 12
Forks: 50
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-ratatui - termscp - A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3/SMB. (💻 Apps / 🌐 Networking and Internet)
awesome-list - termscp - A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3/SMB. (Linux 🐧 / Networking)
awesome-rust-tools - termscp

README

        # termscp



  



~ A feature rich terminal file transfer ~



  Website

  ·

  Installation

  ·

  User manual





  

   

  

   

  

   

  

   

  

   

  

   

  



Developed by @veeso

Current version: 0.16.1 12/11/2024




  

  

  

  

  

    





  

  

  



---

## 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](assets/images/explorer.gif)

---

## 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](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

```

> ❗ MacOs installation requires [Homebrew](https://brew.sh/), otherwise the Rust compiler will be installed

while if you're a Windows user, you can install termscp with [Chocolatey](https://chocolatey.org/):

```ps

choco install termscp

```

NetBSD users can install termscp from the official repositories.

```sh

pkgin install termscp

```

Arch Linux users can install termscp from the official repositories.

```sh

pacman -S termscp

```

For more information or other platforms, please visit [termscp.veeso.dev](https://termscp.veeso.dev/#get-started) 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:

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

---

## 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](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/veeso)

[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://www.paypal.me/chrisintin)

---

## User manual 📚

The user manual can be found on the [termscp's website](https://termscp.veeso.dev/#user-manual) or on [Github](docs/man.md).

---

## Upcoming Features 🧪

See [Milestones](https://github.com/veeso/termscp/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](CONTRIBUTING.md)

---

## Changelog ⏳

View termscp's changelog [HERE](CHANGELOG.md)

---

## Powered by 💪

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

- [kube](https://github.com/kube-rs/kube)

- [open-rs](https://github.com/Byron/open-rs)

- [pavao](https://github.com/veeso/pavao)

- [remotefs](https://github.com/veeso/remotefs-rs)

- [rpassword](https://github.com/conradkleinespel/rpassword)

- [self_update](https://github.com/jaemk/self_update)

- [ratatui](https://github.com/ratatui-org/ratatui)

- [tui-realm](https://github.com/veeso/tui-realm)

- [whoami](https://github.com/libcala/whoami)

- [wildmatch](https://github.com/becheran/wildmatch)

---

## Gallery 🎬

> Termscp Home

![Auth](assets/images/auth.gif)

> Bookmarks

![Bookmarks](assets/images/bookmarks.gif)

> Setup

![Setup](assets/images/config.gif)

> Text editor

![TextEditor](assets/images/text-editor.gif)

---

## License 📃

termscp is licensed under the MIT license.

You can read the entire license [HERE](LICENSE)