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

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

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アカウントにこのフォルダが表示されなくなります。このフォルダは、アプリケーションの承認後に作成されたアプリケーションのサービスアカウントに存在します。

まとめ

  • ヘルプ機能を使用してフォルダを作成しました