CLIの一括コマンド

ガイド CLI CLIガイド CLIの一括コマンド

CLIの一括コマンド

Box CLIの一括コマンドを使用すると、反復タスクを自動化できます。コマンドに--bulk-file-pathフラグを追加すると、多数の項目に対して操作を一度に実行できます。

たとえば、次のコマンドは、CSVファイルを使用してフォルダの名前 (Name)、説明 (Description)、親フォルダのParentIdを指定し、複数のフォルダを作成します。

box folders:create --bulk-file-path <PATH_TO_CSV>/folders-create.csv

CSVテンプレート

あらかじめ定義されたCSVテンプレートを使用すると、一括で管理したいデータを構造化できます。テンプレートはBulk actionsディレクトリにあり、複数のフォルダに分類されています。現在利用できるテンプレートは、以下の表に示すとおりです。

テンプレート説明
box collaborationsコラボレーションを作成、削除、更新します。
box filesファイルをダウンロード、更新、アップロードします。
box foldersフォルダの作成と更新、フォルダへのメタデータの追加を行います。
box groupsグループの作成とメンバーシップの追加を行います。
box metadata-templatesメタデータテンプレートと、フォルダのメタデータカスケードポリシーを作成します。
box shared-links共有リンクを削除します。
box usersユーザーの作成と更新、あるユーザーから別のユーザーへのコンテンツの移動を行います。
box webhooksWebhookを削除します。

前提条件

一括コマンドを使用するには、OAuth 2.0認証を使用するBoxアプリケーションが必要です。該当するアプリケーションがない場合は、開発者コンソールに移動して、OAuth 2.0を使用した設定ガイドに従ってください。

一括コマンドの設定と使用

  1. boxcli GitHubリポジトリを複製するか、Bulk actionsディレクトリからファイルをダウンロードします。
git clone https://github.com/box/boxcli.git
  1. 必要に応じて.csvテンプレートを調整します。たとえば、複数のフォルダを作成する場合は、出発点としてfolders-create.csvテンプレートを使用できます。
  2. コマンドを実行します。
   box users:create --bulk-file-path <PATH_TO_CSV>/folders-create.csv