Skip to content

Update README.md #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
luckman212 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,20 @@
![crates.io](https://img.shields.io/crates/v/filessh)
![GitHub Tag](https://img.shields.io/github/v/tag/jayanaxhf/filessh)


A TUI-based file explorer for SSH servers, which allows you to browse and manage files on a remote server, edit them in-place, and recursively download directories with parallel directory traversal. It also has the ability to quickly spawn SSH sessions to paths on the remote server.

Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/).

![Made with VHS](https://vhs.charm.sh/vhs-3OLXZvjKpqe5qR7hxsftQF.gif)

## Installation

Copy link
Copy Markdown
Owner

@JayanAXHF JayanAXHF Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Copy link
Copy Markdown
Owner

@JayanAXHF JayanAXHF Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please avoid these formatting changes?

### Cargo

```sh
cargo install --locked filessh
```

### Build from source

1. Ensure you have Rust and Cargo installed. You can find installation instructions at [rust-lang.org](https://www.rust-lang.org/tools/install).
Expand All @@ -35,17 +37,13 @@ cargo install --locked filessh
- [ ] Add support for rsync and scp
- [ ] Iron out bugs

## Usage
## Features

```sh
filessh [OPTIONS] <HOST> <PATH>
```
### Features
1. Modify, delete and browse files on a remote server
2. Recursively download directories with parallel directory traversal
3. Quickly open SSH sessions to directories.

### Usage
## Usage

```
filessh [OPTIONS] [HOST] [PATH]
Expand Down Expand Up @@ -73,6 +71,9 @@ Options:
Print help
-V, --version
Print version

To exit the app, press ⌃q (ctrl+q)
Copy link
Copy Markdown
Owner

@JayanAXHF JayanAXHF Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it'd be better as a note at the start of the usage section. Also, if you'd like, you could also update the man pages if they're also missing this keybind


```

### Example
Expand Down