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 webhooks | Webhookを削除します。 |
前提条件
一括コマンドを使用するには、OAuth 2.0認証を使用するBoxアプリケーションが必要です。該当するアプリケーションがない場合は、開発者コンソールに移動して、OAuth 2.0を使用した設定ガイドに従ってください。
一括コマンドの設定と使用
boxcli
GitHubリポジトリを複製するか、Bulk actions
ディレクトリからファイルをダウンロードします。
git clone https://github.com/box/boxcli.git
-
必要に応じて
.csv
テンプレートを調整します。たとえば、複数のフォルダを作成する場合は、出発点としてfolders-create.csv
テンプレートを使用できます。 -
コマンドを実行します。
box users:create --bulk-file-path <PATH_TO_CSV>/folders-create.csv