Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

GUI — Desktop Application

Download the installer for your platform from the releases page:

PlatformInstaller type
macOS (Apple Silicon / Intel).dmg disk image
Windows.msi installer
Linux.AppImage or .deb package

After installing, see Troubleshooting if macOS blocks the app from opening.

CLI — Command Line

For most users, Cargo install is the recommended path.

Option 1 — Install with Cargo (recommended)

cargo install hydra-cli

Requires Rust ≥ 1.95 (install via rustup.rs).

After installing, verify with:

hydra -V

Option 2 — Pre-built binary (no Rust required)

Download the hydra binary for your platform from the releases page and place it somewhere on your PATH.

macOS — Pre-built CLI binaries are currently not notarised. If Gatekeeper blocks the binary, remove the quarantine flag:

xattr -d com.apple.quarantine hydra

Building from Source

If you want to build Hydra yourself (e.g. to contribute or run the test suite):

Prerequisites

git clone https://github.com/neeraip/hydra
cd hydra
just setup          # optional: install Cargo deps, frontend deps, and CLI tools (needs pnpm)
just build          # debug build
just release        # optimised release build (fat LTO, embeds the GUI frontend — needs Node/pnpm)
just test           # run the full test suite