Box CLIのインストール

ガイドツールSDKとCLIBox CLIのインストール

Box CLIのインストール

Box Command Line Interface (CLI)は、ターミナルウィンドウまたはコマンドプロンプトからBox APIにリクエストを行うためのツールです。

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

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

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

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

LinuxとNodeのインストール

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

npm install --global @box/cli

ソースコード

GitHubページでCLIのソースコードも提供されています。

はじめに

最初に、JWTでサーバー側認証を使用してBoxカスタムアプリを設定し、開発者コンソールのアプリの設定ページからJSON構成ファイルをダウンロードします。次に、構成ファイルを指定してCLIをセットアップします。

box configure:environments:add [PATH_TO_CONFIG_FILE]

次に、JWTアプリのサービスアカウントのコンテンツのリストを指定して、最初のAPI呼び出しを行います。

box folders:get 0

すべてのアカウントのルートフォルダのIDは常に0です。JWTアプリケーションは、実際の管理対象ユーザーとして自動的に認証するのではなく、代わりにサービスアカウントを使用します。詳細については、ユーザータイプを参照してください。

設定とコマンド

CLI環境をセットアップし、CLIインストール後の操作を開始する手順については、Box CLIに関するGitHubページを参照してください。

このGitHubページには、上級CLIユーザーの参考となりそうなその他のガイドも用意されています。