CLI Capability Map¶
This page is the compact capability map for the ChatNote CLI. Use it to review which commands are first-class entries and which are still boundary or planned slots. After scaffolding, update it with the real command tree; 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¶
chatnote # ChatNote command-line entry
├── --help # Show CLI help and registered commands
├── --version # Print the current package version
├── --tree # Print the registered CLI tree with parameter signatures
└── --tree-brief # Print command nodes and descriptions without signatures
Base Entries¶
chatnote --help # Verify the command is installed and inspect the current command tree
chatnote --version # Verify the installed version
chatnote --tree # Read back the CLI contract with parameter signatures
chatnote --tree-brief # Read back command nodes and descriptions only
--help, --version, --tree, and --tree-brief are the scaffolded verification entries. ChatStyle's add_tree_option() provides both tree flags: the default tree keeps parameter signatures, while the brief tree keeps only command nodes and descriptions. When adding business commands, expand each command group separately and annotate every command line.
Business Commands¶
No business subcommands are implemented. Note management remains outside the current skeleton.
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.