Terminal UI for rclone

Your friendly rclone companion.

A Terminal User Interface for automating, monitoring and managing rclone synchronization tasks. Keyboard-driven, live progress, configured with a simple TOML file.

Get started Download
Live statsvia rclone RC API
–GitHub stars
Features

rclone, with a friendly face.

rcmate is a Terminal User Interface (TUI) for automating, monitoring and managing rclone synchronization tasks.

Interactive TUI

Built with ratatui for a fast, keyboard-driven terminal experience.

Multiple sync modes

Supports sync, bisync, copy and move operations, per sync pair.

Real-time progress

Connects to the rclone RC (Remote Control) API to display live transfer stats and progress bars.

Smart file handling

Single-file operations are automatically translated into directory operations with includes.

Highly configurable

Define sync pairs, paths and filters in a simple TOML configuration file.

CLI overrides

Override config paths, the rclone binary and logging levels via command-line arguments.

Configuration

One TOML file. Every sync pair.

Define sync pairs, paths and filters in ~/.config/rcmate/config.toml. Options are stored per pair and written back by the Options popup.

  • sync Make the destination identical to the source.
  • bisync Two-way synchronization between both paths.
  • copy Copy files from source to destination.
  • move Move files from source to destination.
Full configuration reference →
config.toml 
[general]
log_path = "~/.local/state/rcmate/logs"
log_level = "info"

[rclone]
bin = "rclone"

[[sync_pairs]]
name = "Documents Sync"
type = "bisync"
source = "/local/documents"
destination = "remote:documents"

[sync_pairs.options]
dry_run = false
resync_mode = "none"
Quick start

Up and running in minutes.

You need rclone and a Rust toolchain. Prebuilt binaries for Linux, macOS and Windows are on the releases page. Details in the getting started guide.

  1. 1

    Clone the repository

    Get the latest source from GitHub.

    git clone https://github.com/iocast/rcmate.git && cd rcmate
  2. 2

    Build

    The binary ends up in target/release/rcmate (rcmate.exe on Windows).

    cargo build --release
  3. 3

    Run

    Default config path is ~/.config/rcmate/config.toml.

    cargo run -- --config ~/.config/rcmate/config.toml
Keyboard first

Your hands never leave the keys.

Select pairs, start syncs, tweak options and inspect errors without touching the mouse.

↑↓ Move selection
Space Toggle selection
a Toggle all pairs
Ctrls Start sync
Ctrla Add sync pair
e Edit pair
o Pair options
p Per-file progress
Alte Show error
q Quit

All keybindings →

Make rclone a joy to use.

Grab a release, read the docs or contribute on GitHub.

Read the docs View on GitHub