@berthos/sdk

中文文档
0.3.1发布于 2026/10/31Apache-2.0TypeScriptES Module构建来源已验证

常驻应用SDK: defineApp(),生命周期钩子,上下文总线客户端-在沙箱中运行

中文使用文档

@berthos / sdk

构建一个常驻应用程序:一个运行在泊位沙箱内的工具,并公开代理可以调用的函数。SDK会给你 defineApp()上下文总线和语义文件系统的生命周期钩子和客户端。

泊位 在沙盒中运行人工智能代理的工具。每个工具在类中声明它可以接触什么 berth.yml manifest, Linux内核强制执行它。

npm install @berthos/sdk zod

使用

// src/index.ts
import { defineApp } from "@berthos/sdk";
import { z } from "zod";

export default defineApp((app) => {
  app.export({
    name: "ping",
    output: z.object({ message: z.string() }),
    handler: () => ({ message: "pong" }),
  });
});
# berth.yml
name: hello-world
version: 0.1.0
capabilities: []
exports:
  - name: ping
    output: { message: string }

在 berth.yml 太; berth test 检查它们是否匹配。应用程序可以触摸的东西来自于舱单 capabilities,而不是从代码。最快的开始是 berth init 从 @berthos/cli.

也出口: defineConnectorApp() (一个由声明式REST API描述构建的应用), requestCapability(), configureEgressProxy(),以及进程内 createLocalContextBus() 和 createLocalSemanticFs() 为测试。

文档

SDK参考 · 居民的应用 · 清单参考 · 回购

版本与发布记录

@berthos/sdk 共发布 6 个版本,首次发布于 2026/09/27;过去 12 个月发布了 6 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.1latest2026/10/312 天前
0.3.02026/10/277 天前
0.2.42026/09/271 个月前
0.2.32026/09/271 个月前
0.2.22026/09/271 个月前
0.2.12026/09/271 个月前

关于 @berthos/sdk 的常见问题

@berthos/sdk 是什么?

常驻应用SDK: defineApp(),生命周期钩子,上下文总线客户端-在沙箱中运行

如何安装 @berthos/sdk?

在项目目录运行 npm install @berthos/sdk,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 berth-runtime,可以用 npx berth-runtime 直接运行。

@berthos/sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@berthos/sdk 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@berthos/sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.19。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@berthos/sdk 可以商用吗?

@berthos/sdk 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@berthos/sdk 还在维护吗?

最新版本 0.3.1 发布于 2026/10/31(2 天前);至今共发布 6 个版本,其中过去 12 个月发布了 6 个;首次发布于 2026/09/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。