Paddi

設定與旗標

全域旗標、設定檔與環境變數,以及套用的優先順序。


全域旗標

以下旗標可套用在任何子指令之前:

旗標說明
--json輸出 API 回傳的原始 JSON,取代預設的表格/文字格式
--quiet, -q只輸出必要結果(例如條列指令只印出 ID),適合腳本串接
--project <id>覆寫目前的專案情境,優先於設定檔與 PADDI_PROJECT
--api-base <url>覆寫 API 位址,優先於 PADDI_API_BASE 與設定檔
--version, -V印出版本號
--help, -h顯示說明(任何指令或子指令皆可加上)

輸出格式

  • 預設:條列指令輸出對齊的表格;單一資源指令(如 spec viewrequest view)輸出可讀的文字說明。
  • --json:輸出後端回傳的原始 JSON,方便搭配 jq 等工具處理。多數指令直接透傳 API 回應;例外是 spec info,其 JSON 是用戶端重新序列化的中繼資料(欄位對應 Spec 結構,content 欄位固定為空字串)。
  • --quiet:條列指令只印出每列的 ID;建立/變更類指令(如 capture createspec download)省略確認訊息,只印出關鍵值(ID 或檔案路徑)。

設定與環境變數

設定採以下優先順序:旗標 > 環境變數 > 設定檔 > 預設值

設定檔

預設位置為 $XDG_CONFIG_HOME/paddi/config.toml;若未設定 XDG_CONFIG_HOME,則為 <使用者家目錄>/.config/paddi/config.toml(各平台皆同,包含 Windows)。可用 PADDI_CONFIG 環境變數完全覆寫路徑。

paddi workspace switch / paddi project switch 會寫入此檔案;一般不需手動編輯,內容格式如下:

api_base = "https://api.paddi.app"

[context]
workspace_id = "ws_123"
project_id = "proj_456"

環境變數

變數說明
PADDI_TOKEN直接指定存取權杖,取代 OS 憑證儲存區並停用自動 token 更新。適合 CI/非互動環境
PADDI_CONFIG覆寫設定檔路徑
PADDI_API_BASE覆寫 API 位址
PADDI_PROJECT覆寫目前的專案情境

context.workspace_id 沒有對應的旗標或環境變數,僅能透過 paddi workspace switch 設定,或在 paddi project switch 選擇了不同工作區底下的專案時自動一併更新。