Invocation#
transcript-lake [--data-dir <path>] doctor [--json]Purpose#
Check the declared masking policy, state, cursors, source discovery, DuckDB, and Oko availability.
Inputs and options#
- No positional input is required or accepted.
--jsonemitsdataDir,healthy, and structured checks.
Output and state effect#
Read-only. The human form prints OK, WARNING, or ERROR for the masking policy, state root, cursors, sources, source integrity, DuckDB, and Oko CLI. Missing optional dependencies and an absent zero-state are warnings or healthy states; a check marked error makes the command non-zero.
The masking-policy check reads and validates the declaration ingestion uses, with the same masker: the file named by TRANSCRIPT_LAKE_SECRET_FORMATS, or the declaration shipped with Transcript Lake when the setting is unset or empty. An unreadable declaration (cannot be read), a file that is not JSON at all (not a secret-format declaration), a missing class, an unknown field or an invalid pattern (invalid assignment pattern and the like) is an error retaining the actual cause and the declared file path. Name a valid declaration as described in Masking guarantees, or unset the variable to use the shipped one; the diagnostic never substitutes null classes for a declaration it could not read.
A valid policy reports declared secret formats are readable and valid; ingestion was not run. This proves configuration can be read, not that source adoption, streaming or catalogue synchronization succeeded. Doctor does not ingest transcripts, publish events, initialize the Lake or change its selected source.
Exact refusals#
- Any positional argument is refused as
doctor accepts flags only. - An unrecognized
--watis refused asunknown doctor flag: --wat. - Repeating
--jsonis refused asdoctor received duplicate --json.
All long flags are exact and single-use. A value flag never consumes another --flag. Global --data-dir may appear anywhere in the invocation, must appear once, and selects an absolute root.