For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主导航
Codex

Codex use case

创建 Codex 可用的 CLI

为 Codex 提供一个可组合命令,用于操作 API、日志源、导出内容或团队脚本。

Difficulty 中级
Time horizon 1 小时

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

最适合

  • 需要 Codex 反复对同一服务、导出内容、本地归档或代码仓库脚本进行搜索、读取、下载或安全写入的工作。
  • 需要分页搜索、按 ID 精确读取、格式可预测的 JSON、已下载文件、本地索引或先起草后写入命令的智能体工具。

Contents

    ← 全部使用场景

    创建 Codex 可用的 CLI

    为 Codex 提供一个可组合命令,用于操作 API、日志源、导出内容或团队脚本。

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

    中级
    1 小时

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

    中级
    1 小时

    最适合

    • 需要 Codex 反复对同一服务、导出内容、本地归档或代码仓库脚本进行搜索、读取、下载或安全写入的工作。
    • 需要分页搜索、按 ID 精确读取、格式可预测的 JSON、已下载文件、本地索引或先起草后写入命令的智能体工具。

    技能与插件

    • 设计命令接口、构建 CLI、添加设置和身份验证检查、将命令安装到 PATH,并从其他文件夹验证它。
    • 创建配套技能,用于指导后续 Codex 任务先运行哪些 CLI 命令,以及哪些写入操作需要审批。
    Skill Why use it
    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-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]。 编写代码前,先向我展示拟议的命令接口,并且只询问缺少且会阻碍构建的信息。

    简介

    当 Codex 需要反复使用同一个 API、日志源、导出的收件箱、本地数据库或团队脚本时,请为这类工作提供一个可组合的接口:一条可从任意文件夹运行,便于它检查和筛选结果,还能与 gitghrg、测试和代码仓库脚本组合使用的命令。

    添加一项配套技能,用于记录 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 沿用熟悉的风格,请粘贴来自 ghkubectl 或您团队自有工具的一小段 --help 输出。

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

    让 Codex 构建 CLI 和技能

    使用本页的起始提示。填写 Codex 应学习的来源,以及 CLI 应支持的首项工作。

    在 Codex 编写代码之前,它应展示拟议的命令接口,并且只询问缺少且会阻碍构建的信息。

    验证命令可从任意文件夹运行

    Codex 不应只运行 cargo runpython path/to/script.py 或某个尚未安装的软件包命令就结束任务。请让它模拟后续任务的使用方式,从另一个代码仓库或临时文件夹测试已安装的命令。

    按未来智能体的使用方式测试 CLI

    按照您在后续任务中的使用方式测试 [cli-name]。 请提供证据,证明以下各项: - 从 CLI 源文件夹外运行 command -v [cli-name] 能成功 - [cli-name] --help 能说明主要命令 - setup/auth 检查可正常运行 - 一个安全的发现、列出或搜索命令可正常运行 - 一个精确读取命令可使用发现结果中的 ID 正常运行 - 任何大型日志、导出内容、跟踪数据或有效负载都会写入文件并返回路径 - 未经我明确批准,不会运行任何实际写入命令 然后读取配套技能,并告诉我下次需要再次使用此 CLI 时应输入的最短提示。

    如果 Codex 返回一大块 JSON 数据,请让它精简默认响应,并添加将完整有效负载导出到文件的功能。如果它忘记了审批边界,请在将该技能用于另一项任务之前,让它更新配套技能。

    日后使用该技能

    再次需要该 CLI 时,请调用该技能,而不要再次粘贴文档:

    使用 $ci-logs 下载此构建 URL 对应的失败日志,并告诉我第一个失败的步骤。
    使用 $support-export 搜索本周的退款投诉,并读取价值最高的三张工单。
    使用 $admin-api 查找此用户的工作空间,读取计费记录,并起草一条稳妥的账户备注。

    对于重复性工作,请先在聊天中测试一次该技能,然后让 Codex 从该聊天中为同一调用安排任务

    相关使用场景