Install¶

Choose an installation¶

Install with	What it installs	Command
Homebrew	Runeward CLI for macOS or Linux	`brew install Runewardd/tap/runeward`
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 Runeward API; they do not replace the CLI/runtime.

Homebrew — CLI¶

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

brew install Runewardd/tap/runeward
runeward version
runeward quickstart

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/Runewardd/runeward/main/install.sh | sh

Pin a release or location:

RUNEWARD_VERSION=v0.3.0 RUNEWARD_BIN_DIR="$HOME/.local/bin" \
  sh -c "$(curl -fsSL https://raw.githubusercontent.com/Runewardd/runeward/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 Go 1.26.6 to use unreleased changes:

git clone https://github.com/Runewardd/runeward
cd runeward
go build -o bin/runeward ./cmd/runeward
./bin/runeward version

Container images¶

Published multi-architecture images:

docker pull ghcr.io/runewardd/runeward:latest
docker pull ghcr.io/runewardd/runeward-egress:latest
docker pull ghcr.io/runewardd/runeward-agent:latest
docker pull ghcr.io/runewardd/runeward-sandbox:latest

Images and release checksums are signed by the release workflow. Verification examples are in SECURITY.md.

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.