rclonefzf

rclonefzf is an interactive terminal UI for browsing and viewing files on rclone remotes using fzf

Description

rclonefzf is an interactive terminal UI for browsing and viewing files on rclone remotes using fzf

It provides a fast, keyboard-driven interface to select configured rclone remotes, recursively browse files, preview file contents inline, and manage selections — all from the terminal.

Table of Contents

• rclonefzf
• Description
• Table of Contents
• Screenshots
• rclonefzf
  • Features
  • Requirements
  • Installation
    • AUR
    • Git
  • Usage
    • Command Line Options
    • Keybindings
  • Configuration
    • Configuration Files
    • Configuration Options
  • See Also
  • Contributing
  • Donate

Screenshots

Features

• Interactive menu for selecting rclone remotes
• Recursive file browsing with configurable depth
• Inline file preview using rclone cat
• Multi-select support via fzf
• Toggleable preview window
• Multiple built-in color themes
• Configurable layout, borders, and keybindings
• XDG-compliant configuration file support

Requirements

• rclone
• fzf

Installation

AUR

yay -S rclonefzf

Git

Clone the repository and make the script executable:

git clone https://github.com/connerwill/rclonefzf.git
cd rclonefzf
chmod +x bin/rclonefzf

Optionally, move it to a directory in your PATH:

sudo install -Dm755 "bin/rclonefzf" "/usr/local/bin/rclonefzf"  # Main executable
sudo install -Dm644 "docs/README.md" "/usr/share/doc/rclonefzf/README.md"  # Documentation
sudo install -Dm644 "docs/rclonefzf.1" "/usr/share/man/man1/rclonefzf.1"  # Man page
sudo install -Dm644 "LICENSE" "/usr/share/licenses/rclonefzf/LICENSE"  # License
sudo install -Dm644 "completion/_rclonefzf" "/usr/share/zsh/site-functions/_rclonefzf"  # ZSH completion
sudo install -Dm644 "completion/rclonefzf_completion.sh" "/usr/share/bash-completion/completions/rclonefzf"  # Bash completion

Usage

Launch the interactive interface:

rclonefzf

Launch with an initial search query:

rclonefzf "query"

Command Line Options

Option	Description
-k, --keybindings	Show keybindings and exit
--init-config	Install example configuration file
--show-config	Show example configuration file content
-v, --verbose	Show verbose output
-h	Show short help
--help	Show full help
-V, --version	Show version

Keybindings

Key	Action
ENTER	Perform action on selection
TAB	Select item
Shift+TAB	Unselect item
CTRL+a	Select all items
CTRL+d	Deselect all items
CTRL+s	Download selection
CTRL+l	Clear search query
CTRL+Backspace	Clear search query
CTRL+/	Change layout
CTRL+v	Toggle preview window
?	Show keybindings
CTRL+c	Exit rclonefzf
CTRL+w	Exit rclonefzf
ESC	Exit rclonefzf

Configuration

Configuration Files

rclonefzf looks for configuration files in this order (uses the first file found):

• $XDG_CONFIG_HOME/rclonefzf/rclonefzf.conf
• $HOME/.config/rclonefzf/rclonefzf.conf
• $HOME/.rclonefzf.conf

Configuration Options

• THEME — Color theme (default, light, tokyo-night, neon)
• PREVIEW_WINDOW — fzf preview window layout and size
• ENABLE_PREVIEW — Show preview window (true or false)
• LAYOUT — fzf layout (default or reverse)
• BORDER — fzf border style (default or rounded)
• VERBOSE — Enable verbose logging (true or false)
• RCLONEFZF_PAGER — Pager for help/config/keybindings (less, bat, etc.)
• RCLONE_MAX_DEPTH — Max depth for directory browsing
• RCLONEFZF_DOWNLOADS_DIR - Download directory (~/downloads/rclonefzf, ${PWD})

See Also

• rclone
• fzf

Contributing

Click to expand contributing section

Any contributions you make are greatly appreciated.

If you want to contribute, please fork this repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch

git checkout -b AmazingNewFeature

3. Commit your Changes

git commit -m 'Description of the amazing feature you added'

4. Push to the Branch

git push origin AmazingNewFeature

5. Then open a pull request :)

If you experience any bugs/issues or have and suggestions, you can simply open an issue :)

Donate

XMR : 86tE67soBqFb5fxNGgC4HLdwZXebP42ewfBwfKyMDKvFbgA7T8p4g4T5BBNA9LNbwaVafup973w41PdvCS7bbj6gTNQpCh1

BTC : bc1qpg5d69n2knsete7vw7f2vqpkg4a0faq9rc6se0

(back to top)