For agents: Skip to article. Documentation index. Read this page as Markdown.
Scull
Guide

Quick start

Install from a checkout, run local lookups, and optionally enable search.

Read as Markdown

Requires Git, Python 3.9+, and uv. Clone the repository, then run the commands from its root:

git clone https://github.com/caseyrfsmith/scull.git
cd scull
uv sync
uv run scull list
uv run scull get schema schema_version
uv run scull context schema schema_version
uv run scull caveats schema
uv run scull validate

scull list includes the bundled schema concept; get returns JSON for schema_version, and validation reports valid schemas with exit code 0.

The bundled example describes the schema format. These commands read local YAML without credentials or a model. The example is experimental; context exposes its review state.

Use your own files

export SCULL_SCHEMA_PATH=/path/to/schemas
uv run scull list

To create schemas, follow build a schemaset.

uv sync --extra local
export SCULL_EMBED_PROVIDER=local
uv run scull-schemafier kg build --force
uv run scull search "how is the schema hash calculated?"

The first run downloads MiniLM. Index and query embeddings must be compatible. For a disconnected machine, stage dependencies and model files first: offline setup.