Scull separates documentation preparation from lookup.
Build
A vocabulary names concepts, fields, and aliases. Parsers read structured specs; a configured LLM
drafts facts and caveats from prose. Deterministic reconciliation combines them into .schema.yaml.
Review the facts, quoted evidence, and field attachments. A correct warning attached to the wrong field is still a bad artifact. Commit the reviewed output.
Query
| Command | Reads | Model needed? |
|---|---|---|
get, context, caveats |
Local schemas | No, with default output |
search |
Compatible index | Hosted or local query embeddings |
get --format=human |
Schema plus rendering model | Yes |
context returns requested fields with attached and concept-wide caveats. Search discovers fields
when their names are unknown. Scull returns reference material; a host agent generates the answer.
Update
Source hashes track input changes. Schema hashes track compiled content. Rebuild and review when sources change; rebuild the index when its inputs or embedding configuration change. Distribute matching schemas and indexes together.
Deterministic lookup does not establish factual correctness or completeness. Keep original docs available for context outside the compiled artifact.
See build a schemaset, review, and index format.