TermSCP

License: GPL v3 Stars Issues Downloads Crates.io Docs

Build Build Build

~ Basically, WinSCP on a terminal ~
Developed by Christian Visintin
Current version: 0.1.0 (06/12/2020)



About TermSCP ๐Ÿ–ฅ

TermSCP is basically a porting of WinSCP to terminal. 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 works both on Linux, MacOS, UNIX and Windows and supports SFTP, SCP, FTP and FTPS.

Explorer


Why TermSCP ๐Ÿค”

It happens very often to me, when using SCP at work to forget the path of a file on a remote machine, which forces me then to connect through SSH, gather the file path and finally download it through SCP. I could use WinSCP, but I use Linux and I pratically use the terminal for everything, so I wanted something like WinSCP on my terminal. Yeah, I know there midnight commander too, but actually I don't like it very much tbh (and doesn't support scp).

Features ๐ŸŽ


Installation โ–ถ

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

Cargo ๐Ÿฆ€

```sh

Install termscp through cargo

cargo install termscp ```

Deb package ๐Ÿ“ฆ

Get deb package from HERE or run wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp_0.1.0_amd64.deb

then install through dpkg:

```sh dpkg -i termscp_*.deb

Or even better with gdebi

gdebi termscp_*.deb ```

RPM Package ๐Ÿ“ฆ

Get rpm package from HERE or run wget https://github.com/ChristianVisintin/TermSCP/releases/download/latest/termscp-0.1.0-1.x86_64.rpm

then install through rpm:

sh rpm -U termscp_*.rpm

Chocolatey ๐Ÿซ

You can install TermSCP on Windows using chocolatey

Start PowerShell as administrator and run

ps choco install termscp

Alternatively you can download the ZIP file from HERE

and then with PowerShell started with administrator previleges, run:

ps choco install termscp -s .

Brew ๐Ÿป

You can install TermSCP on MacOS using brew

From your terminal run

sh brew tap ChristianVisintin/termscp brew install termscp


Usage โ“

TermSCP can be started with the following options:

TermSCP can be started in two different mode, if no extra arguments is provided, TermSCP will show the authentication form, where the user will be able to provide the parameters required to connect to the remote peer.

Alternatively, the user can provide an address as argument to skip the authentication form and starting directly the connection to the remote server.

Address argument

The address argument has the following syntax:

txt

Let's see some example of this particular syntax, since it's very comfortable and you'll probably going to use this instead of the other one...

How Password can be provided

You have probably noticed, that, when providing the address as argument, there's no way to provide the password. Password can be basically provided through 3 ways when address argument is provided:


Keybindings โŒจ

| Key | Command | |---------------|-------------------------------------------------------| | <ESC> | Disconnect from remote; return to authentication page | | <TAB> | Switch between log tab and explorer | | <BACKSPACE> | Go to previous directory in stack | | <RIGHT> | Move to remote explorer tab | | <LEFT> | Move to local explorer tab | | <UP> | Move up in selected list | | <DOWN> | Move down in selected list | | <PGUP> | Move up in selected list by 8 rows | | <PGDOWN> | Move down in selected list by 8 rows | | <ENTER> | Enter directory | | <SPACE> | Upload / download selected file | | <CTRL+D> | Make directory | | <CTRL+G> | Go to supplied path | | <CTRL+H> | Show help | | <CTRL+Q> | Quit TermSCP | | <CTRL+R> | Rename file | | <CTRL+U> | Go to parent directory | | <CANC> | Delete file |


Documentation ๐Ÿ“š

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


Known issues ๐Ÿงป


Upcoming Features ๐Ÿงช


Contributions ๐Ÿค™๐Ÿป

Contributions are welcome! ๐Ÿ˜‰

If you think you can contribute to TermSCP, please follow TermSCP's contributions guide

Changelog โณ

View TermSCP's changelog HERE


Powered by ๐Ÿš€

TermSCP is powered by these aweseome projects:


Gallery ๐ŸŽฌ

Auth


License ๐Ÿ“ƒ

Licensed under the GNU GPLv3 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.gnu.org/licenses/gpl-3.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can read the entire license HERE