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 表示成功， 非零表示失敗。代理人不得引入靜默 回退。
- 對於 CI/CD 環境，CLI 必須實作嚴格的 非互動模式。
設定
- 讀取 JSON 設定的 CLI 必須定義並更新 JSON Schema，且必須在載入時驗證設定。
- CLI 必須支援透過環境變數進行設定，以處理 敏感或環境特定的資料。
互動提示
- 互動提示必須在提問前提供必要的上下文。 對於是/否提示，Enter 必須表示「是」，而「n」必須 表示「否」。