如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
Codex

Codex 使用场景

创建 Codex 能用的 CLI

为 Codex 提供可组合使用的命令,让它能调用 API、访问日志源、处理导出数据或运行团队脚本。

难度 Intermediate
时间跨度 1h

请 Codex 创建一个可组合使用的 CLI。Codex 可以在任意文件夹中运行它,将它与代码仓库中的脚本配合使用,用它下载文件,并通过配套技能记住它的用法。

最适合

  • Codex 需要反复对同一服务、导出数据、本地归档或代码仓库中的脚本执行搜索、读取、下载或安全写入操作。
  • 智能体工具需要支持分页搜索、按 ID 精确读取数据、输出格式稳定的 JSON、下载文件、使用本地索引,或提供先生成草稿再写入的命令。

目录

    ← 所有使用场景

    创建 Codex 能用的 CLI

    为 Codex 提供可组合使用的命令,让它能调用 API、访问日志源、处理导出数据或运行团队脚本。

    请 Codex 创建一个可组合使用的 CLI。Codex 可以在任意文件夹中运行它,将它与代码仓库中的脚本配合使用,用它下载文件,并通过配套技能记住它的用法。

    Intermediate
    1h

    请 Codex 创建一个可组合使用的 CLI。Codex 可以在任意文件夹中运行它,将它与代码仓库中的脚本配合使用,用它下载文件,并通过配套技能记住它的用法。

    Intermediate
    1h

    最适合

    • Codex 需要反复对同一服务、导出数据、本地归档或代码仓库中的脚本执行搜索、读取、下载或安全写入操作。
    • 智能体工具需要支持分页搜索、按 ID 精确读取数据、输出格式稳定的 JSON、下载文件、使用本地索引,或提供先生成草稿再写入的命令。

    技能与插件

    • 设计命令接口,构建 CLI,添加配置和身份验证检查,将命令安装到 PATH 所列的目录中,再切换到另一个文件夹验证命令能否正常运行。
    • 创建配套技能,让 Codex 在后续任务中知道应先运行哪些 CLI 命令,以及哪些写入操作需要审批。
    技能 使用理由
    Cli Creator 设计命令接口,构建 CLI,添加配置和身份验证检查,将命令安装到 PATH 所列的目录中,再切换到另一个文件夹验证命令能否正常运行。
    Skill Creator 创建配套技能,让 Codex 在后续任务中知道应先运行哪些 CLI 命令,以及哪些写入操作需要审批。

    起始提示词

    请使用 $cli-creator 创建一个您可以使用的 CLI,并在本次聊天中使用 $skill-creator 创建配套技能。 参考资料:[docs URL, OpenAPI spec, redacted curl command, existing script path, log folder, CSV or JSON export, SQLite database path, or pasted --help output]。 CLI 首先应支持的任务:[download failed CI logs from a build URL, search support tickets and read one by ID, query an admin API, read a local database, or run one step from an existing script]。 可选的写入任务:[create a draft comment, upload media, retry a failed job, or read-only for now]。 命令名称:[cli-name, or recommend one]。 开始编写代码前,请先向我展示拟定的命令接口。如果缺少构建 CLI 所必需的信息,请只向我询问缺少的部分。
    请使用 $cli-creator 创建一个您可以使用的 CLI,并在本次聊天中使用 $skill-creator 创建配套技能。 参考资料:[docs URL, OpenAPI spec, redacted curl command, existing script path, log folder, CSV or JSON export, SQLite database path, or pasted --help output]。 CLI 首先应支持的任务:[download failed CI logs from a build URL, search support tickets and read one by ID, query an admin API, read a local database, or run one step from an existing script]。 可选的写入任务:[create a draft comment, upload media, retry a failed job, or read-only for now]。 命令名称:[cli-name, or recommend one]。 开始编写代码前,请先向我展示拟定的命令接口。如果缺少构建 CLI 所必需的信息,请只向我询问缺少的部分。

    简介

    如果 Codex 经常使用同一个 API、日志源、导出的收件箱、本地数据库或团队脚本,可以把这些操作封装成一个命令。Codex 可以在任意文件夹中运行这个命令,查看和筛选结果,还可以将它与 git、gh、rg、测试和代码仓库中的脚本组合使用。

    添加一个配套技能,说明 Codex 何时应使用这个 CLI、应先运行什么命令、如何控制输出量、下载的文件保存在哪里,以及哪些写入命令需要审批。

    在这个工作流中,$cli-creator 帮助 Codex 创建命令。$skill-creator 帮助 Codex 保存可复用的技能,例如 $ci-logs,方便后续任务按名称调用。

    使用方法

    确定 CLI 要完成的工作

    先明确您希望 Codex 完成什么任务,再考虑用什么技术实现。设计得当的 CLI 可以将反复执行的读取、搜索、下载、导出、起草、上传、轮询或安全写入操作封装成命令,让 Codex 在任意代码仓库中运行。

    场景 Codex 可以用 CLI 做什么
    需要通过构建页面查看 CI 日志。 根据构建 URL 将失败作业的日志下载到 ./logs,并返回文件路径和简短的日志片段。
    每周收到一份导出的支持工单。 为最新导出的 CSV 或 JSON 文件建立索引,按客户或短语搜索,并根据固定 ID 读取单个工单。
    API 响应太大,超出了上下文容量。 只列出所需字段,按 ID 读取完整对象,并将完整响应导出到文件。
    Slack 导出文件中的讨论串很长。 使用 --limit 限制搜索结果数量,读取单个讨论串,只返回匹配内容附近的上下文,无需返回整份归档。
    一个团队脚本会执行四个不同的步骤。 为设置、查找、下载、起草、上传、轮询和实际写入分别提供独立命令。
    插件找到了记录,但 Codex 需要文件。 继续在聊天中使用插件,用 CLI 下载附件、跟踪记录、报告、视频或日志包,并返回文件路径。

    提供文档、文件或命令

    Codex 需要具体的参考资料,例如文档或 OpenAPI 规范、已隐去敏感信息的 curl 命令、导出文件或数据库的路径、日志文件夹,或现有脚本。如果您希望 CLI 沿用熟悉的风格,可以粘贴一小段 --help 输出,示例可来自 gh、kubectl 或您团队自己的工具。

    如果命令需要身份验证,请告诉 Codex 应支持的环境变量名称、配置文件路径或登录流程。请自行在 shell 或配置文件中设置密钥。请勿将密钥粘贴到聊天中。请让 Codex 确保 CLI 在缺少身份验证信息时无法通过设置检查,并明确说明原因。

    让 Codex 创建 CLI 和技能

    使用本页提供的起始提示词,填入供 Codex 参考的资料,以及您希望 CLI 首先支持的任务。

    在编写代码之前,Codex 应先展示拟议的命令及其用法。只有在缺少必要信息、无法继续实现时,才应向您询问这些信息。

    验证命令能否在任意文件夹中运行

    Codex 的测试不应止于运行 cargo run、python path/to/script.py 或尚未安装的软件包提供的命令。请让 Codex 模拟后续任务的实际用法,在另一个代码仓库或临时文件夹中测试安装后的命令。

    按智能体在后续任务中的用法测试 CLI

    请按后续任务中的实际用法测试 [cli-name]。 请提供证据,验证以下各项: - 在 CLI 源码文件夹之外运行 command -v [cli-name] 能成功找到命令 - [cli-name] --help 说明了主要命令的用法 - 设置和身份验证检查能够运行 - 一条安全的查找、列出或搜索命令能正常运行 - 使用查找结果中的一个 ID,能通过读取命令准确读取对应记录 - 大型日志、导出数据、跟踪记录或数据载荷都会写入文件,并返回文件路径 - 只有经过我明确批准,才会运行实际写入数据的命令 然后阅读配套技能,告诉我下次需要使用这个 CLI 时可以输入的最短提示词。

    如果 Codex 返回大段 JSON,请让它缩减默认响应的内容,并提供将完整数据载荷导出到文件的选项。如果 Codex 忘记了哪些操作需要审批,请先让它更新配套技能,再在其他任务中使用该技能。

    在后续任务中使用技能

    再次需要这个 CLI 时,直接调用技能即可,无需重新粘贴文档:

    使用 $ci-logs 下载此构建 URL 对应的失败作业日志,并告诉我最先失败的是哪一步。
    使用 $support-export 搜索本周与退款有关的投诉,并读取价值最高的三个工单。
    使用 $admin-api 查找这位用户的工作空间,读取账单记录,并起草一条可以安全添加到账户中的备注。

    对于需要定期执行的工作,先在聊天中测试一次技能,然后让 Codex 在该聊天中创建计划任务,按相同方式调用技能。

    相关使用场景