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

Install

Build From Source (All Platforms)

cargo build --workspace
cargo install --path .

GitHub Release Binaries

joy publishes versioned release artifacts to GitHub Releases.

Current artifact set (subject to release workflow updates):

  • joy-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz
  • joy-vX.Y.Z-aarch64-apple-darwin.tar.gz
  • joy-vX.Y.Z-x86_64-apple-darwin.tar.gz
  • joy-vX.Y.Z-x86_64-pc-windows-msvc.zip
  • joy-vX.Y.Z-x86_64-pc-windows-gnu.zip (compatibility artifact)

Homebrew (Single-Repo Tap)

joy publishes and maintains Formula/joy.rb in this repository.

Install and upgrade:

brew tap harnesslabs/joy
brew install harnesslabs/joy/joy
brew upgrade joy

Scoop Metadata

Scoop metadata is maintained at:

  • packaging/scoop/joy.json

Release workflows publish generated package-manager metadata with concrete checksums as release artifacts.

See the Releasing reference for the exact release and packaging workflow.

Required Host Tools (for joy build / joy run)

You need host tools for local C++ builds and compiled recipe-backed dependencies:

  • C++ compiler (clang++, g++, or cl.exe on Windows MSVC)
  • ninja
  • cmake (for compiled recipes)
  • git

Use joy doctor to inspect tool availability and cache/recipe health.