rclone-tui

December 23, 2022 ยท View on GitHub

Go Report Card

youtube

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>]

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

OperationKeybinding
Open job managerCtrl+j
Show view switcherCtrl+n
Cancel currently loading jobCtrl+x
SuspendCtrl+z
QuitCtrl+q

Configuration/Mounts only

OperationKeybinding
Select buttonEnter
Move between buttonsCtrl+Left/Right
Move between sections (wizard only)Shift+Tab
Move between form items (wizard only)Ctrl+Down/Up/Tab
Show form optionsCtrl+o
Toggle password displayCtrl+p

Configuration

Manager

OperationKeybinding
Create newn
Updateu
Deleted
Filter/

Wizard

OperationKeybinding
Jump to optionCtrl+f
SaveCtrl+s
CancelCtrl+c

Explorer

General

OperationKeybinding
Switch between panesTab
Show remotesg
Filter entries within pane/
Sort entries within pane,
Navigate between directoriesLeft/Right
Refresh a paneCtrl+r
Cancel fetching remotesCtrl+x

Item selection

OperationKeybinding
Select one itemSpace
Inverse selectiona
Select all itemsA
Clear selectionsEscape

Operations

OperationKeybinding
Copy selected itemsp
Move selected itemsm
Delete selected itemsd
Make directoryM
Generate public link for item;
Show remote informationi

Mounts

Manager

OperationKeybinding
Create newn
Unmountu
Unmount allU

Wizard

OperationKeybinding
Create mountpointCtrl+s
CancelCtrl+c

Job Manager

OperationKeybinding
Navigate between jobsDown/Up
Cancel jobx
Cancel job groupCtrl+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.