カスタムプロンプト¶
カスタムプロンプトは非推奨です。再利用可能な指示には skills を使用してください。Codex はこれらを明示的または暗黙的に呼び出せます。
非推奨のカスタムプロンプトを使用すると、Markdown ファイルを再利用可能なプロンプトに変換し、Codex CLI と Codex IDE 拡張機能の両方でスラッシュコマンドとして呼び出せます。
カスタムプロンプトは明示的な呼び出しが必要で、ローカルの Codex ホームディレクトリ(例: ~/.codex)に保存されるため、リポジトリを通じて共有されることはありません。プロンプトを共有したい場合(または Codex に暗黙的に呼び出させたい場合)は、skills を使用してください。
- 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 と入力すると、フロントマターの説明と、ファイルおよび PR タイトルがオプションであることを示すヒントとともに、カスタムコマンドが表示されます。
メタデータと引数を追加する¶
Codex はプロンプトのメタデータを読み取り、次回セッションの開始時にプレースホルダーを解決します。
- 説明: ポップアップでコマンド名の下に表示されます。YAML フロントマターで
description:として設定します。 - 引数のヒント:
argument-hint: KEY=<value>を使用して、想定されるパラメーターを記述します。 - 位置指定プレースホルダー:
$1から$9までは、コマンドの後に指定したスペース区切りの引数から展開されます。$ARGUMENTSには、それらすべてが含まれます。 - 名前付きプレースホルダー:
$FILEや$TICKET_IDのように大文字の名前を使用し、KEY=valueとして値を指定します。スペースを含む値は引用符で囲みます(例:FOCUS="loading state")。 - リテラルのドル記号:
$$と記述すると、展開後のプロンプトに単一の$を出力できます。
プロンプトファイルを編集した後は、Codex を再起動するか、新しいチャットを開いて更新内容を読み込んでください。Codex は prompts ディレクトリ内の Markdown 以外のファイルを無視します。
カスタムコマンドを呼び出して管理する¶
- Codex(CLI または IDE 拡張機能)で
/と入力し、スラッシュコマンドメニューを開きます。 prompts:またはプロンプト名を入力します。例:/prompts:draftpr。- 必須の引数を指定します。
- Enter キーを押して展開後の指示を送信します(必要がなければ、どちらかの引数を省略できます)。
期待される結果: Codex は draftpr.md の内容を展開し、指定した引数でプレースホルダーを置き換えたうえで、結果をメッセージとして送信します。
~/.codex/prompts/ 配下のファイルを編集または削除して、プロンプトを管理します。Codex はそのフォルダー直下にある Markdown ファイルのみをスキャンするため、各カスタムプロンプトはサブディレクトリではなく ~/.codex/prompts/ の直下に配置してください。