SDK のインストールとクイックスタート

TypeScript / JavaScript SDK をインストールして、最初のワークスペースデータを読み取ります。

busabase-sdk を使うと、TypeScript や JavaScript アプリを Busabase に接続できます。CLI と同じ API、URL、認証情報、ワークスペース選択を使います。

インストール

SDK パッケージには Node.js 24.18.0 以降が必要です。ES modules と TypeScript 型宣言が含まれています。

npm install busabase-sdk

pnpm プロジェクトでは pnpm add busabase-sdk も使えます。

接続を設定する

コンストラクターのオプション	環境変数	デフォルト
`baseUrl`	`BUSABASE_BASE_URL`	`https://busabase.com`
`apiKey`	`BUSABASE_API_KEY`	キーなし
`spaceId`	`BUSABASE_SPACE_ID`	ワークスペースのヘッダーなし

Cloud では、読み取り用 API キーを作成してワークスペース id を設定するか、CLI でサインインして busabase-cli space use でワークスペースを選択します。

SDK は環境変数を読み取りますが、~/.busabase/.env は自動で読み込みません。CLI が保存した設定を使う場合は、以下のように Node 起動時に読み込みます。

最初の読み取り

プロジェクトに quickstart.mjs を作成します：

import { Busabase } from "busabase-sdk";

const bb = new Busabase();
console.log(await bb.health());
console.log(await bb.bases.list());

CLI が保存した設定で実行します：

node --env-file="$HOME/.busabase/.env" quickstart.mjs

接続用の環境変数がすでに設定されている場合は node quickstart.mjs を実行します。サーバーの状態と、選択したワークスペースでキーが閲覧できる Bases が表示されます。この例はデータを読み取るだけです。

ローカル / Desktop

ローカルサーバーを起動し、URL を明示します：

import { Busabase } from "busabase-sdk";

const bb = new Busabase({ baseUrl: "http://localhost:15419" });
console.log(await bb.bases.list());

オープンソースのローカルサーバーは、デフォルトで認証を必要としません。セルフホストの場合は baseUrl をチームの URL に変更し、デプロイ環境で必要な認証情報を渡してください。

次のステップ

SDK は bb.bases、bb.records、bb.nodes、bb.changeRequests などのメソッドを提供します。編集の提案には Change Requests を使います。リクエストとレスポンスの形式は API リファレンスで確認できます。他の言語からは REST API を利用できます。

API キーはサーバーの環境変数に保存してください。エージェントの接続には MCP と OAuth、作業手順には Agent Skills も利用できます。

その他の接続方法：連携方法の一覧 · CLI · SDK · MCP · OpenAPI / REST · Agent Skills · Webhook