reference

arizuko › reference

Comprehensive, grep-verifiable reference for every configurable surface of an arizuko deployment. Each page is generated against the current source tree; every entry cites file:line in the repository.

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.

Source-of-truth for .env authoring and compose-generation troubleshooting.

CLI commands

Every arizuko subcommand — 14 top-level commands, 27 sub-actions, 8 sections (instance lifecycle, chat, groups, identities, invites, gates, network, secrets). Signature, flags, what state it changes, examples.

README's daemon-table is the elevator pitch; this page is the contract.

MCP tools

Every tool exposed on the per-group MCP unix socket plus submit_turn, grouped by concern (messages, social actions including pin/unpin, history with find_messages full-text search, groups, sessions, scheduling, routing, grants, invites, web, identity, system). Params, return shape, tier badge, registration site.

What the agent can call. Mirrors the operator surface in CLI where applicable.

SQLite schema

Every live table in messages.db — identity + unified acl, messages, groups, onboarding, secrets, egress, scheduling. Per-table: columns, indexes, writer call sites, reader summary, migration history.

gated owns migrations; this page tracks the shape readers can rely on.

Grants

Grant rule grammar, tier defaults, the tool-by-tool tier and containment table, unified acl + acl_membership semantics. Worked example reproduced verbatim from GRANTS.md.

The authoritative answer to "can this user do this thing in this folder?"

Topics

Topic schema columns, creation paths (inline #name, /new, Discord threads, Telegram forum topics), the effectiveTopic resolution order, and the MCP tools (reset_session, inspect_session) that read or mutate topic state. Source cites for every claim.

Narrative intro at concepts/topics.

JID format

The typed-JID grammar, per-platform schema (11 platforms: telegram, discord, whatsapp, mastodon, reddit, bluesky, twitter, linkedin, email, web, slack), routing-key extraction, glob semantics.

Routing rules and grants speak this language regardless of channel.

Route tokens

The route_tokens table plus the two URL prefixes that read it: /chat/<token>/ for browser chat, /hook/<token> for webhook ingest. Schema, mint surface (MCP + REST), tier scope, payload shapes, SSE events, rate limits.

The contract for visitor chat URLs and inbound webhooks alike.

OpenAPI

Every HTTP-serving daemon exposes GET /openapi.json. Generated from resreg.Resource.RowType reflection — one walk over the registry produces components/schemas and paths./v1/<name> for the four CRUD verbs. Public, cached, codegen-ready.

Per-daemon URLs + what each daemon owns.

Codebase stats

LOC and test coverage by package — daemon-by-daemon snapshot of the source tree.

Conventions