Getting started

Run your own control tower

Sirloop is self-hosted: run one installer, activate your license with a single click, and everything — the orchestrator, the dashboard, the HTTP API, flows, schedules — runs on your own machine.

Read the guides

Step-by-step, from a fresh machine to scripting the API — the same pages install with the product, published here.

Getting started

Install the MSI, activate your license with one click, and take a one-minute tour of the dashboard — plus fixes for the few things that can trip on day one.

Tutorial: your first run

Dispatch a coding-agent run from the dashboard, then again from curl, watch it stream live over SSE, and read back the result. Five minutes, end to end.

HTTP API reference

Every surface speaks one JSON API on 127.0.0.1:8080 — access rules, the route tables for reads and control, and worked examples.

CLI reference, by version

Every command, option and default — a page per release, generated from the exact binary that release shipped, so it is never stale. Running sirloop? sirloop --help always matches the version you have.

Everything else

Architecture, extension points, and the full plugin wire protocol are installed with the product under docs/ai/http-api.md next to the binary.

Install & activate

Installation is one self-contained installer — no Python setup, no package manager, no build step, no cloud account. Everything Sirloop needs ships inside it.

  1. 1

    Run the installer

    Download Sirloop-Setup.msi from the link in your welcome email and run it. It installs Sirloop and everything it depends on — nothing else to download or configure.

  2. 2

    Activate with one click

    On first launch, paste the license key from your welcome email and click Activate. That's the whole activation flow — no account signup, no browser round-trips.

  3. 3

    Open the dashboard

    Sirloop starts the orchestrator and opens the dashboard at http://127.0.0.1:8080. From there you can dispatch agent runs, watch every live agent stream in over server-sent events, and manage flows and schedules.

Windows is supported today; macOS and Linux installers are coming soon — contact sales if you need early access.

The HTTP API, at a glance

Everything external — the GUI, sirloop add-goal, sirloop-ext, the mobile bridge — talks to the orchestrator over one JSON HTTP API at http://127.0.0.1:8080.

Token-free reads

GET /api/state returns the full Hub snapshot — agents, events, runs, projects, flows, schedules. GET /api/stream is the same data live, over SSE. Poll these freely; never dispatch a run just to check status.

Dispatch & control

POST /api/instruct starts a run. POST /api/flows, /api/schedules, and /api/projects manage and trigger flows, clock schedules, and AI-planned projects.

Plugin wire protocol

POST /v1/agent-events and /v1/agent-events/gate are how hook relays report tool use and ask permission before risky calls — fail-open by design, frozen and versioned.

Remote federation

/api/remotes and the /v1/remote/* routes let one orchestrator pair with another on the same LAN, guarded by an HMAC handshake — fail-closed for inbound control, fail-open for local availability.

Full route reference, request/response shapes, and the plugin protocol details are installed with the product under docs/ai/http-api.md.

Full documentation

Architecture, extension points, and conventions are documented with every install. Not a customer yet? Talk to sales about a license — there's no free tier, but evaluations are available.