Codex CLIのカスタムコマンドを使って業務を効率化する
こんにちは、前田です!
皆さんは日頃Codex CLIをご利用されていますか?
Codex CLI はそのままでも非常に便利ですが、カスタムコマンドを定義することで、日々の作業効率を大きく改善できるのが魅力です。
今回は そんなCodex CLI の「カスタムコマンド」機能の設定方法と、実際の使用例を紹介します!
と入力し、Enterを押すと、
といった返答がされるため、今回は
と入力します。
すると、以下のような返答が返ってきました。
これで、簡単な挨拶を返すカスタムコマンドは完成です!
例えばCodex CLIを使って自分の書いたコードのレビューを指示したい場合に便利ですね。
レビューの際に以下の指示を毎回入力するのは、少し手間がかかります。
そこで、この指示をカスタムコマンドとして事前に用意し、すぐに使えるようにしましょう!
※ 上記は架空のプロジェクト例のため、皆さんの環境・プロジェクトに合わせて設定ファイルを調整してください。
引数に GitHub の PR URL を渡すことで、対象 PR の差分に基づいたレビュー結果を取得できます。
同じ指示を二回以上繰り返す場面があれば、カスタムコマンド化を検討することで、作業効率は大きく向上するでしょう!
参考文献:
皆さんは日頃Codex CLIをご利用されていますか?
Codex CLI はそのままでも非常に便利ですが、カスタムコマンドを定義することで、日々の作業効率を大きく改善できるのが魅力です。
今回は そんなCodex CLI の「カスタムコマンド」機能の設定方法と、実際の使用例を紹介します!
カスタムコマンドとは?
Codex CLI のカスタムコマンドは、以下のようなことができます。- コマンドに「役割」や「命令」を事前登録できる
- 毎回プロンプトを入力しなくても、AIに同じ指示を与えられる
簡単な挨拶を返す
まずは軽い例として、共通で使える「挨拶を返すコマンド」を作ってみます。設定ファイル( ~/.codex/prompts/greet.md )
---
name: greet
description: "簡単な挨拶を返すコマンド"
---
あなたはフレンドリーなアシスタントです。
入力された名前に対して、短い挨拶文を返してください。
使い方
保存後にCodex CLIを開き、設定したコマンドを実行します。> /prompts:greetと入力し、Enterを押すと、
お名前を教えてください。短い挨拶文をお返しします。といった返答がされるため、今回は
> 前田と入力します。
すると、以下のような返答が返ってきました。
前田さん、こんにちは!お会いできてうれしいです。これで、簡単な挨拶を返すカスタムコマンドは完成です!
コードレビューをする
カスタムコマンドが利便性を発揮するのは、長い指示を何度も繰り返し使用する時です。例えばCodex CLIを使って自分の書いたコードのレビューを指示したい場合に便利ですね。
レビューの際に以下の指示を毎回入力するのは、少し手間がかかります。
このPRの差分を取得し、レビューをしてください。
【レビュー基準】
- 詳細設計・クラス設計の内容から逸脱していないこと
- プロジェクト内の類似ファイルと比較し、スタイルの不一致がないこと
- 誤字や脱字がないことそこで、この指示をカスタムコマンドとして事前に用意し、すぐに使えるようにしましょう!
設定ファイル( ~/.codex/prompts/review.md )
---
name: review
description: "PR の差分を取得してコードレビューを行うコマンド"
argument-hint: [PR_URL="<GitHub PR URL>"]
---
あなたは熟練したソフトウェアエンジニアとして、PR のコードレビューを行います。
必ず以下を実施してください。
【命令】
- 入力された PRのURL($PR_URL)から差分を取得し、コードレビューを行うこと。
【レビュー基準】
- プロジェクト内の類似ファイルと比較し、スタイルの不一致がないか確認すること。
- 変数名・関数名・コメントに誤字や脱字がないこと。
- 実装が意図どおり動作すること。
- 詳細設計・クラス設計の内容から逸脱していないこと。※ 上記は架空のプロジェクト例のため、皆さんの環境・プロジェクトに合わせて設定ファイルを調整してください。
引数に GitHub の PR URL を渡すことで、対象 PR の差分に基づいたレビュー結果を取得できます。
> /prompts:review PR_URL="https://github.com/XXX/pull/128"
おわりに
カスタムコマンドは今回の例以外にも、長文タスクの要約や繰り返し作業の共通化など、さまざまな業務効率化に活用できます。同じ指示を二回以上繰り返す場面があれば、カスタムコマンド化を検討することで、作業効率は大きく向上するでしょう!
参考文献:
- Codex CLI公式ドキュメント - Create your own slash commands with custom prompts
https://developers.openai.com/codex/guides/slash-commands/#create-your-own-slash-commands-with-custom-prompts - Codex CLIのカスタムコマンドを完全攻略!よく使う指示を瞬時に呼び出す方法(Qiita - 著:とまだ氏)
https://qiita.com/tomada/items/37d260807c4324c9898d