Configs#

Katalyst reads a .katalyst/ directory, found by walking upward from the current working directory to the nearest ancestor that contains one. That ancestor is the repo root; all relative paths resolve against it.

The config reference is organized by concept:

  • Discovery: root discovery, symlinks, file layout, formats, and legacy storage paths.
  • Schemas: schema file discovery, naming, and schema handles.
  • Bases: backend stores and their top-level config keys.
  • Collections: collection membership, identity, paths, and per-collection files.
  • Checks: schema: shorthand, checks: entries, text rules, and object-schema precedence.
  • Variants: conditional check routing with when.
  • Listing: default behavior for katalyst item list.

For why the config is shaped this way, see How collections work. To set one up step by step, see Configure checks for a collection.

Layout#

.katalyst/
  config.yaml          # optional: listing defaults and discovery settings
  schemas/             # one JSON Schema file per named schema
    book.json
  bases/               # one file per base
    local.yaml         # a base + the collections it declares
    local/             # optional: one file per collection (escape hatch)
      books.yaml

See also#

  • Check types reference, every check type.
  • Bases, the base / collection-mapping model and its lineage.
  • Collections, the config/collection model and rationale: schema resolution, variants, unmatched-as-error.
Backward The CLI Discovery Forward