Get started¶

Install¶

uv tool install ckdn          # global CLI
# or as a project dev dependency:
uv add --dev ckdn

The core has zero dependencies. The MCP transport is an optional extra — see Agents & MCP.

Quick start¶

cd your-project
ckdn init                      # writes starter ckdn.toml
# edit commands / parsers / aliases to match the project
echo '.agent-runs/' >> .gitignore

ckdn checks                    # list configured checks
ckdn doctor                    # pre-flight: tools on PATH, commands fit parsers
ckdn run ruff                  # one atomic check
ckdn run lint                  # alias → members (e.g. ruff, pylint)
ckdn run --all                 # every atomic check → one aggregate
ckdn show                      # pretty-print latest digest
ckdn list                      # recent runs

ckdn doctor is worth the one run after ckdn init: it reads the config without starting anything and says which commands cannot work as written. See Pre-flight diagnostics.

Each run writes a directory under .agent-runs/ holding the full log, tool artifacts, provenance (meta.json), and the deterministic digest.json. The digest is the only thing an agent should read; see Digests & schemas.

One command, drop-in

ckdn run exits with the original command's code, so it slots into any hook or CI step where the raw command used to be — with a bounded digest as a side effect. See the exit-code contract.