Skip to content

CLI Capability Map

This page is the compact capability map for the ChatCDN CLI. Keep the documented command tree aligned with the runtime chatcdn --tree and chatcdn --tree-brief output; do not present unimplemented commands as available operations.

Importable Python functions are mapped in Interface Tree. Current package boundaries are tracked in Capability Map.

Top-Level Commands

chatcdn
├── --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.

Base Entries

chatcdn --help           # Verify the command is installed and inspect help
chatcdn --version        # Verify the installed version
chatcdn --tree           # Print the shared Click registry tree with command signatures
chatcdn --tree-brief     # Keep command nodes and descriptions but omit signatures

The command tree is generated by ChatStyle's shared add_tree_option() runtime, with the public root fixed to chatcdn. ChatCDN currently has no parameterized business subcommands, so the existing node labels are the same in both modes; after such commands are added, --tree shows their signatures and --tree-brief omits them.

Business Command Slots

This is a structural placeholder, not a promise of future capability. Only document a command as implemented after the command, Python function, and tests exist.

Status Contract

Status Meaning
Implemented Command, function, and tests exist
Verified Covered by CI, local smoke, or real-service practice
Planned / checkpoint Keep only boundary notes; do not write operation tutorials before implementation

Implementation Contract

  • Every implemented command must map back to a Python function, class, or service layer.
  • If a command writes remote state, document credentials, permissions, dry-run/checkpoint behavior, or confirmation boundaries.
  • When adding a command, update README, the interface tree, capability map, tests, and related flow pages together.