English
主导航

自定义提示词

已弃用。请使用技能来实现可复用提示词

自定义提示词已弃用。请使用 技能 来提供可复用的指令,Codex 可以显式或隐式地调用这些指令。

自定义提示词(已弃用)允许你将 Markdown 文件转换为可复用的提示词,并可以在 Codex CLI 和 Codex IDE 扩展中作为斜杠命令调用。

自定义提示词需要显式调用,并且存放在你的本地 Codex 主目录中(例如, ~/.codex),因此它们不会通过你的代码仓库进行共享。如果你想共享提示词(或希望 Codex 隐式调用它), 请使用技能.

  1. 创建提示词目录:

    mkdir -p ~/.codex/prompts
  2. 创建 ~/.codex/prompts/draftpr.md with reusable guidance:

    ---
    description: Prep a branch, commit, and open a draft PR
    argument-hint: [FILES=<paths>] [PR_TITLE="<title>"]
    ---
    
    Create a branch named `dev/<feature_name>` for this work.
    If files are specified, stage them first: $FILES.
    Commit the staged changes with a clear message.
    Open a draft PR on the same branch. Use $PR_TITLE when supplied; otherwise write a concise summary yourself.
  3. 重启 Codex 以加载新的提示词(重启你的 CLI 会话,如果你正在使用 IDE 扩展,也请重新加载该扩展)。

预期效果:在斜杠命令菜单中输入 /prompts:draftpr 会显示你的自定义命令及其来自 front matter 的描述,并提示文件和 PR 标题为可选项。

添加元数据和参数

Codex 会在下次会话启动时读取提示词元数据并解析占位符。

  • Description: 在弹出菜单中显示于命令名称下方。在 YAML front matter 中将其设置为 description:.
  • 参数提示: 记录预期的参数 argument-hint: KEY=<value>.
  • 位置占位符: $1$9 从命令后提供的空格分隔参数进行展开。 $ARGUMENTS 包含所有这些参数。
  • 命名占位符: 使用大写名称,例如 $FILE or $TICKET_ID and supply values as KEY=value。为包含空格的值加上引号(例如, FOCUS="loading state").
  • 原义美元符号: 编写 $$ to emit a single $ in the expanded prompt.

编辑提示文件后,请重启 Codex 或开启新的聊天以便加载更新。Codex 会忽略 prompts 目录下非 Markdown 格式的文件。

调用和管理自定义命令

  1. 在 Codex (CLI 或 IDE 扩展) 中,输入 / 以打开斜杠命令菜单。

  2. 输入 prompts: 或提示名称,例如 /prompts:draftpr.

  3. 提供必要的参数:

    /prompts:draftpr FILES="src/pages/index.astro src/lib/api.ts" PR_TITLE="Add hero animation"
  4. 按 Enter 键发送展开后的指令(不需要的参数可以跳过)。

预期:Codex 展开 draftpr.md的内容,用提供的参数替换占位符,然后将结果作为消息发送。

通过编辑或删除 ~/.codex/prompts/下的文件来管理提示。Codex 仅扫描该文件夹中的顶层 Markdown 文件,因此请将每个自定义提示直接放在 ~/.codex/prompts/ 下,而不是放在子目录中。