archival schemas

Options

-o, --object <name>

generate the schema for a single object type. If omitted, schemas for all objects are generated.

-i, --inline

print the schema to stdout instead of writing schema files.

-p, --pretty

prettify (indent) the JSON output before printing or writing.

-h, --help

print help for this command.

Arguments

[path/to/archival-site]

optionally specify a path to an archival site. By default will run in the current working directory.

Generates JSON Schema files from your site’s object definitions. These schemas describe the exact shape of each object type, which is useful for editor autocomplete and inline validation while you hand-edit object toml files, for validating data in CI, and for sending to LLMs that support structured outputs.

By default, a schema file is written for each object type (plus a root schema) into your site’s schemas_dir (schemas unless overridden in manifest.toml). To reference a generated schema from an object file, add a schema directive at the top of the file, for example:

#:schema ./schemas/post.schema.json