Node SDKのインストール

NodeプロジェクトからBox APIを呼び出すには、次のいずれかの形でBox Node SDKをインストールします。

GitHubでNode SDKの詳細を確認する

box npmパッケージを使用すると、Box Node SDKとBox CLIを直接的な依存関係としてインストールでき、1つのコマンドで両方のツールを使用できるようになります。

Node.js 22以降のインストール。

npm install box

import BoxSDK from 'box/sdk';  // ESM
const BoxSDK = require('box/sdk');  // CommonJS

TypeScriptの型が含まれています。インストール後、npx box <command>で任意のCLIコマンドも実行できます。別途のインストールは不要です。このboxパッケージは、npm、yarn、pnpm、bunで機能します。

既存のbox-node-sdkユーザー: box-node-sdkで問題なければ、そのまま使用してください。boxパッケージは、新しく始める開発者とそのコーディングエージェント向けです。既存のコードに影響はありません。

既存のプロジェクト向けのスタンドアロンパッケージを使用します。

Node SDKをインストールするには、Nodeパッケージマネージャを使用してターミナルウィンドウまたはコマンドプロンプトから以下のコマンドを実行します。

npm install box-node-sdk --save

同様に、Yarnパッケージマネージャを使用してSDKをインストールすることもできます。

yarn add box-node-sdk