Installation

HyperRoute Core ships as a single binary called routerd. Pick the installation method that fits your workflow.

---

Install Script (Recommended)

The fastest way to get started. Downloads the latest release for your platform:

curl -fsSL https://install.hyperroute.dev | sh

This installs routerd to ~/.hyperroute/bin and adds it to your PATH.

Verify the installation:

routerd --version

---

Docker

Pull the official image:

docker pull hyperroute/routerd:latest

Run with a local config:

docker run -p 4000:4000 -v ./router.yaml:/etc/hyperroute/router.yaml \
  hyperroute/routerd:latest serve --config /etc/hyperroute/router.yaml

Available tags: latest, 0.1.0, nightly.

---

Homebrew (macOS)

brew tap hyperroute/tap
brew install routerd

---

Build from Source

Requires Rust 1.75+:

git clone https://github.com/hyperroute/hyperroute-core.git
cd hyperroute-core
cargo build --release

The binary is at target/release/routerd.

---

CLI Reference

routerd serve

Start the router. This is the primary command for running HyperRoute.

routerd serve [OPTIONS]

Examples:

# Start with defaults
routerd serve

# Custom config and port
routerd serve --config production.yaml --port 8080

# Debug logging
RUST_LOG=debug routerd serve

routerd init

Scaffold a new HyperRoute project:

routerd init [OPTIONS]

This generates a starter hyperroute.yaml, example subgraph schemas, and a Docker Compose file for local development.

---

System Requirements

HyperRoute is built in Rust with zero garbage collection. Memory usage stays flat regardless of traffic volume.

---

Next Steps

• Getting Started — Run your first federated query in 5 minutes
• Configuration — Full configuration reference
• Deployment — Production deployment guides