# @boatdev/sdk 中文文档

规范地址：https://npmcn.com/package/%40boatdev/sdk/

版本：1\.13\.0
npm 元数据更新时间：2026-10-28T00:43:00.497Z
中文译文更新时间：2026-11-08T09:35:49.505Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40boatdev/sdk
原文对照：https://npmcn.com/package/%40boatdev/sdk/?lang=original
项目主页：https://docs.boat.dev/sdks/overview

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：5.3 MB，1460 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-09-16T17:41:01.290Z
- 最新版本发布：2026-10-28T00:43:00.287Z
- 近 30 天下载量：159307（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 25 个）

## 中文简介

@ boatdev/ sdk 的 OpenAPI 客户端

## 安装

```sh
npm install @boatdev/sdk
```

也可以使用：`pnpm add @boatdev/sdk`、`yarn add @boatdev/sdk`、`bun add @boatdev/sdk`

## README

# @ boatdev/ sdk

使用应用程序代码中的船 .

## 安装

```bash
npm install @boatdev/sdk
```

## 链接

-   SDK文档 : [https://docs.boat.dev/sdks/overview 页面存档备份,存于互联网档案馆](https://docs.boat.dev/sdks/overview)
-   API 参考 : [https://docs.boat.dev/api/v1 请检查isbn=值 (帮助)](https://docs.boat.dev/api/v1)
-   盘子 : [https://boat.dev/dashboard (英语)](https://boat.dev/dashboard)
-   API 密钥 : [https://boat.dev/dashboard?tab=api-keys (英语)](https://boat.dev/dashboard?tab=api-keys)

## 流动

1.  在船仪表板上创建 API 密钥 .
2.  创建或恢复沙盒 .
3.  启动沙盒.
4.  阅读事件直到工作完成.
5.  需要浏览器或图形界面能见度时打开桌面访问.
6.  停止,恢复,叉子,或者根据您的保留政策删除沙盒.

## 页:1

-   把清理进去 `finally`:停止/存档或删除用于测试的沙盒.
-   将 API 密钥、 船密钥、 SSH 密钥和桌面流 URL 视为敏感 .
-   `updateSecrets` 编号 : `update_secrets` 替换整个秘密设置。 先读一下目前的设置,然后发送所有应该留下的env var和秘密文件.
-   `rotateApiKey` 编号 : `rotate_api_key` 旋转原生秘诀就位. 立即存储返回的秘密; 显示一次 .
-   仓库选取为一能. 选择一个已经选中的寄存器更新其基础分支 .

## 示例

### 类型脚本

```ts
import { BoatApi, Configuration } from "@boatdev/sdk";

const sandbox = new BoatApi(new Configuration({
  basePath: process.env.BOAT_BASE_URL ?? "https://boat.dev/api/v1",
  accessToken: process.env.BOAT_API_KEY ?? (() => {
    throw new Error("Set BOAT_API_KEY from the Boat dashboard API keys tab.");
  })(),
}));

async function main() {
  let sandboxId: string | undefined;

  try {
    const created = await sandbox.create({ ttlSeconds: 1800 });

    sandboxId = created.sandbox.id;

    await sandbox.update({ sandboxId, name: "sdk-demo" });

    while (!["ready", "idle"].includes((await sandbox.get({ sandboxId })).sandbox.state)) {
      await new Promise((resolve) => setTimeout(resolve, 2000));
    }

    await sandbox.prompt({
      sandboxId,
      prompt: "Inspect the repository and summarize the test command.",
      provider: "codex",
    });

    const events = await sandbox.events({ sandboxId });
    console.log(events.events);
  } finally {
    if (sandboxId) {
      await sandbox.stop({ sandboxId });
    }
  }
}

main().catch((error) => {
  console.error(error);
  process.exitCode = 1;
});
```

### Java 脚本

```js
const { BoatApi, Configuration } = require("@boatdev/sdk");

const sandbox = new BoatApi(new Configuration({
  basePath: process.env.BOAT_BASE_URL || "https://boat.dev/api/v1",
  accessToken: process.env.BOAT_API_KEY || (() => {
    throw new Error("Set BOAT_API_KEY from the Boat dashboard API keys tab.");
  })(),
}));

async function main() {
  let sandboxId;

  try {
    const created = await sandbox.create({ ttlSeconds: 1800 });

    sandboxId = created.sandbox.id;

    await sandbox.update({ sandboxId, name: "sdk-demo" });

    while (!["ready", "idle"].includes((await sandbox.get({ sandboxId })).sandbox.state)) {
      await new Promise((resolve) => setTimeout(resolve, 2000));
    }

    await sandbox.prompt({
      sandboxId,
      prompt: "Inspect the repository and summarize the test command.",
      provider: "codex",
    });

    const events = await sandbox.events({ sandboxId });
    console.log(events.events);
  } finally {
    if (sandboxId) {
      await sandbox.stop({ sandboxId });
    }
  }
}

main().catch((error) => {
  console.error(error);
  process.exitCode = 1;
});
```

## 许可证

这个SDK是麻省理工学院的执照 赛艇,赛艇API,赛艇CLI,沙盒产品均为专有.

## 常见问题

### @boatdev/sdk 是什么？

@ boatdev/ sdk 的 OpenAPI 客户端

### 如何安装 @boatdev/sdk？

在项目目录运行 npm install @boatdev/sdk，或使用 pnpm add / yarn add / bun add。

### @boatdev/sdk 支持 TypeScript 吗？

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

### @boatdev/sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @boatdev/sdk 可以商用吗？

@boatdev/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @boatdev/sdk 的下载量有多少？

根据 npm 官方下载统计，@boatdev/sdk 在 2026/10/09 – 2026/11/07 这 30 天内被下载 159,307 次，日均约 5,310 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @boatdev/sdk 还在维护吗？

最新版本 1\.13\.0 发布于 2026/10/28（11 天前）；至今共发布 25 个版本，其中过去 12 个月发布了 25 个；首次发布于 2026/09/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。