CLI設計チェックリスト
ヘルプとバージョン
- CLIは、明確な使用方法、オプション、例を含む
--helpおよび-hフラグを必須で提供しなければなりません。例には必須パラメータをすべて含める必要があります。 - CLIは
--versionおよび-Vフラグを必須で提供しなければなりません。エージェントは-vを--verboseのために予約しなければなりません。
入力と出力
- CLIはstdin/stdoutパイプ処理をサポートし、出力リダイレクト（例：ファイル作成のための
--output）を許可しなければなりません。 - 構造化データを出力するCLIは、機械可読な出力（例：
--json）を提供しなければなりません。
安全性と制御
- データを変更または削除するCLIは、
--dry-runおよび明示的なバイパスフラグ（--yesまたは--force）を提供しなければなりません。 - CLIは制御可能なログ出力（
--quiet、--verbose、または--trace）を提供しなければなりません。 - CLIは決定論的な終了コードを使用しなければなりません：0は成功、非ゼロは失敗を示します。エージェントは暗黙のフォールバックを導入してはなりません。
- CLIはCI/CD環境向けに厳密に非対話型モードを実装しなければなりません。
設定
- JSON設定を消費するCLIは、JSONスキーマを定義して更新し、ロード時に設定を検証しなければなりません。
- CLIは、機密データや環境固有のデータに対して環境変数による設定をサポートしなければなりません。
インタラクティブプロンプト
- インタラクティブプロンプトは、質問する前に必要なコンテキストを提供しなければなりません。はい/いいえプロンプトの場合、Enterキーは「はい」を意味し、「n」は「いいえ」を意味しなければなりません。