Install¶

Choose an installation¶

Install with	What it installs	Command
Homebrew	Rune Box CLI for macOS or Linux	`brew install Runeeward/tap/runebox`
PyPI	Python client and agent-framework adapters	`python -m pip install runeward`
npm	TypeScript client and agent-framework tools	`npm install @runeward/sdk`

For normal local use, install the CLI with Homebrew. For an agent integration, install the SDK for its language as well. The pip and npm packages connect to a running Rune Box API; they do not replace the CLI/runtime.

Homebrew — CLI¶

Homebrew installs the current signed CLI release on macOS or Linux:

brew install Runeeward/tap/runebox
runeward version
runeward quickstart

The formula was named runeward before v0.4.2. brew upgrade moves an existing install to runebox, and the command is still runeward.

Local sandboxes also require a running Docker, OrbStack, or Podman engine.

pip — Python SDK¶

Requires Python 3.9 or newer. The base client has no third-party runtime dependencies.

python -m pip install runeward
python -c "import runeward; print(runeward.__version__)"

npm — TypeScript SDK¶

Requires Node.js 18 or newer.

npm install @runeward/sdk
npm ls @runeward/sdk

See Adapters for optional framework dependencies.

Signed release installer (macOS/Linux alternative)¶

The installer requires curl or wget, tar, a SHA-256 utility, and cosign. It fails closed: the signed checksum manifest is verified before the archive checksum and install.

curl -fsSL https://raw.githubusercontent.com/Runeeward/RuneBox/main/install.sh | sh

Pin a release or location:

RUNEWARD_VERSION=v0.4.3 RUNEWARD_BIN_DIR="$HOME/.local/bin" \
  sh -c "$(curl -fsSL https://raw.githubusercontent.com/Runeeward/RuneBox/main/install.sh)"

The shell installer supports macOS and Linux. Windows CLI archives are available from GitHub Releases; the in-sandbox helpers are Linux binaries because they run inside Docker or Kubernetes.

From source¶

The documentation follows main. Build from source with Rust 1.95 or newer to use unreleased changes:

git clone https://github.com/Runeeward/RuneBox
cd RuneBox
cargo build --release --locked -p runeward-cli --bin runeward
./target/release/runeward version

The Linux-only helpers build the same way: -p runeward-egress, -p runeward-supervisor and -p runeward-browser.

Container images¶

Published multi-architecture images:

docker pull ghcr.io/runeeward/runeward:latest
docker pull ghcr.io/runeeward/runeward-egress:latest
docker pull ghcr.io/runeeward/runeward-agent:latest
docker pull ghcr.io/runeeward/runeward-sandbox:latest
docker pull ghcr.io/runeeward/runeward-ide:latest
docker pull ghcr.io/runeeward/runeward-ide-agents:latest

Images and release checksums are signed keylessly by the release workflow. The repository was renamed from Runeeward/runeward to Runeeward/RuneBox, so the identity accepts both names. Verify checksums.txt from a release:

cosign verify-blob --bundle checksums.txt.sigstore.json \
  --certificate-identity-regexp '^https://github\.com/Runeeward/(runeward|RuneBox)/\.github/workflows/release\.yml@refs/tags/.*$' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  checksums.txt

Verify an image:

cosign verify ghcr.io/runeeward/runeward:<tag> \
  --certificate-identity-regexp '^https://github\.com/Runeeward/(runeward|RuneBox)/\.github/workflows/release\.yml@refs/.*$' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

See SECURITY.md for more.

Runtime prerequisites¶

Docker, OrbStack, or Podman for local sandboxes.
Optionally Kubernetes and Helm for cluster deployments.
Run runeward doctor <policy> before launch to check the selected runtime and image.

Next: Quickstart.