CLI Creator for Codex — 可组合 CLI 构建指南
OpenAI 官方指南:教 Codex 创建可复用的命令行工具,并搭配 companion skill 保存使用记忆。
核心思想
当 Codex 反复使用同一个 API、日志源、导出文件或团队脚本时,给它一个可组合的 CLI 接口:
- 从任意文件夹运行
- 可组合(与
git、gh、rg、测试和仓库脚本配合使用) - 支持分页搜索、精确 ID 读取、JSON 输出、文件下载、写前草稿
两个配套 Skill
| Skill | 作用 |
|---|---|
| CLI Creator | 设计命令表面、构建 CLI、添加安装和认证检查、安装到 PATH |
| Skill Creator | 创建 companion skill,教后续 Codex 任务:先运行哪些命令、哪些写操作需要审批 |
使用流程
- 定义 CLI 要做什么:从 Codex 的重复工作出发,而非从你想写的技术出发
- 提供学习来源:文档、OpenAPI spec、curl 命令、导出文件、SQLite 数据库、现有脚本
- 让 Codex 先展示命令表面,确认后再编码
- 验证:从 CLI 源码文件夹之外测试安装后的命令
典型场景
| 场景 | CLI 能力 |
|---|---|
| CI 日志在构建页面后 | 输入构建 URL,下载失败日志到 ./logs,返回文件路径 + 摘要 |
| 支持工单 CSV 导出 | 索引最新导出,按客户或短语搜索,按稳定 ID 读取单条 |
| API 响应过大 | 只列出所需字段,按 ID 读取完整对象,完整响应导出到文件 |
| Slack 长线程导出 | 带 --limit 搜索,读取单线程,返回附近上下文 |
| 团队脚本多步骤 | 拆分为 setup、discovery、download、draft、upload、polling |
验证清单(像未来 Agent 一样测试)
command -v <cli-name>在源码文件夹外成功<cli-name> --help解释主命令- 安装/认证检查正常运行
- 一个安全的 discovery/list/search 命令工作
- 一个精确 read 命令工作(使用 discovery 结果中的 ID)
- 大日志/导出/追踪/负载写入文件并返回路径
- 实时写命令仅在明确批准后才运行
后续复用
不再重复粘贴文档,而是调用 skill:
Use $ci-logs to download the failed logs for this build URL...
Use $support-export to search this week's refund complaints...
Use $admin-api to find this user's workspace...