Expand description
Operator CLI parser + verb runtime for fathomdb.
Surface owned by dev/interfaces/cli.md. Phase 10a wires the parser
scaffold to real engine seam calls: doctor check-integrity,
doctor safe-export, doctor trace, recover --rebuild-projections,
recover --rebuild-vec0, and recover --excise-source invoke the
corresponding fathomdb::Engine methods and serialize the typed
report under the per-verb JSON discriminator.
Modules§
- exit_
code - Stable exit-code classes for the operator CLI.
Structs§
- Check
Integrity Args - Per-verb argument set for
doctor check-integrity. - Cli
- Top-level CLI invocation.
- Doctor
Args - Wrapper carrying the doctor verb table beneath the
doctorroot. - Dump
Mutations Args - Slice 34 — argument set for
doctor dump-mutations <collection> [--after-id <n>] [--limit <n>] [--json] <db_path>. A read-only operator diagnostic that pages the op-store mutation log over the existingEngine::read_mutationsseam. - Recover
Args - Argument set for the
recoverroot command. - Safe
Export Args - Per-verb argument set for
doctor safe-export. - Simple
Doctor Args - Shared args for doctor verbs whose only options are
--jsonand a required<db_path>positional.cli.md§ Output posture:--jsonis the normative machine-readable contract on every verb. - Trace
Args - Per-verb argument set for
doctor trace. - Verify
Embedder Args - Per-verb argument set for
doctor verify-embedder.cli.md(amended 2026-05-15) locks the invocation asverify-embedder --identity <s> --dimension <n> <db_path>. - Warm
Cache Args - EU-5b —
fathomdb doctor warm-cacheargument set.
Enums§
- CliOutcome
- Outcome classes that map to the stable exit-code matrix in
dev/interfaces/cli.md§ Exit-code classes. - Command
- Root command verbs.
- Doctor
Command - Doctor verb table per
dev/interfaces/cli.md§ Doctor verbs.
Functions§
- effective_
dump_ limit - Resolve the effective
doctor dump-mutationspage limit: the operator’s--limit(or the default when omitted), clamped to the engine page cap [DUMP_MUTATIONS_MAX_LIMIT]. Pure + total so the clamp is unit-pinned without seeding a >1M-row log (tests/parser.rs). - engine_
error_ to_ outcome - Map an
EngineErrorto theCliOutcomeclass perdev/interfaces/cli.md§ Error to exit-code mapping. - engine_
open_ error_ to_ outcome - Map an
EngineOpenErrorto theCliOutcomeclass perdev/interfaces/cli.md§ Error to exit-code mapping. - outcome_
to_ exit_ code - Map an outcome to the stable exit code defined in
cli.md. - run
- Run a parsed CLI command.