arizuko › reference
reference
The exact arguments of an arizuko deployment: CLI commands, env vars, MCP tools, store entities, grant rows and JID forms. Each page links to the source file that holds the fact.
A reference page answers "what are the exact arguments?". For the model behind them, for example why routing works as it does or what a grant decides, start in concepts and come back here for the grammar and the field lists.
Three pages cover configuration and operation
CLI
The arizuko subcommands for the instance lifecycle, manifests, packages, chat, groups, invites, gates, budgets, network, routes and secrets: signature, flags, the state that each one changes, and examples.
Packages
Select, install and remove packages: the selection rows, the order, the asset kinds, the installed-package record and the upgrade that refuses local changes.
Environment variables
The env vars of the daemons, grouped by daemon. For each one: the read site with a line link, the type, the default, the effect and an example. The last section names the variables that the page does not describe.
Three pages cover the protocol surface
MCP tools
The tools on the per-group MCP unix socket and submit_turn, grouped by concern: messages, social actions, history and search, groups, sessions, scheduling, routing, egress, grants, invites, web and identity. Parameters, return shape, the grant of each tool and its source.
Store schema
The entities of the four owners: identity and the acl, messages, groups, onboarding, secrets, egress and scheduling. For each entity: the key of an item, what it carries and which daemon writes it.
OpenAPI
Every HTTP daemon serves GET /openapi.json, generated by reflection from resreg.Resource.RowType. The URL of each daemon and the resources that it owns.
Four pages cover addressing and access
JID format
The JID grammar, the shape for each platform, the routing keys and the glob rules. Routes and grants use this format for every channel. Narrative page: concepts › addressing.
Grants
The acl row, the action lattice, the evaluation order, the two seeded roles, delegation of a subset of held rows, and how a scope glob contains a folder. The answer to "can this user do this in this folder?". Narrative page: concepts › authorization.
Route tokens
The route_tokens entity and its two URL prefixes: /chat/<token>/ for browser chat and /hook/<token> for webhooks. The tools that make tokens, who can make them, payload shapes, SSE events and rate limits. Narrative page: concepts › tokens.
Topics
Where topic state lives, the four ways a topic starts, the order that picks the active topic, and the MCP tools for topic sessions. Narrative page: concepts › topics.
Every entry links to the source
- A link points at
github.com/kronael/arizuko/blob/main/<path>, with#L<line>where the line is known. A link that does not resolve is a bug in the page. - A page describes the code as it is. A field that the code does not have is absent or marked.
- Cross-references point one way, from a reference page to its narrative page, so each fact has one home.