ドキュメントの全ページの一覧は、 llms.txt を参照してください。各ページの URL の末尾に .md を追加すると、そのページの Markdown 版を表示できます。
メインナビゲーション
テーマ

カスタムプロンプト

カスタムプロンプトは非推奨です。プロンプトを再利用するにはスキルを使用してください。

カスタムプロンプトは非推奨です。Codex が明示的にも暗黙的にも呼び出せる形で指示を再利用するには、スキルを使用してください。

カスタムプロンプト(非推奨)を使うと、Markdown ファイルを再利用可能なプロンプトとして定義し、Codex CLI と Codex IDE 拡張機能のどちらからでもスラッシュコマンドで呼び出せます。

カスタムプロンプトは明示的に呼び出す必要があります。ローカルの Codex ホームディレクトリ(例:~/.codex)に保存されるため、リポジトリ経由では共有されません。プロンプトを共有したい場合や、Codex が暗黙的に呼び出せるようにしたい場合は、スキルを使用してください。

  1. プロンプト用のディレクトリを作成します。

    mkdir -p ~/.codex/prompts
  2. ~/.codex/prompts/draftpr.md を作成し、再利用する指示を記述します。

    ---
    description: ブランチを作成し、変更をコミットしてドラフト PR を開く
    argument-hint: [FILES=<paths>] [PR_TITLE="<title>"]
    ---
    
    この作業用に `dev/<feature_name>` という名前のブランチを作成してください。
    ファイルの指定がある場合は、まず $FILES に挙げたファイルをステージしてください。
    変更内容がわかるメッセージを付けて、ステージ済みの変更をコミットしてください。
    同じブランチからドラフト PR を開いてください。タイトルが指定されている場合は $PR_TITLE を使い、省略されている場合は変更内容を簡潔にまとめたタイトルを付けてください。
  3. 新しいプロンプトを読み込むために、Codex を再起動します。CLI セッションを再起動し、IDE 拡張機能を使用している場合は拡張機能も再読み込みします。

期待される結果:スラッシュコマンドメニューで /prompts:draftpr と入力すると、カスタムコマンドが表示されます。フロントマターで指定した説明と、ファイルと PR タイトルの指定が任意であることを示すヒントも表示されます。

メタデータと引数の追加

Codex は次回のセッション開始時にプロンプトのメタデータを読み取り、プレースホルダーを展開します。

  • 説明: ポップアップでコマンド名の下に表示されます。YAML フロントマターの description: で設定します。
  • 引数のヒント: argument-hint: KEY=<value> で、コマンドが受け取るパラメーターを示します。
  • 位置指定プレースホルダー: $1 から $9 には、コマンドの後にスペース区切りで指定した引数が順番に入ります。$ARGUMENTS にはすべての引数が入ります。
  • 名前付きプレースホルダー: $FILE や $TICKET_ID のような大文字の名前を使い、KEY=value の形式で値を指定します。スペースを含む値は引用符で囲みます(例:FOCUS="loading state")。
  • ドル記号そのもの: $$ と記述すると、展開後のプロンプトには $ が 1 つ出力されます。

プロンプトファイルを編集したら、Codex を再起動するか、新しいチャットを開いて変更を読み込みます。Codex はプロンプト用のディレクトリにある 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/ の直下に配置してください。