自定义提示词
自定义提示词已弃用。请使用技能来编写可复用的指令,Codex 可以显式或隐式地调用这些指令。
自定义提示词(已弃用)可以将 Markdown 文件转换为可复用的提示词,让你能够在 Codex CLI 和 Codex IDE extension 中将其作为斜杠命令调用。
自定义提示词需要显式调用,并存储在本地 Codex 主目录中(例如 ~/.codex),因此不会通过你的代码仓库共享。如果你希望共享提示词(或希望 Codex 隐式调用它),请使用技能。
-
创建提示词目录:
Terminal window mkdir -p ~/.codex/prompts -
创建包含可复用指导的
~/.codex/prompts/draftpr.md:---description: Prep a branch, commit, and open a draft PRargument-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. -
重启 Codex,使其加载新的提示词(重启 CLI 会话;如果使用 Codex IDE extension,还需重新加载该扩展)。
预期结果:在斜杠命令菜单中输入 /prompts:draftpr 后,会显示你的自定义命令,其中包含 front matter 中的描述,并提示文件和 PR 标题均为可选参数。
添加元数据和参数
Section titled “添加元数据和参数”Codex 会读取提示词元数据,并在下次会话启动时解析占位符。
- 描述: 显示在弹出窗口中的命令名称下方。在 YAML front matter 中通过
description:设置。 - 参数提示: 使用
argument-hint: KEY=<value>记录预期参数。 - 位置占位符:
$1到$9会根据你在命令后提供的、以空格分隔的参数进行展开。$ARGUMENTS包含所有这些参数。 - 命名占位符: 使用
$FILE或$TICKET_ID等大写名称,并以KEY=value的形式提供值。包含空格的值需要加引号(例如FOCUS="loading state")。 - 字面量美元符号: 使用
$$可在展开后的提示词中输出单个$。
编辑提示词文件后,请重启 Codex 或打开新的聊天,以加载更新内容。Codex 会忽略 prompts 目录中的非 Markdown 文件。
调用和管理自定义命令
Section titled “调用和管理自定义命令”-
在 Codex(CLI 或 Codex IDE extension)中输入
/,打开斜杠命令菜单。 -
输入
prompts:或提示词名称,例如/prompts:draftpr。 -
提供所需参数:
/prompts:draftpr FILES="src/pages/index.astro src/lib/api.ts" PR_TITLE="Add hero animation" -
按 Enter 发送展开后的指令(不需要某个参数时可以跳过该参数)。
预期结果:Codex 会展开 draftpr.md 的内容,将占位符替换为你提供的参数,然后将结果作为消息发送。
通过编辑或删除 ~/.codex/prompts/ 下的文件来管理提示词。Codex 只会扫描该文件夹顶层的 Markdown 文件,因此请将每个自定义提示词直接放在 ~/.codex/prompts/ 下,而不要放在子目录中。