Reference
Use this section to look up exported APIs, record fields, commands, and HTTP contracts. Task procedures remain in the guides.
| Section | Contents |
|---|---|
| Crates | One page per workspace crate, with public types, traits, error variants, and feature flags. |
| Lexicons | One page per dev.idiolect.* lexicon, with field-by-field shape. |
| CLI | Every shipped idiolect subcommand, its flags, and its output. |
| HTTP query API | Every endpoint exposed by the orchestrator, request and response shape. |
| Stability and versioning | The pre-1.0 stability policy. |
The reference covers idiolect 0.12.1 with panproto 0.71.0. For older releases, use the release archive.
Extension and API path
For an advanced integration, follow the lookup path that matches the extension boundary:
| Extension boundary | Start here | Then inspect |
|---|---|---|
| Add a record family or emitter target | idiolect-codegen | RecordFamily and the emit functions |
| Add a stream, handler, or cursor backend | idiolect-indexer | Trait signatures, feature flags, and error variants |
| Add a lens resolver or schema loader | idiolect-lens | Resolver, loader, apply-input, and apply-output types |
| Add an observation or verification method | idiolect-observer or idiolect-verify | Generated taxonomies and implementation traits |
| Integrate over process boundaries | CLI or HTTP API | Exact flags, query parameters, response envelopes, and errors |
For wire-level extensions, begin with the lexicon index and follow each page's source link to the authoritative JSON.
Authority policy
For published Rust crates, rustdoc on docs.rs is authoritative. For
workspace-only crates, build rustdoc from the current checkout. The
JSON under lexicons/dev/idiolect/ defines record shape. If this book
disagrees with either source, use the source and file an issue.