CLI コマンドの全一覧と使用方法に関する情報については、GitHub リポジトリを参照してください。
一部のコマンドは、サービスアカウントと管理者しか使用できません。必要なスコープでユーザーが承認されていない場合、または別のユーザーのデフォルトのトークンを取得するよう CLI を構成した場合は、呼び出しが失敗する可能性があります。詳細なエラーログを確認するには、コマンドに-vまたは--verboseを追加してください。
必要なエンドポイント用のコマンドが表示されない場合は、カスタムリクエストを作成できます。
help コマンドで提供されない情報を確認するには、リファレンスドキュメントと併せてリポジトリのドキュメントを使用してください。このような情報には、制限事項、トークンの権限の要件、フィールドなどがあります。
はじめに: ブラウザのストレージをリセットする
Box API 資格情報を CLI にインポートしたので、これらの資格情報をブラウザのストレージから削除することをお勧めします。
API 資格情報をブラウザのストレージから削除すると、クライアント IDまたはクライアントシークレットを他のスクリプトで読み取ることができなくなります。
help を使用したフォルダの作成
どの CLI コマンドもboxで始まります。任意のコマンドにオプション--helpを追加すると、そのコマンドを作成するためのヘルプが表示されます。たとえば、box --helpを実行すると、使用可能なすべてのオブジェクトコマンドのリストが表示されます。オプションの詳細については、手順 4で説明します。
次に、例として、フォルダオブジェクトを使用してコマンドbox folders --helpを実行します。その結果、このオブジェクトに実行できるすべての操作のリストが表示されます。
フォルダの作成に必要な引数を調べるためのコマンド: box folders:create --help
コマンドbox folders:create 0 "My CLI Folder"を実行し、レスポンスで返されたフォルダ ID を書き留めておきます。
フォルダツリーのルートレベルである [すべてのファイル] ページは、常にフォルダ ID 0 で表されます。
自分のBox アカウントにログインします。このフォルダが自分のフォルダツリーに表示されているでしょうか?
JWT 認証を使用した Box CLI を設定すると、Box アカウントにこのフォルダが表示されなくなります。このフォルダは、アプリケーションの承認後に作成されたアプリケーションのサービスアカウントに存在します。
まとめ