コマンドの作成とヘルプ機能

ガイド CLI OAuth 2.0を使用したBox CLIの使用 コマンドの作成とヘルプ機能

コマンドの作成とヘルプ機能

CLIコマンドの全一覧と使用方法に関する情報については、GitHubリポジトリを参照してください。

一部のコマンドは、サービスアカウントと管理者しか使用できません。必要なスコープでユーザーが承認されていない場合、または別のユーザーのデフォルトのトークンを取得するようCLIを構成した場合は、呼び出しが失敗する可能性があります。詳細なエラーログを確認するには、コマンドに-vまたは--verboseを追加してください。

必要なエンドポイント用のコマンドが表示されない場合は、カスタムリクエストを作成できます。

helpコマンドで提供されない情報を確認するには、リファレンスドキュメントと併せてリポジトリのドキュメントを使用してください。このような情報には、制限事項、トークンの権限の要件、フィールドなどがあります。

Box API資格情報をCLIにインポートしたので、これらの資格情報をブラウザのストレージから削除することをお勧めします。

資格情報をクリア

API資格情報をブラウザのストレージから削除すると、クライアントIDまたはクライアントシークレットを他のスクリプトで読み取ることができなくなります。

どのCLIコマンドもboxで始まります。任意のコマンドにオプション--helpを追加すると、そのコマンドを作成するためのヘルプが表示されます。たとえば、box --helpを実行すると、使用可能なすべてのオブジェクトコマンドのリストが表示されます。オプションの詳細については、手順4で説明します。