自定义提示词
如需完整文档索引,请参阅 llms.txt。文档页面的 Markdown 版本可通过在页面后追加
.md来获取 URL。
自定义提示词已弃用。请使用 技能 来实现可复用的 指令,这些指令 Codex 可以显式或隐式调用。
自定义提示词(已弃用)可让你将 Markdown 文件转为可复用提示词,并在 Codex CLI 和 Codex IDE extension中作为斜杠命令调用。
自定义提示词需要显式调用,并位于你的本地 Codex 主目录中(例如 ~/.codex),因此不会通过你的仓库共享。如果你想共享提示词(或希望 Codex 隐式调用它), 请使用技能。
- 创建提示词目录:
mkdir -p ~/.codex/prompts- 创建
~/.codex/prompts/draftpr.md并写入可复用指导:
--- 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.- 重启 Codex 以加载新提示词(重启你的 CLI 会话;如果你正在使用 IDE 扩展,也请重新加载它)。
预期结果:输入 /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")。 - 字面量美元符号: 写入
$即可在展开后的提示词中输出单个- **描述:** 显示在弹出窗口中的命令名称下方。在 YAML front matter 中将其设置为description:`。 - 参数提示: 使用
argument-hint: KEY=<value>记录预期参数。 - 位置占位符:
$1到$9会从你在命令后提供的空格分隔参数中展开。$ARGUMENTS包含它们全部。 - 命名占位符: 使用类似
$FILE或$TICKET_ID的大写名称,并以KEY=value形式提供值。包含空格的值请加引号(例如FOCUS="loading state")。 - 字面量美元符号: 写入
$即可在展开后的提示词中输出单个 。
编辑提示词文件后,请重启 Codex 或打开新聊天,以便加载更新。 Codex 会忽略提示词目录中的非 Markdown 文件。
调用和管理自定义命令
Section titled “调用和管理自定义命令”- 在 Codex (CLI 或 IDE 扩展)中,输入
/打开斜杠命令菜单。 - 输入
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/ 下,而不是子目录中。