Reference

The files in an instance repository, the usine command, and the public API of the @usine packages.

The configuration reference lists every field of the files usine reads from an instance repository, and the commands of the usine CLI. The site build generates the API reference from the TSDoc comments of the published @usine/* packages.

Configuration

usine.yaml: the instance settings.
Loop files: the files under loops/, one Loop each.
Agent files: the files under agents/, one Agent each.
Expressions: the CEL used by Loop conditions and prompt templates.
CLI: the usine commands, their flags, and the environment variables they read.

API

A package’s public API is the set of subpaths in its exports map, such as @usine/core/run. Each package page lists those subpaths; modules that no subpath exports are internal, and this reference doesn’t document them.

@usine/core: the domain model, from Event to Run, Step, and Attempt, with the typed failures.
@usine/expression: checks and evaluates the CEL expressions in Loop files.
@usine/config: parses, validates, and rewrites usine.yaml, Loop files, and Agent files.
@usine/github: GitHub App authentication, polling, and item and label writes.
@usine/engine: the event ledger, Run scheduling, restart recovery, and the SQLite store.
@usine/agents: the Claude Code, Codex, and Pi child backends, Attempt prompts, and preflight.
@usine/durable: the Pi parent of each Attempt, on durable storage that persists across restarts.
@usine/executor: the Worker contract and its local, exe.dev, and SSH adapters.
@usine/gateway: the proxy that adds credentials to Worker traffic and enforces the egress allowlist.
@usine/orchestrator: the full engine as one Effect layer that can run in-process.

Reference

Configuration

API

Guides

Architecture

Reference