メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

Box CLIにより、Boxをターミナルで使用できるようになります。エージェント型ツールやハーネスとの連携により、コンテンツの管理、タスクの自動化、スクリプト、ツール、AIエージェントへのBoxの統合が可能になります。 Boxユーザーとしてログインすると、スコープはファイルおよびフォルダ、AI、Signに制限されます。追加のスコープが必要な場合は、代わりにBox Platformアプリを使用してください。

​
クイックスタート

​
手順1: CLIのインストール

CLIは、任意のプラットフォーム (Linux、Windows、macOSなど) にNodeパッケージとしてインストールすることができます。このためには、Node.jsをインストールしておく必要があります。 
npm install --global @box/cli

​
手順2: CLIの認証

ターミナルで次のコマンドを実行します。 
box login
1. Boxユーザーとしてログインする (OAuth)
最も速く開始できる方法です。ファイルとフォルダの操作、AI、Signのみをサポートする、あらかじめ設定されているBoxアプリケーションを使用します。 ブラウザに表示された [Boxへのアクセスを許可] ボタンを選択します。 認証が正常に完了したら、コマンドを実行する準備は完了です。
2. Box Platformアプリを使用する
このオプションでは追加の設定が必要ですが、スコープや権限を構成できます。
  1. 開発者コンソールに移動して、アプリケーションを選択または作成します。
  2. アプリケーションの [構成] セクションで、以下を実行します。
    • 標準OAuth 2.0を使用していることを確認します。
    • [リダイレクトURI] をhttp://localhost:3000/callbackに設定します。
    • 目的のを選択します。
    • クライアントIDとクライアントシークレットをコピーします。
  3. ページ上部にある [変更を保存] をクリックします。
  4. ターミナルウィンドウに戻り、求められたらクライアントIDとクライアントシークレットを入力します。
  5. ブラウザに表示された [Boxへのアクセスを許可] ボタンを選択します。
認証が正常に完了したら、コマンドを実行する準備は完了です。
クライアントIDとクライアントシークレットのプロンプトをスキップするには、box login --platform-appを使用します。
3. ヘッドレス環境 (ブラウザのない場合)
リモートサーバーなどブラウザのないマシンを使用している場合は、--codeフラグを使ってコードを手動で入力します。一連の手順については、を参照してください。 
box login --code

​
手順3: 最初のコマンドの実行

構成が正常に完了したことを確認するには、次のコマンドを入力します。 
box users:get me
認証が成功すると、CLIはBoxユーザーアカウントに関する情報を返します。 
Type: user
ID: '0123456789'
Name: Aaron Levie
Login: example@box.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: []

​
ヘルプの利用

すべてのCLIコマンドはboxで始まります。ヘルプを表示するには、任意のコマンドに--helpを追加します。box --helpを実行すると、使用可能なトップレベルのコマンドがすべて表示されます。 コマンドの全一覧と使用方法に関する情報については、GitHubリポジトリを参照してください。 サポートされているコールバックポートは3000、3001、4000、5000、8080です。変更するには--portを使用します。

​
Box APIを使用するための代替方法

  • 方法を使用するには、のガイドを参照してください。
  • 方法を使用するには、box configureガイドを参照してください。

​
追加情報

Box CLIの詳細については、以下のページを参照してください。
Boxが提供するアプリケーションを介して送信されるAPIリクエストは課金対象ではありません。Box APIを使用してカスタムアプリケーションから送信されるリクエストは課金対象となります。

​
高度な機能

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