~ A feature rich terminal file transfer ~
++ Website + ยท + Installation + ยท + User manual +
+ Developed by Christian Visintin Current version: 0.5.0 FIXME: (13/04/2021) --- -- [termscp](#termscp) - - [About termscp ๐ฅ](#about-termscp-) - - [Features ๐](#features-) - - [Get started ๐](#get-started-) - - [Cargo ๐ฆ](#cargo-) - - [Deb package ๐ฆ](#deb-package-) - - [RPM package ๐ฆ](#rpm-package-) - - [AUR Package ๐ผ](#aur-package-) - - [Chocolatey ๐ซ](#chocolatey-) - - [Brew ๐ป](#brew-) - - [User Manual ๐](#user-manual-) - - [Documentation ๐](#documentation-) - - [Known issues ๐งป](#known-issues-) - - [Upcoming Features ๐งช](#upcoming-features-) - - [Contributing and issues ๐ค๐ป](#contributing-and-issues-) - - [Changelog โณ](#changelog-) - - [Powered by ๐](#powered-by-) - - [Gallery ๐ฌ](#gallery-) - - [Buy me a coffee โ](#buy-me-a-coffee-) - - [License ๐](#license-) - ---- - ## 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. @@ -69,99 +54,20 @@ Termscp is a feature rich terminal file transfer and explorer, with support for --- -## Get started ๐ +## 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) -You can opt for any of these methods, according to your systems and preferences: - -### Cargo ๐ฆ - -```sh -# Install termscp via cargo -cargo install termscp -``` - -Requirements: - -- Linux - - pkg-config - - libssh2 - - openssl - -### Deb package ๐ฆ - -Get `deb` package from [HERE](https://github.com/veeso/termscp/releases/latest/download/termscp_0.5.0_amd64.deb) -or run `wget https://github.com/veeso/termscp/releases/latest/download/termscp_0.5.0_amd64.deb` - -then install via dpkg: - -```sh -dpkg -i termscp_*.deb -# Or even better with gdebi -gdebi termscp_*.deb -``` - -### RPM package ๐ฆ - -Get `rpm` package from [HERE](https://github.com/veeso/termscp/releases/latest/download/termscp-0.5.0-1.x86_64.rpm) -or run `wget https://github.com/veeso/termscp/releases/latest/download/termscp-0.5.0-1.x86_64.rpm` - -then install via rpm: - -```sh -rpm -U termscp_*.rpm -``` - -### AUR Package ๐ผ - -On Arch Linux based distribution, you can install termscp using for istance [yay](https://github.com/Jguer/yay), which I recommend to install AUR packages. - -```sh -yay -S termscp -``` - -### Chocolatey ๐ซ - -You can install termscp on Windows via [chocolatey](https://community.chocolatey.org/packages/termscp) - -Start PowerShell as administrator and run - -```ps -choco install termscp -``` - -Alternatively you can download the ZIP file from [HERE](https://github.com/veeso/termscp/releases/latest/download/termscp.0.5.0.nupkg) - -and then with PowerShell started with administrator previleges, run: - -```ps -choco install termscp -s . -``` - -### Brew ๐ป - -You can install termscp on MacOS using [brew](https://brew.sh/) - -From your terminal run - -```sh -brew install veeso/termscp/termscp -``` +Visit [termscp website](https://veeso.github.io/termscp/#get-started) to get started with termscp. --- -## User Manual ๐ +## Buy me a coffee โ -[Click here](docs/man.md) to read the user manual! +If you like termscp and you'd love to see the project to grow, please consider a little donation ๐ฅณ -What you will find: - -- CLI options -- Keybindings -- Bookmarks -- Configuration +[](https://www.buymeacoffee.com/veeso) --- @@ -206,7 +112,7 @@ View termscp's changelog [HERE](CHANGELOG.md) --- -## Powered by ๐ +## Powered by ๐ช termscp is powered by these aweseome projects: @@ -245,14 +151,6 @@ termscp is powered by these aweseome projects: --- -## 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) - ---- - ## License ๐ termscp is licensed under the MIT license. diff --git a/docs/man.md b/docs/man.md index 7599ab5..aa49c00 100644 --- a/docs/man.md +++ b/docs/man.md @@ -1,24 +1,5 @@ # User manual ๐ -- [User manual ๐](#user-manual-) - - [Usage โ](#usage-) - - [Address argument ๐](#address-argument-) - - [How Password can be provided ๐](#how-password-can-be-provided-) - - [File explorer ๐](#file-explorer-) - - [Keybindings โจ](#keybindings-) - - [Work on multiple files ๐ฅท](#work-on-multiple-files-) - - [Synchronized browsing โฒ๏ธ](#synchronized-browsing-๏ธ) - - [Bookmarks โญ](#bookmarks-) - - [Are my passwords Safe ๐](#are-my-passwords-safe-) - - [Configuration โ๏ธ](#configuration-๏ธ) - - [SSH Key Storage ๐](#ssh-key-storage-) - - [File Explorer Format](#file-explorer-format) - - [Text Editor โ](#text-editor-) - - [How do I configure the text editor ๐ฆฅ](#how-do-i-configure-the-text-editor-) - - [Logging ๐ฉบ](#logging-) - ---- - ## Usage โ termscp can be started with the following options: @@ -119,7 +100,7 @@ In order to change panel you need to type `` | Quit termscp | Quit | | `` | Rename file | Rename | | ` ` | Save file as... | Save | @@ -183,7 +164,7 @@ In order to create a new bookmark, just follow these steps: whenever you want to use the previously saved connection, just press `` to navigate to the bookmarks list and load the bookmark parameters into the form pressing ` `. - + ### Are my passwords Safe ๐