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

ガイド ツール CLI Box CLIの使い方 コマンドの作成とヘルプ機能

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

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

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

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

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アカウントにログインします。このフォルダが自分のフォルダツリーに表示されているでしょうか?

このフォルダは、自分のBoxアカウントに表示されません。なぜなら、このフォルダを所有していないか、このフォルダにコラボレータとして追加されていないからです。サービスアカウントとしてコマンドを実行しているため、作成されたフォルダは、自分のアカウントではなくサービスアカウントのフォルダツリーに存在します。

ここで、次のコマンドを実行します: box folders:collaborations:add folder_id_created_above --role=editor --user-id=YOUR_USER_ID

自分のユーザーIDを確認するには、[すべてのファイル] ページに移動し、右上隅の円をクリックして、ドロップダウンの [アカウント設定] を選択します。自分のユーザーIDが、[アカウント] タブに [アカウントID] として表示されます。

[すべてのファイル] ページに戻ります。これでフォルダが表示されるようになったでしょうか?

2番目のコマンドでは、このフォルダを所有するサービスアカウントを使用し、自分のユーザーIDを編集者レベルのコラボレータとしてフォルダに追加しました。これで、このフォルダが自分のフォルダツリーに表示されます。

まとめ

  • ヘルプ機能を使用してフォルダを作成しました。
  • 作成したフォルダにコラボレーションを追加し、Boxで表示しました。