Start

Installing JoyMux

Homebrew (recommended on macOS)

scripts/release/build.sh   # once — produces dist/ + formula

export HOMEBREW_JOYMUX_ROOT="$PWD"
brew tap joyortoy/joymux "$PWD/packaging/homebrew/tap"
brew install joyortoy/joymux/joymux
joymux init
joymux doctor --json

Details: packaging/homebrew/README.md.

One-command local install (release archive)

Safer pattern:

# Review the installer first
less scripts/install.sh

# Install from a local release artifact (no sudo for ~/.local)
sh scripts/install.sh \
  --archive dist/joymux-0.1.0-macos-arm64.tar.gz \
  --manifest dist/manifest.json \
  --prefix "$HOME/.local"

Ensure ~/.local/bin is on your PATH.

First run

joymux init
joymux doctor --json
joymux exec --jsonl -- echo hello

SDKs

See quickstart.md and sdk.md.

Package managers

Channel	Status
Homebrew	Private in-repo tap — binary-only; set `HOMEBREW_JOYMUX_ROOT`; see `docs/private-distribution.md`
crates.io / PyPI / npm	Not for closed source — leave unpublished

Source remains private. Prebuilt archives use packaging/beta/BINARY_LICENSE.md.