Documentation / CLI

transcript-lake help

Print general guidance or exact syntax for one public top-level command.

Invocation#

sh
transcript-lake help [command]

Purpose#

Print general guidance or exact syntax for one public top-level command.

Inputs and options#

  • Optional [command] is one exact top-level command name. Nested names are documented through their group help and dedicated web pages.
  • No global state selection is needed because help does not read the Lake.

Output and state effect#

Read-only and state-free. With no topic it prints the general usage tree. With one known topic it prefixes that command’s syntax and safety guidance with Usage: transcript-lake [--data-dir <path>].

Exact refusals#

  • More than one topic: help accepts at most one command name.
  • Unknown topic: unknown help topic: <topic>.

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.

Back to the complete CLI command tree.