Documentation / Operate

CLI command reference

Exact invocations, inputs, outputs, state effects, and source-grounded refusals for every public Transcript Lake CLI command.

sh
transcript-lake [--data-dir <path>] <command> [flags]

This is the complete public command tree. Every top-level command and every leaf subcommand has its own canonical page.

No command, -h, or --help prints general help without reading or writing state. -V/--version prints the package version. Global --data-dir may appear anywhere, must appear once, and selects an absolute root for the invocation and child processes.

Long flags are exact and single-use. Unknown flags are refused as unknown <command> flag: --<name>; duplicates as <command> received duplicate --<name>; a missing value as --<name> requires a value. Unless a page says otherwise, success exits 0 and refusal or failure exits non-zero.

Discover and inspect#

  • pathsPrint every resolved Transcript Lake, derived-data, DuckDB, Tama, and Oko path.transcript-lake [--data-dir <path>] paths [--json]
  • sourcesDiscover supported transcript and hook stores and count candidate files.transcript-lake [--data-dir <path>] sources [--json]
  • adoptValidate, ingest, and persist one discovered existing transcript source through Transcript Lake's canonical boundary.transcript-lake [--data-dir <path>] adopt \ --source <runtime> \ --root <discovered-root> [--json]
  • onboardingWalk the first-use journey and optionally adopt one discovered source through the canonical ingestion boundary.transcript-lake [--data-dir <path>] onboarding [--source <runtime> --root <discovered-root>] [--skip-source] [--reset] [--yes] [--json]
  • doctorCheck the declared masking policy, state, cursors, source discovery, DuckDB, and Oko availability.transcript-lake [--data-dir <path>] doctor [--json]
  • statusInspect Lake partitions, cursor health, live-stream state, and Oko freshness.transcript-lake [--data-dir <path>] status [--json]

Stream and recover#

  • streamContinuously catch up supported sources and commit masked appends into the Lake and Oko projection.transcript-lake [--data-dir <path>] stream [--json]
  • rebuildReplay source history through the masker into a separate empty recovery Lake.transcript-lake [--data-dir <path>] rebuild --to <empty-path> [--source <runtime>]
  • reconcileSupersede canonical rows that the current adapter projects differently from their retained original.transcript-lake [--data-dir <path>] reconcile --source <runtime> [--apply] [--reindex]

Read and analyze#

  • sessionsList the newest sessions from the canonical DuckDB views.transcript-lake [--data-dir <path>] sessions [--runtime <r>] [--project <text>] [--interrupted] [--limit <n>] [--json]
  • eventsList the newest masked canonical events.transcript-lake [--data-dir <path>] events [--runtime <r>] [--session <id>] [--type <type>] [--limit <n>] [--json]
  • searchSearch masked event text using a case-insensitive literal substring.transcript-lake [--data-dir <path>] search <text> [--runtime <r>] [--session <id>] [--type <type>] [--limit <n>] [--json]
  • showReconstruct one masked conversation in chronological order.transcript-lake [--data-dir <path>] show <session-id> [--include <types>] [--limit <n>] [--json]
  • statsSummarize recent Lake activity and token counters by runtime.transcript-lake [--data-dir <path>] stats [--days <n>] [--runtime <r>] [--json]
  • hooksInspect canonical adaptive-hook decision events.transcript-lake [--data-dir <path>] hooks [--decision <value>] [--tool <name>] [--limit <n>] [--json]
  • signalsQuery cross-source Oko/Lake signal views.transcript-lake [--data-dir <path>] signals [--report <frustration|overlap|daily|freshness>] [--limit <n>] [--json]
  • queryExecute operator-supplied DuckDB SQL after loading the canonical Lake views.transcript-lake [--data-dir <path>] query [--json] "<sql>"

Labels and local goal titles#

  • labelRoute operator label writes and label analytics to a public subcommand.transcript-lake [--data-dir <path>] label <add|remove|list|aspects> ...
  • label addAppend one durable, provenance-bearing label to an existing Lake session.transcript-lake [--data-dir <path>] label add <session-id> --aspect <name> --value <v> [--note <text>] [--runtime <r>] [--source <name[:detail]>] [--json]
  • label removeWithdraw the label in force for one session and aspect by appending a record with no value; the history stays whole.transcript-lake [--data-dir <path>] label remove <session-id> --aspect <name> [--note <text>] [--runtime <r>] [--source <name[:detail]>] [--json]
  • label listList the latest label assignment per session and aspect.transcript-lake [--data-dir <path>] label list [--session <id>] [--aspect <a>] [--runtime <r>] [--limit <n>] [--json]
  • label aspectsSummarize the currently assigned label aspects.transcript-lake [--data-dir <path>] label aspects [--json]
  • goalRoute local goal-title inference or model-produced goal labeling.transcript-lake [--data-dir <path>] goal <title|label> ...
  • goal titleDistill caller-supplied text into a short goal title with the qualified local GGUF.transcript-lake [--data-dir <path>] goal title (--text <text>|--stdin) [--json]
  • goal labelInfer a goal from a session’s first masked user prompt and persist it as a model label.transcript-lake [--data-dir <path>] goal label <session-id> [--runtime <r>] [--json]

Derived data and Oko#

  • compactRebuild per-runtime Parquet mirrors from authoritative NDJSON partitions.transcript-lake [--data-dir <path>] compact [--source <runtime>] [--json]
  • projectionReconstruct the per-session projection one consumer imports from authoritative Lake partitions, or hand the current projection to that consumer's own CLI; the consumer is an adapter behind the operation.transcript-lake [--data-dir <path>] projection <rebuild|refresh> --target <oko> [--reindex]
  • cleanPreview or remove rebuildable derived data without touching canonical evidence.transcript-lake [--data-dir <path>] clean [--target <parquet|oko|all>] [--apply] [--json]

Guidance#

  • helpPrint general guidance or exact syntax for one public top-level command.transcript-lake help [command]