← Documentation

Getting started

Build rcmate from source and run it for the first time.

Requirements

  • rclone installed and on your PATH (or pass its location with --rclone)
  • A Rust toolchain with cargo to build from source

Prebuilt binaries for Linux, macOS and Windows are published on the releases page.

Build from source

git clone https://github.com/iocast/rcmate.git
cd rcmate
cargo build --release

The compiled binary is located in target/release/rcmate (or rcmate.exe on Windows).

Cross-compile

# Windows (GNU)
cargo build --release --target x86_64-pc-windows-gnu

# Windows (MSVC)
cargo build --release --target x86_64-pc-windows-msvc

# Linux
cargo build --release --target x86_64-unknown-linux-gnu

Run

The default configuration path is ~/.config/rcmate/config.toml.

# Run with specific rclone config, workdir and app config
cargo run -- --rclone-config ~/.config/rcmate/rclone.conf --workdir ~/.local/state/rcmate/sync --config ~/.config/rcmate/config.toml

# Run with just the app config (uses default rclone settings)
cargo run -- --config ~/.local/state/rcmate/config.toml

Next steps