Installation & Quickstart

Ratelord is a local-first constraint control plane. Install the daemon, register an identity, and start negotiating intents in just a few commands.

Install the Binary

Build the daemon and the helpers from source using Go 1.23+. The same build also produces the HTTP API daemon (`ratelord-d`) and the interactive TUI (`ratelord-tui`).

go install github.com/rmax-ai/ratelord/cmd/ratelord@latest
go install github.com/rmax-ai/ratelord/cmd/ratelord-d@latest
go install github.com/rmax-ai/ratelord/cmd/ratelord-tui@latest

Verify the install

ratelord version
ratelord-d --version
ratelord-tui --version

Pre-built binaries are also published on GitHub Releases for macOS, Linux, and Windows.

Local Quickstart

1. Start the daemon:
   bash

   ratelord-d

   It creates `ratelord.db` in the current directory and listens on port 8090 by default.
2. Launch the UI:
   bash

   ratelord-tui

   Use the terminal UI to inspect pools, intents, and forecasts.
3. Register an identity:
   bash

   ratelord identity add pat:local user

   Save the returned token; agents must include it when negotiating intents.

Next Steps

_Personal_ deployments can stay on SQLite, but production-grade installs should follow the Configuration Guide and the Architecture Overview to plan providers, policies, persistence, and HA.

When you are ready to run Ratelord in a cluster, read the Troubleshooting Guide and coordinate your deployment with the API Reference.