SDK 安装与快速开始

使用 busabase-sdk 将 TypeScript 或 JavaScript 应用连接到 Busabase。它与 CLI 使用相同的 API、服务地址、认证信息和工作区选择。

安装

SDK 软件包要求 Node.js 24.18.0 或更高版本，提供 ES modules 和 TypeScript 类型声明。

npm install busabase-sdk

pnpm 项目也可以使用 pnpm add busabase-sdk。

使用 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。此示例只读取数据。

先启动本地服务，然后显式指定服务地址：

import { Busabase } from "busabase-sdk";

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

开源本地服务默认不需要认证。私有化部署请将 baseUrl 改为团队的服务地址，并提供部署所需的认证信息。

SDK 按领域提供 bb.bases、bb.records、bb.nodes 和 bb.changeRequests 等方法。使用 Change Requests 提出修改；请求和响应结构可在完整 API 参考中查看。其他语言可以直接使用 REST API。

API 密钥应保存在服务端环境中。给 Agent 提供连接时，可以选择 MCP 与 OAuth；需要教 Agent 如何工作时，可以安装 Agent Skills。

其他接入方式：接入方式总览 · CLI · SDK · MCP · OpenAPI / REST · Agent Skills · Webhook