`box` npmパッケージ

npmのboxパッケージはBox Node SDKとBox CLIを一度にインストールできるようにバンドルしたものです。これを使うと、JavaScriptプロジェクトまたはTypeScriptプロジェクトへのBoxの追加や、Box CLIコマンドの実行が1つのコマンドでできます。

含まれる内容

npm install boxは以下の2つの直接的な依存関係をインストールします。

TypeScriptの型が含まれています。

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

npm install box

このパッケージは、npm、yarn、pnpm、bunで機能します。

SDKをbox/sdkサブパスからインポートします。

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

SDKの利用と認証については、Node SDKのインストールと認証ガイドを参照してください。

安定したエイリアス。SDKはimport BoxSDK from 'box'を使ってパッケージのルートからインポートすることもできます。これは同じSDKを返し、基になるパッケージが将来変更されても安定して維持されるようになっています。

npx boxで任意のCLIコマンドを実行します。

npx box --help
npx box login
npx box users:get me

CLIを別途インストールする必要はありません。CLIの詳細なドキュメントについては、CLIの概要を参照してください。

このパッケージはCI環境でも安全に使用できます。以下のいずれかを満たしている場合は、インストール後メッセージがスキップされます。

インストール中およびインストール後にネットワークリクエストは行われません。Box APIトラフィックはすべて、Box SDKとCLIを通じて、実行時にアプリケーションの認証の使用で発生します。

どのリリースにも、公式GitHubリポジトリに照らして検証できる、暗号技術による来歴証明が含まれています。

boxパッケージはNode.js用です。Box UIコンポーネントをブラウザアプリケーションに埋め込むには、box-ui-elementsを別途インストールします。

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

boxパッケージはApache 2.0ライセンスに基づき、オープンソースとしてgithub.com/box/npm-boxで公開されています。コントリビューションはこのリポジトリに対するプルリクエストを通じて取り込まれます。