クイックスタート
CLIは、任意のプラットフォーム (Linux、Windows、macOSなど) で実行できます。Node.js 22以降をインストールしておく必要があります。 以下のコマンドではboxを使用します。npm install boxでインストールした場合は、先頭にnpx を付けます (例: npx box login)。
手順1: CLIのインストール
推奨される方法は、CLIとBox Node SDKをバンドルしたbox npmパッケージのインストールです。
npx boxで任意のCLIコマンドを実行します。
手順2: CLIの認証
ターミナルで次のコマンドを実行します。1. Boxユーザーとしてログインする (OAuth)
最も速く開始できる方法です。ファイルとフォルダの操作、AI、Signのみをサポートする、あらかじめ設定されているBoxアプリケーションを使用します。 ブラウザに表示された [Boxへのアクセスを許可] ボタンを選択します。 認証が正常に完了したら、コマンドを実行する準備は完了です。2. Box Platformアプリを使用する
このオプションでは追加の設定が必要ですが、スコープや権限を構成できます。- 開発者コンソールに移動して、アプリケーションを選択または作成します。
- アプリケーションの [構成] セクションで、以下を実行します。
- 標準OAuth 2.0を使用していることを確認します。
- [リダイレクトURI] を
http://localhost:3000/callbackに設定します。 - 目的のを選択します。
- クライアントIDとクライアントシークレットをコピーします。
- ページ上部にある [変更を保存] をクリックします。
- ターミナルウィンドウに戻り、求められたらクライアントIDとクライアントシークレットを入力します。
- ブラウザに表示された [Boxへのアクセスを許可] ボタンを選択します。
クライアントIDとクライアントシークレットのプロンプトをスキップするには、
box login --platform-appを使用します。3. ヘッドレス環境 (ブラウザのない場合)
リモートサーバーなどブラウザのないマシンを使用している場合は、--codeフラグを使ってコードを手動で入力します。一連の手順については、を参照してください。
手順3: 最初のコマンドの実行
構成が正常に完了したことを確認するには、次のコマンドを入力します。ヘルプの利用
すべてのCLIコマンドはboxで始まります。ヘルプを表示するには、任意のコマンドに--helpを追加します。box --helpを実行すると、使用可能なトップレベルのコマンドがすべて表示されます。
コマンドの全一覧と使用方法に関する情報については、GitHubリポジトリを参照してください。
サポートされているコールバックポートは3000、3001、4000、5000、8080です。変更するには--portを使用します。
Box APIを使用するための代替方法
- 方法を使用するには、のガイドを参照してください。
- 方法を使用するには、box configureガイドを参照してください。
追加情報
Box CLIの詳細については、以下のページを参照してください。- すべてのコマンドを確認する。
- トークンのキャッシュの設定を確認する。
- オートコンプリートの設定を確認する。
- CLIコマンドを使用して一括操作を行うには、CLIの一括コマンドガイドを参照してください。
Boxが提供するアプリケーションを介して送信されるAPIリクエストは課金対象ではありません。Box APIを使用してカスタムアプリケーションから送信されるリクエストは課金対象となります。