Skip to content

CLI Tree

ChatWord uses the shared chatstyle.add_tree_option() runtime to render the real registered Click command surface:

  • chatword --tree includes parameter signatures for interface review.
  • chatword --tree-brief keeps the same nodes and descriptions without parameter signatures.

Planned capabilities are not presented as callable interfaces.

Full command tree

chatword
├── --help  # Show this message and exit.
├── --version  # Show the version and exit.
├── --tree  # Print the registered CLI tree and exit.
├── --tree-brief  # Print the registered CLI tree without parameter signatures and exit.
├── extract [PATH] [--output OUTPUT] [--force] [--interactive]  # Extract plain text from a supported document.
└── inspect [PATH] [--json] [--interactive]  # Inspect a Word or PDF file before deeper processing.

Brief command tree

chatword
├── --help  # Show this message and exit.
├── --version  # Show the version and exit.
├── --tree  # Print the registered CLI tree and exit.
├── --tree-brief  # Print the registered CLI tree without parameter signatures and exit.
├── extract  # Extract plain text from a supported document.
└── inspect  # Inspect a Word or PDF file before deeper processing.

Command boundaries

Command Required input Output Side effects Boundary
chatword inspect PATH Local document path Text or --json metadata Reads a local file Does not read or print credentials; unknown types return metadata only
chatword extract PATH Local .docx or .pdf path stdout or an --output file Reads a document; writes locally when output is selected Refuses overwrite by default; --force applies only to the output and never permits replacing the input

Input contract

  • A missing PATH is recoverable: -i may prompt when a TTY is available.
  • -I disables prompting for agents, CI, and shell automation.
  • inspect --json is the machine-readable metadata surface; extract uses stdout or an explicit file.

Update rule

  • Do not implement a package-local tree renderer; ChatStyle renders both views from the real Click registry.
  • When commands change, update CLI help/tree tests, this runtime readback, the capability map, and the README command summary together.