跳转至

CLI 能力地图

这篇文档是 ChatCDN CLI 的简明能力地图，用来校对哪些命令已经是一等入口、哪些仍然只是边界或规划。文档中的命令树应与 chatcdn --tree 和 chatcdn --tree-brief 的运行结果保持一致；不要把未实现命令写成已可用操作。

可导入 Python 函数映射见 接口树。当前包能力边界见 能力地图。

顶层命令

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.

基础入口

chatcdn --help           # 验证命令已安装，并查看帮助
chatcdn --version        # 验证当前安装版本
chatcdn --tree           # 输出共享 Click 注册树，命令节点默认包含参数签名
chatcdn --tree-brief     # 保留命令节点与说明，但省略参数签名

命令树由 ChatStyle 的共享 add_tree_option() 运行时生成，公开根名固定为 chatcdn。当前 ChatCDN 还没有带参数的业务子命令，因此两种模式的现有节点标签相同；新增带参数命令后，--tree 会显示签名，--tree-brief 会省略签名。

业务命令槽位

这里是占位槽位，不是未来能力承诺。只有当命令、Python 函数和测试都存在时，才把它写成已实现入口。

状态约定

状态 含义
已实现 命令、函数和测试已经存在
已验证 已通过 CI、本地 smoke 或真实服务实践
规划 / checkpoint 只保留边界说明；实现前不要写操作教程

实现合约

  • 每个已实现命令都要能追到 Python 函数、类或 service 层。
  • 如果命令会写远端状态，文档必须说明凭据、权限、dry-run/checkpoint 或确认边界。
  • 新增命令时，同步更新 README、接口树、能力地图、测试和相关 Flow 页面。