Ecosyste.ms: Awesome

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

https://github.com/darkhz/rclone-tui


https://github.com/darkhz/rclone-tui

Last synced: about 2 months ago
JSON representation

Lists

README

        

[![Go Report Card](https://goreportcard.com/badge/github.com/darkhz/rclone-tui)](https://goreportcard.com/report/github.com/darkhz/rclone-tui)

[![youtube](https://img.youtube.com/vi/Jmm55Jh5Nhc/1.jpg)](https://youtube.com/watch?v=Jmm55Jh5Nhc)

# rclone-tui
rclone-tui is a cross-platform manager for rclone. It aims to be on-par with the web GUI (--rc-web-gui) as well as provide more improvements and enhancements over its general functionality.

Click on the above thumbnail to watch the demo video.
## Features
- Monitor rclone stats via the dashboard
- Create, update, view and delete configurations
- Explore remotes and perform various operations
- Mount and unmount remotes
- View file transfer and progress information

## Installation
You can download the binaries present in the **Releases** page.


Alternatively, if the **go** compiler is present in your system, you can install it with the following command:

`go install github.com/darkhz/rclone-tui@latest`

## Usage
```
rclone-tui []

Flags:
--page Load the specified page (one of dashboard, configuration, explorer, mounts).
--host Specify a rclone host to connect to.
--password Specify a login password.
--user Specify a login username.
```

## Keybindings

### Application

#### Global
|Operation |Keybinding |
|----------------------------|----------------------------|
|Open job manager |Ctrl+j|
|Show view switcher |Ctrl+n|
|Cancel currently loading job|Ctrl+x|
|Suspend |Ctrl+z|
|Quit |Ctrl+q|

#### Configuration/Mounts only
|Operation |Keybinding |
|-------------------------------------|-------------------------------------------------|
|Select button |Enter |
|Move between buttons |Ctrl+Left/Right |
|Move between sections (wizard only) |Shift+Tab |
|Move between form items (wizard only)|Ctrl+Down/Up/Tab|
|Show form options |Ctrl+o |
|Toggle password display |Ctrl+p |

### Configuration
#### Manager
|Operation |Keybinding |
|----------|------------|
|Create new|n|
|Update |u|
|Delete |d|
|Filter |/|

#### Wizard
|Operation |Keybinding |
|--------------|----------------------------|
|Jump to option|Ctrl+f|
|Save |Ctrl+s|
|Cancel |Ctrl+c|

### Explorer

#### General
|Operation |Keybinding |
|----------------------------|----------------------------|
|Switch between panes |Tab |
|Show remotes |g |
|Filter entries within pane |/ |
|Sort entries within pane |, |
|Navigate between directories|Left/Right |
|Refresh a pane |Ctrl+r|
|Cancel fetching remotes |Ctrl+x|

#### Item selection
|Operation |Keybinding |
|-----------------|-----------------|
|Select one item |Space |
|Inverse selection|a |
|Select all items |A |
|Clear selections |Escape|

#### Operations
|Operation |Keybinding |
|-----------------------------|------------|
|Copy selected items |p|
|Move selected items |m|
|Delete selected items |d|
|Make directory |M|
|Generate public link for item|;|
|Show remote information |i|

### Mounts

#### Manager
|Operation |Keybinding |
|-----------|------------|
|Create new |n|
|Unmount |u|
|Unmount all|U|

#### Wizard
|Operation |Keybinding |
|-----------------|----------------------------|
|Create mountpoint|Ctrl+s|
|Cancel |Ctrl+c|

### Job Manager
|Operation |Keybinding |
|---------------------|----------------------------|
|Navigate between jobs|Down/Up |
|Cancel job |x |
|Cancel job group |Ctrl+x|

## Additional Notes
- To control your local rclone instance, launch `rclone rcd --rc-no-auth` and use the output host and port to login. Optionally, you can include authentication credentials with `--rc-user` and `--rc-pass` and excluding the `--rc-no-auth` flag.