CLIのインストールと構成

ガイド ツール CLI Box CLIの使い方 CLIのインストールと構成

CLIのインストールと構成

Windows用およびmacOS用のインストーラが提供されていますが、その他の環境でCLIを構築する場合はRawソースコードを利用できます。

Windows用およびmacOS用インストーラ

お使いのマシンに最新のCLIをインストールするには、最新リリースに対応する最新の.exe(Windowsの場合)または.pkg(macOSの場合)をダウンロードします。

最新のCLIインストーラをダウンロード

LinuxとNodeのインストール

さらに、CLIは、任意のプラットフォーム(Linuxなど)にNodeパッケージとしてインストールすることができます。このためには、Node JSをマシンにインストールしておく必要があります。

npm install --global @box/cli

ソースコード

CLIのソースコードは、GitHubで提供されています。

構成コマンドの実行

ここで、手順1でダウンロードした構成ファイルを指すよう、CLIを構成する必要があります。

CLIの構成図

ターミナルまたはコマンドラインを開き、box configure:environments:add PathToConfigFileHereコマンドを実行します。ここでは、PathToConfigHereconfig.jsonファイルのパスに置き換えます。

例: box configure:environments:add /Users/ExampleUser/Documents/CLI/config.json

Finder/エクスプローラからターミナル/コマンドラインウィンドウにcsvファイルをドラッグすると、パスを自動で入力できます。

構成の確認

うまく構成されているか確認するには、コマンドbox users:getを使用します。

次のように、成功を示すレスポンスには、アクセストークンに関連付けられたサービスアカウントユーザーの詳細が示されます。

Type: user
ID: ''0123456789''
Name: Box CLI - Quickstart Example
Login: AutomationUser_123456_8jSo6Lqvko@boxdevedition.com
Created At: '2020-01-01T09:45:01-07:00'
Modified At: '2021-03-01T09:30:05-07:00'
Language: en
Timezone: America/Los_Angeles
Space Amount: 999999999999999
Space Used: 6291500
Max Upload Size: 16106127360
Status: active
Job Title: ''
Phone: ''
Address: example+user@box.com
Avatar URL: ''
Notification Email: []

デフォルトでは、JWTアプリケーションはサービスアカウントのアクセストークンを自動的に取得します。デフォルトユーザーの変更は可能ですが、このガイドでは変更しないことを想定しています。

まとめ

  • CLIをインストールしました。
  • アプリケーションの構成ファイルを指すようCLIを構成しました。
  • アクセストークンに関連付けられたユーザーを確認しました。