Ecosyste.ms: Awesome

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

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: 8 days ago
JSON representation

๐Ÿ–ฅ A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3/SMB

Lists

README

        

# termscp


termscp logo

~ A feature rich terminal file transfer ~



Website
ยท
Installation
ยท
User manual


Brazilian Portuguese
ย 
English
ย 
Deutsch
ย 
Espaรฑol
ย 
Franรงais
ย 
Italiano
ย 
็ฎ€ไฝ“ไธญๆ–‡

Developed by @veeso


Current version: 0.13.0 (03/03/2024)


License-MIT
Repo stars
Downloads counter
Latest version

Ko-fi



Linux CI
MacOS CI
Windows CI
Coveralls

---

## 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**, **NetBSD** and **Windows** compatible.

![Explorer](assets/images/explorer.gif)

---

## Features ๐ŸŽ

- ๐Ÿ“ Different communication protocols
- **SFTP**
- **SCP**
- **FTP** and **FTPS**
- **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 ๐Ÿงช

For **2023** there will be two major updates during the year.

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](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)
- [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)