Home / Docs / Installation

Installation

From Binary #

The install script downloads the latest release, detects your platform, and verifies checksums automatically.

bash 
curl -fsSL https://raw.githubusercontent.com/bvc3at/friring/main/scripts/install.sh | sh

This installs to ~/.local/bin by default. The script handles:

  • Platform detection (Linux/macOS, x86_64/aarch64)
  • Automatic version fetching with API rate limit fallback
  • SHA256 checksum verification
  • Creating ~/.local/bin if needed
  • Post-install instructions

Custom install directory

bash 
curl -fsSL https://raw.githubusercontent.com/bvc3at/friring/main/scripts/install.sh | INSTALL_DIR=/usr/local/bin sh

Specific version

bash 
curl -fsSL https://raw.githubusercontent.com/bvc3at/friring/main/scripts/install.sh | VERSION=v0.20.0 sh

Windows (PowerShell)

Experimental. Windows support is experimental for now — the core works (psmux as the multiplexer, a native ConPTY backend, WSL distros as remote hosts), but it sees less testing than Linux/macOS. Expect rough edges and please report issues.

On native Windows the install script is PowerShell. It installs to %LOCALAPPDATA%\Programs\friring (added to your user PATH) and uses psmux as the multiplexer.

powershell 
irm https://raw.githubusercontent.com/bvc3at/friring/main/scripts/install.ps1 | iex

Pin a version or an install directory with the FRIRING_VERSION / FRIRING_INSTALL_DIR environment variables.

Available platforms

Platform Architecture Artifact
Linux (glibc) x86_64 friring-v{ver}-x86_64-unknown-linux-gnu.tar.gz
Linux (musl) x86_64 friring-v{ver}-x86_64-unknown-linux-musl.tar.gz
macOS Apple Silicon friring-v{ver}-aarch64-apple-darwin.tar.gz
Windows x86_64 friring-v{ver}-x86_64-pc-windows-msvc.zip

Homebrew #

On macOS or Linux, install the prebuilt binaries with Homebrew. This repo is the tap — the formula lives at HomebrewFormula/friring.rb — so the tap URL is spelled out, since brew tap only infers one from a repo named homebrew-friring :

bash 
brew tap bvc3at/friring https://github.com/bvc3at/friring
brew install bvc3at/friring/friring

This installs friring and friring-cli , pulling in tmux and git as dependencies. Supported on macOS Apple Silicon and Linux x86_64 (Intel macOS and aarch64 Linux have no release binary — use cargo or build from source there).

With cargo #

Any platform with a Rust toolchain. This is the route for platforms with no prebuilt binary — Intel macOS and aarch64 Linux:

bash 
cargo install --git https://github.com/bvc3at/friring --locked

Builds and installs friring and friring-cli into ~/.cargo/bin .

From Source #

bash 
git clone https://github.com/bvc3at/friring.git
cd friring
cargo build --release

The binary will be at target/release/friring . Requires Rust 1.75+.

Prerequisites #

Dependency Required Purpose
tmux >= 3.2 (or psmux on Windows) Yes Session backend
A coding-agent CLI Yes e.g. claude , codex, antigravity, opencode, aider, copilot, vibe, pi, or omp — whichever agents you plan to run
git Yes Worktree features
Rust 1.75+ Optional Building from source

Quick Start #

  1. Launch Friring — run friring in your terminal. You'll see the session sidebar and a terminal panel.
  2. Create a session — press Ctrl+N to open the repo picker. Pick repos (optionally a worktree), name the session, then choose an agent and a model.
  3. Work with the agent — the terminal panel shows the live agent session. All keys are forwarded to the PTY.
  4. Navigate — Ctrl+L / Ctrl+H cycle pane focus, Ctrl+J / Ctrl+K switch sessions.
  5. Quit — Ctrl+Q detaches all sessions (tmux keeps them running). They resume on next launch.

Configuration #

Session state is stored in SQLite at ~/.local/share/friring/friring.db ( $XDG_DATA_HOME respected). Agent definitions live in ~/.config/friring/agents.toml (seeded on first run). Logs go to ~/.local/share/friring/friring.log .

Uninstall #

Remove the binaries, depending on how you installed them:

bash 
rm ~/.local/bin/friring ~/.local/bin/friring-cli   # curl one-liner / manual install
brew uninstall bvc3at/friring/friring              # Homebrew
cargo uninstall friring                            # cargo install

On Windows, delete %LOCALAPPDATA%\Programs\friring and drop it from your user PATH .

Sessions outlive Friring in tmux, so stop them too — and optionally delete state and config (this erases session history, theme, and agents.toml ):

bash 
tmux -L friring kill-server    # ends all running agent sessions
rm -rf ~/.local/share/friring ~/.config/friring   # optional: wipe state