arizuko › reference

reference

Every CLI flag, env var, MCP tool, schema column, grant rule, and JID form in an arizuko deployment. Each page is checked against the current source tree; every entry cites file:line in the repository.

Reference answers "what are the exact arguments?" If you want the mental model first — why routing works the way it does, what a grant actually decides — start in concepts, then come here for the grammar and field lists.

Config & operation

CLI commands

Every arizuko subcommand — 14 top-level commands, 27 sub-actions across instance lifecycle, chat, groups, identities, invites, gates, network, and secrets. Signature, flags, the state each one changes, examples.

Packages

Install / upgrade / remove packages: asset kinds, the installed-package record, dirty-safe upgrade.

Environment variables

Every env var read by any daemon or library — 120 entries across 24 sections. Per-entry: name, read sites with line links, type, default behaviour, effect, example value. The source-of-truth for .env authoring and compose-generation troubleshooting.

Protocol surface

MCP tools

Every tool on the per-group MCP unix socket plus submit_turn, grouped by concern (messages, social actions, history with find_messages full-text search, groups, sessions, scheduling, routing, grants, invites, web, identity, system). Params, return shape, the grant each one needs, registration site.

Store schema

Every table the four owners hold — identity and the unified acl, messages, groups, onboarding, secrets, egress, scheduling. Per entity: the coordinate an item is addressed by, what it carries, and which daemon writes it.

OpenAPI

Every HTTP-serving daemon exposes GET /openapi.json, generated from resreg.Resource.RowType reflection. Per-daemon URLs and what each daemon owns.

Addressing & access

JID format

The typed-JID grammar, per-platform schema for 11 platforms, routing-key extraction, glob semantics. Routing rules and grants speak this language regardless of channel. Narrative twin: concepts › addressing.

Grants

The acl row, the action lattice, evaluation order, the two seeded roles, delegation by subset-of-held, and how a scope glob does containment. The authoritative answer to "can this user do this thing in this folder?" Narrative twin: concepts › authorization.

Route tokens

The route_tokens table and the two URL prefixes that read it: /chat/<token>/ for browser chat, /hook/<token> for webhook ingest. Schema, mint surface, who may mint, payload shapes, SSE events, rate limits. Narrative twin: concepts › tokens.

Topics

Topic schema columns, creation paths (inline #name, /new, Discord threads, Telegram forum topics), the effectiveTopic resolution order, and the MCP tools that read or mutate topic state. Narrative twin: concepts › topics.

Conventions

Every entry links to source at github.com/kronael/arizuko/blob/main/<path>#L<line>. If a citation 404s, the page is stale — file a bug.
Pages capture actual current state, not spec aspirations. Unshipped fields are marked or absent.
One renderer per page; cross-references are one-way pointers to keep the drift surface flat.