https://github.com/connerwill/rclonefzf
Browse rclone remote contents using fzf
https://github.com/connerwill/rclonefzf
cli fzf rclone rclone-fzf rclonefzf tui
Last synced: 4 months ago
JSON representation
Browse rclone remote contents using fzf
- Host: GitHub
- URL: https://github.com/connerwill/rclonefzf
- Owner: ConnerWill
- License: gpl-3.0
- Created: 2026-01-13T21:01:40.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-14T20:38:59.000Z (5 months ago)
- Last Synced: 2026-01-18T06:25:37.534Z (5 months ago)
- Topics: cli, fzf, rclone, rclone-fzf, rclonefzf, tui
- Language: Shell
- Homepage: https://aur.archlinux.org/packages/rclonefzf
- Size: 587 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
# rclonefzf
> ***rclonefzf** is an interactive terminal UI for browsing and viewing files on **[rclone][rclone-url]** remotes using **[fzf][fzf-url]***
[![Shellcheck][shellcheck-badge]][shellcheck-workflow]
[![GitHub last commit][github-last-commit-badge]][github-commits]
[![GitHub issues][github-issues-badge]][github-issues]
[![GitHub repo size][github-repo-size-badge]][github-repo]
[![GitHub top language][github-top-language-badge]][github-repo]
[![GitHub language count][github-language-count-badge]][github-repo]
[![License][license-badge]][license]
[![GitHub Release Version][github-release-badge]][github-release-url]
[![AUR Version][aur-version-badge]][aur-url]
[![GitLab][gitlab-badge]][gitlab]
# Description
rclonefzf is an interactive terminal UI for browsing and viewing files on rclone remotes using **[fzf][fzf-url]**
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](#rclonefzf)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Screenshots](#screenshots)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [AUR](#aur)
- [Git](#git)
- [Usage](#usage)
- [Command Line Options](#command-line-options)
- [Keybindings](#keybindings)
- [Configuration](#configuration)
- [Configuration Files](#configuration-files)
- [Configuration Options](#configuration-options)
- [See Also](#see-also)
- [Contributing](#contributing)
- [Donate](#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
```bash
yay -S rclonefzf
```
### Git
Clone the repository and make the script executable:
```bash
git clone https://github.com/connerwill/rclonefzf.git
cd rclonefzf
chmod +x bin/rclonefzf
```
Optionally, move it to a directory in your PATH:
```bash
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:
```bash
rclonefzf
```
Launch with an initial search query:
```bash
rclonefzf "query"
```
### Command Line Options
| Option | Description |
|--------|-------------|
| `-k`, `--keybindings` | Show keybindings and exit |
| `-i`, `--init-config` | Install example configuration file |
| `-s`, `--show-config` | Show example configuration file content |
| `-v`, `--verbose` | Show verbose output |
| `-h` | Show short help |
| `--help` | Show full help |
| `--help-man` | Show manpage help |
| `-V`, `--version` | Show version |
### Keybindings
| Key | Action |
|-----|--------|
| ↑ | Move up |
| ↓ | Move down |
| PGUP | Move up one page |
| PGDN | Move down one page |
| HOME | Move to first |
| END | Move to last |
| 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 *[`string`]* *(`default`)* *(`default`, `light`, `tokyo-night`, `neon`)*
- `PREVIEW_WINDOW` — fzf preview window layout and size *[`string`]* *(`right:60%:wrap`)*
- `ENABLE_PREVIEW` — Show preview window *[`bool`]* *(`true`)*
- `LAYOUT` — fzf layout *[`string`]* *(`reverse`)* *(`default`, `reverse`)*
- `BORDER` — fzf border style *[`string`]* *(`rounded`)* *(`default`, `rounded`)*
- `VERBOSE` — Enable verbose logging *[`bool`]* *(`false`)*
- `RCLONEFZF_PAGER` — Pager *[`string`]* *(`less`)*
- `RCLONE_MAX_DEPTH` — Max depth for directory browsing *[`integer`]* *(`10`)*
- `RCLONEFZF_DOWNLOADS_DIR` - Download directory *[`string`]* *(`~/downloads/rclonefzf`)*
- `NO_COLOR` - Do not use color for output *[`bool`]*
## See Also
- [rclone][rclone-url]
- [fzf][fzf-url]
- [yayfzf][yayfzf-url]
## 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
```console
git checkout -b AmazingNewFeature
```
3. Commit your Changes
```console
git commit -m 'Description of the amazing feature you added'
```
4. Push to the Branch
```console
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
[github-repo]: https://github.com/ConnerWill/rclonefzf
[shellcheck-badge]: https://github.com/ConnerWill/rclonefzf/actions/workflows/shellcheck.yml/badge.svg
[shellcheck-workflow]: https://github.com/ConnerWill/rclonefzf/actions/workflows/shellcheck.yml
[github-top-language-badge]: https://img.shields.io/github/languages/top/ConnerWill/rclonefzf
[github-language-count-badge]: https://img.shields.io/github/languages/count/ConnerWill/rclonefzf
[github-last-commit-badge]: https://img.shields.io/github/last-commit/ConnerWill/rclonefzf
[github-commits]: https://github.com/ConnerWill/rclonefzf/commits/main
[github-issues-badge]: https://img.shields.io/github/issues-raw/ConnerWill/rclonefzf
[github-issues]: https://github.com/ConnerWill/rclonefzf/issues
[github-repo-size-badge]: https://img.shields.io/github/repo-size/ConnerWill/rclonefzf
[gitlab-badge]: https://img.shields.io/static/v1?label=gitlab&logo=gitlab&color=E24329&message=mirrored
[gitlab]: https://gitlab.com/ConnerWill/rclonefzf
[license-badge]: https://img.shields.io/github/license/ConnerWill/rclonefzf
[license]: https://github.com/ConnerWill/rclonefzf/blob/main/docs/LICENSE
[github-repo-stars-badge]: https://img.shields.io/github/stars/ConnerWill/rclonefzf?style=social
[github-repo-downloads-badge]: https://img.shields.io/github/downloads/ConnerWill/rclonefzf/total?style=social
[github-release-badge]: https://img.shields.io/github/v/release/ConnerWill/rclonefzf
[github-release-url]: https://github.com/ConnerWill/rclonefzf/releases
[aur-version-badge]: https://img.shields.io/aur/version/rclonefzf
[aur-url]: https://aur.archlinux.org/packages/rclonefzf
[rainbow-line]: https://raw.githubusercontent.com/ConnerWill/Project-Template/main/assets/lines/rainbow.png
[wiki-url]: https://github.com/ConnerWill/rclonefzf/wiki
[wiki-customization-url]: https://github.com/ConnerWill/rclonefzf/wiki/Customization
[wiki-installation-url]: https://github.com/ConnerWill/rclonefzf/wiki/Installation
[wiki-screenshots-url]: https://github.com/ConnerWill/rclonefzf/wiki/Screenshots
[fzf-url]: https://github.com/junegunn/fzf
[yayfzf-url]: https://github.com/ConnerWill/yayfzf
[rclonefzf-url]: https://github.com/ConnerWill/rclonefzf
[rclone-url]: https://rclone.org
[rclonefzf-source]: https://github.com/ConnerWill/rclonefzf/blob/main/bin/rclonefzf
XMR