dosya CLIのJSON出力を使う

--jsonまたは-jを指定すると、整形されたJSONが標準出力に書き込まれます。dosyaはすべてのコマンドの結果を共通の{ok,data}スキーマで囲みません。whoamiはユーザーオブジェクトを出力し、一覧コマンドはAPIの形式を維持し、使用量のコマンドは独自のレポートを作成します。

始める前に

• 使い捨てのデータまたは読み取り専用データでコマンドを一度実行し、スクリプトに必要なフィールドがあることを確認してください。
• 標準エラー出力は別に取得してください。JSONモードでも警告とデバッグ情報は標準エラー出力に書き込まれます。
• config getは保存済みAPIキーを伏せます。JSONは診断に使えますが、認証情報を再現することはできません。

手順

1. dosya whoami --jsonなどの読み取り専用コマンドを実行し、標準出力と標準エラー出力を別々のファイルにリダイレクトしてください。
2. 解析する前に終了コードを保存してください。標準エラー出力に失敗の説明があっても、終了コードが非ゼロの場合、標準出力は空または不完全になることがあります。
3. 実際の最上位の形式を解析してください。whoamiではユーザーフィールドを直接読み、lsでは同じキーを期待せず一覧を囲む構造を確認してください。
4. jq -eで必要な値だけを選び、フィールドがなければスクリプトが失敗するようにしてください。IDが1つあれば十分な場合は、アカウントやファイルのレスポンス全体を保存しないでください。
5. 標準エラー出力はジョブログと共に、JSONの標準出力は機械処理用の結果と共に保管してください。JSONパーサーに渡す前に2>&1で結合しないでください。
6. 後続のコマンドを開始する前に、目的のワークスペースIDや返されたファイルIDなど、結果の内容を検証してください。

確認できる結果

コマンドが成功すると、コマンド固有の有効なJSON文書が1つ標準出力に書き込まれ、進捗と警告は標準エラー出力に残ります。スクリプトは終了ステータスと必須フィールドの両方を確認します。

トラブルシューティング

jqが無効なJSONを報告する。 標準出力と標準エラー出力が結合されていないことを確認し、元の終了コードを調べてください。

別のコマンドにあったフィールドがない場合 このコマンドの出力形式を確認してください。共通の結果構造はありません。

キーの値が伏せられている。 config getでは正常な動作です。シークレットはCLIの診断出力ではなく、発行元のシークレットストアから取得してください。

関連ガイド

• CLIをインストール
• CLIで転送