オプション
オプション (フラグとも呼ばれます) は、CLIコマンドとともに使用できる追加の機能 (省略可) を提供します。
コマンドに有効なすべてのオプションを確認するには、--helpを付けてそのコマンドを実行するか、GitHubリポジトリを参照してください。
ヘルプの利用
任意のコマンドに--helpを追加すると、その使用方法、引数、利用可能なフラグが表示されます。
出力形式の制御
JSON出力
--jsonを使用すると、APIレスポンス全体が構造化されたJSONとして返されます。これはスクリプトの作成時や、レスポンス全体を確認する必要がある場合に役立ちます。
box files:get 123456 --json
CSV出力
--csvを使用すると、結果がCSVとして返されます。これは--saveとうまく組み合わせると、スプレッドシートで開けるレポートを作成できます。
box folders:items 0 --csv --save
フィールドのフィルタ
--fieldsを使用すると、レスポンスに必要なフィールドのみを指定できます。これにより、出力のノイズが削減され、本来であれば多数のフィールドを返すコールの処理速度が向上します。
box folders:items 0 --fields id,name,login
出力の保存
デフォルトのレポートフォルダへの保存
--saveを使用すると、出力はデフォルトのレポートディレクトリに書き込まれます。
box folders:items 0 --csv --save
カスタムパスへの保存
--save-to-file-pathを使用すると、デフォルトの場所が無効になり、出力が指定の場所に書き込まれます。
box folders:items 0 --json --save-to-file-path ./exports/users.json
スクリプト作成と自動化
確認プロンプトのスキップ
--yesを使用すると、どの確認プロンプトに対しても自動的に「はい」と回答します。これは、スクリプトや自動化されたパイプラインでCLIを実行する際に便利です。
box folders:delete 123456 --yes
カラーの無効化
--no-colorを使用すると、出力からANSIカラーコードが削除されます。これは、ログファイルやCI環境で出力をキャプチャする際、カラーコードによって出力が破損する可能性がある場合に推奨されます。
box folders:items 0 --no-color
デバッグ
--verboseを使用すると、リクエストとレスポンスのメタデータを含む詳細な出力が表示されます。このフラグは、予期しないエラーのトラブルシューティングを行う際に追加してください。
box folders:items 0 --verbose
特定のトークンの使用
--tokenを使用すると、特定のアクセストークンで単一のコマンドを認証し、構成済みのデフォルトの環境を無効にします。これは、環境を切り替えることなく、トークンをテストしたり、1回限りのコールを実行したりする際に便利です。
box folders:items 0 --token YOUR_ACCESS_TOKEN
as-userヘッダー
他のユーザーの代理で操作を実行するには、オプションを使用します。
たとえば、次のコマンドでは、ユーザーID 123456のアカウントのルートレベルにExample_Folderというフォルダが作成されます。
box folders:create 0 Example_Folder --as-user=123456
as-userヘッダーを使用できるのは、サービスアカウントと管理者のみです。必要なスコープでアプリケーションが承認されていない場合、または別のユーザーのデフォルトのトークンを取得するようCLIを構成した場合は、この呼び出しが失敗する可能性があります。詳細なエラーログを確認するには、コマンドに-vまたは--verboseを追加してください。
