Installation

Remora is built from source with Rust. There are two programs: the desktop app remora, and the optional server remora-server.

Requirements

  • Rust 1.88 or newer (install from rustup.rs).
  • Windows: the Visual Studio C++ Build Tools with a Windows SDK. Rust needs them for linking, and Remora also uses the SDK's resource compiler to embed its icon.
  • macOS / Linux (X11): should build, but isn't regularly tested yet. On Linux you need development packages for X11/xcb, D-Bus and PipeWire; the build tells you which ones are missing. Wayland isn't supported yet.

Build

bash
cargo build --release

The binaries end up in target/release/. The app is a single file (remora.exe on Windows) with no installer, so you can copy it to another computer and run it there.

First launch

Start the app:

bash
cargo run --release -p remora

On first launch Remora creates a random 9-digit ID and a one-time password, and shows both on the Home page. They're what a partner needs to connect to you.

Where Remora keeps things

WhatWhere
Settings, contacts, IDconfig.json in the config folder: %APPDATA%\Remora on Windows, ~/Library/Application Support/Remora on macOS, ~/.config/Remora on Linux
Received filesDownloads/Remora in your home folder

Set REMORA_CONFIG_DIR to use a different config folder, which is handy for running two copies side by side (see Command line).

Next steps

To connect two computers by ID, both need to reach the same Remora server: host one, or connect directly by IP without a server. Then make your first connection.