出力とスクリプティング

Orizm CLI は、人間が読む用途とスクリプトから扱う用途の両方を想定して出力を設計しています。

標準出力と標準エラー出力

• 標準出力（stdout） — コマンドの結果だけを出します。
• 標準エラー出力（stderr） — ログ・進捗・確認プロンプトなど、結果以外をすべて出します。

この分離により、結果だけをファイルや他のコマンドに渡しても、進捗表示などが混ざりません。

JSON 出力

--json を付けると、結果を機械可読な JSON で標準出力に出します。jq などと組み合わせると、スクリプトから値を取り出せます。

# 組織名の一覧を取り出す
orizm org list --json | jq -r '.[].name'

# 発行した Consumer Key の値だけを取り出す
orizm key consumer create --description "web" --json --show-key | jq -r '.key'

カラーとデバッグ

--debug は、リクエストの失敗原因など、通常は表示されない詳細を確認したいときに使います。

終了コード

成功時は終了コード 0、失敗時は 0 以外で終了します。スクリプトでは終了コードで成否を判定できます。

orizm auth status は、未認証のとき終了コード 1 で終了します。これを利用して、未認証ならサインインする、といった分岐が書けます。

orizm auth status || orizm auth login

非対話環境での挙動

確認プロンプトを出すコマンドや対話が前提のコマンドは、ターミナルでないときに挙動が変わります。

• 破壊的な操作（orizm schema push、orizm project delete、各種 delete など）は、ターミナルでは確認を求めます。非対話環境では確認できないため、--yes を付けないとエラーで終了します。
• orizm link は対話的な選択が必要なため、ターミナルでないとエラーになります。CI では ORIZM_PROJECT または --project でプロジェクトを指定してください。
• orizm bucket object download は、ターミナルに直接バイナリを書き込みません。--output <path> でファイルに保存するか、パイプ・リダイレクトで受け取ってください。