🛠️

CLIコマンドの挙動を理解するプロンプト

2025/03/08に公開

CLIツールを使っていると「とりあえずコマンドを実行したけれど、何が起こってるの?」と思うことが多々あります。この記事では調査のためのプロンプトを紹介します。


CLIコマンドを調べるプロンプト

supabase initのところを変更して使います。

プロンプト:

supabase init

与えられたキーワードに関する仕組みを理解するために、
以下のフォーマットで教えてください。

教える際に、マトリックスを差し込んで見やすく整理するのもよい方法です。

### 1. 操作の概要と目的
- その操作の役割は何か?
- 実行によって達成されることや、どんな目的で使われるのか?

### 2. 実行前の前提条件と依存関係
- 必要な環境設定や事前準備はあるか?
- 他のシステムやプロセスとの関連性や依存関係はあるか?

### 3. 操作の対象(対象ファイルや設定情報)
- 操作対象となるファイル、設定ファイル、環境変数は何か?
- どの情報やパラメータが読み込まれたり、変更されるのか?

### 4. 操作の詳細(引数とオプション)
- 利用可能な引数やオプションにはどのようなものがあるか?
- それぞれの意味、デフォルト値、効果は何か?

### 5. 実行結果とシステムへの影響範囲
- 実行によってどんな結果が得られるのか?
- システムや関連するコンポーネントに具体的にどんな影響があるか?

### 6. 操作の内部的な仕組み(メカニズム)
- 操作によって内部で具体的に何が行われているのか?
- なぜその結果が導き出されるのか?(理由・ロジック)

### 7. 異常・エラー時の挙動と復旧方法
- 操作が失敗した際の挙動やエラーの種類は何か?
- エラーからの復旧手順や、元の状態に戻す方法は何か?

### 8. 性能・負荷への影響
- 操作の実行がシステムの性能や負荷に与える影響はどの程度か?
- 性能を最適化するための注意点はあるか?

### 9. 操作記録・ログ情報の所在
- 操作の履歴やログはどこに記録されるか?
- 問題発生時にログを確認するポイントは何か?

### 10. セキュリティ上の留意点
- 操作によるセキュリティリスクや懸念事項はあるか?
- 操作を安全に行うための注意点は何か?

### 11. 代替手段・他の選択肢との比較
- 他に同じ目的を達成する方法はあるか?
- 各方法の利点・欠点、推奨する状況は何か?

Enjoy!!

Discussion