# @daohoangson/computesdk-boat 中文文档

规范地址：https://npmcn.com/package/%40daohoangson/computesdk-boat/

版本：1\.0\.1
npm 元数据更新时间：2026-10-16T10:37:11.664Z
中文译文更新时间：2026-11-11T11:19:37.620Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40daohoangson/computesdk-boat
原文对照：https://npmcn.com/package/%40daohoangson/computesdk-boat/?lang=original
项目主页：https://www.computesdk.com/
源码仓库：https://github.com/daohoangson/computesdk

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

- 包体积（解压后）：120 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2026-10-16T06:17:21.785Z
- 最新版本发布：2026-10-16T10:37:11.492Z
- 近 30 天下载量：3032（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

计算SDK- Ubuntu 云沙箱的船载服务商, 带有流线、 命名快照、 签名文件传输和预览 URL

## 安装

```sh
npm install @daohoangson/computesdk-boat
```

也可以使用：`pnpm add @daohoangson/computesdk-boat`、`yarn add @daohoangson/computesdk-boat`、`bun add @daohoangson/computesdk-boat`

## README

# @daohoangson/计算船

> 上游前出版的计算SDK船供应商的临时建造 `@computesdk/boat` 软件包。 API 相同; 切换为 `@computesdk/boat` 一旦它被释放.

ComputeSDK的船提供商:Ubuntu云沙盒有流出命令,签名文件传输,命名快照和模板,以及HTTPS预览URL.

## 安装

```bash
npm install computesdk @computesdk/provider @daohoangson/computesdk-boat
```

## 设置

在其中创建 API 密钥 [船用仪表板](https://boat.dev/dashboard?tab=api-keys) 并导出 :

```bash
export BOAT_API_KEY=boat_...
# Optional: custom API endpoint (defaults to https://boat.dev/api/v1)
export BOAT_API_BASE=https://boat.dev/api/v1
```

## 使用量

```typescript
import { createCompute } from '@computesdk/provider';
import { boat } from '@daohoangson/computesdk-boat';

const compute = createCompute({ provider: boat({}) });
const sandbox = await compute.instances.create({ type: 'small' });

try {
  const result = await sandbox.runCommand('echo "Hello from Boat"');
  console.log(result.stdout);
  await sandbox.filesystem.writeFile('/tmp/hello.txt', 'Hello from Boat');
  console.log(await sandbox.filesystem.readFile('/tmp/hello.txt'));
} finally {
  await sandbox.destroy();
}
```

## 配置

| 选项 | 含义 |
| --- | --- |
| `apiKey` | API 密钥; 返回到 `BOAT_API_KEY` |
| `baseURL` | API URL; 返回到 `BOAT_API_BASE`,则 `https://boat.dev/api/v1` |
| `timeout` | 以毫秒计的默认沙盒寿命; 省略了使用 Boat 的 1小时默认值 |
| `readyTimeout` | 提供以毫秒为单位的等待期限;默认为30万 |
| `snapshotTimeout` | 命名快照保存截止日期, 以毫秒为单位; 默认为 600 000 |
| `preview` | 默认预览设置 : `public`, (中文(简体) ), `localhost`,以及 `title` |
| `createOptions` | 本地船创建默认值, 如 `type`, (中文(简体) ), `environment`, (中文(简体) ), `noEnv`, (中文(简体) ), `from`, (中文(简体) ), `org`,以及 `ttlSeconds` |

## 特征

-   沙盒创建、获取、列表和永久销毁
-   前景命令,包括重新连接输出流、可选超时和远程清理;背景命令
-   通过共享守护进程 API 的互动进程
-   文件系统访问, 签名的二进制传输 `/home/user` 财务报告和审定财务报表 `/tmp` (单位:千美元)`readBoatFile`, (中文(简体) ), `writeBoatFile`(中文(简体) )
-   通过命名快照和模板 `provider.snapshot` 财务报告和审定财务报表 `provider.template`
-   按键保护的 HTTPS 预览 URL, 通过键入控制 `getBoatUrl`

## 限制

-   固定机型: CPU, 内存, 磁盘, GPU, 图像, 区域, 和任意的元数据选项被拒绝
-   预览 URL 仅为 HTTPS
-   快照保持磁盘变化,而不是处理内存; `/tmp` 除外
-   设置脚本在背景中运行, 因此准备状态并不意味着设置已完成

见 [船舶提供者指南](https://github.com/computesdk/computesdk/blob/main/docs/providers/boat.md) 详情和实例.

## 发展

现场测试,放 `BOAT_API_KEY=boat_...` 在仓库根中 `.env` git 忽略的文件。 测试时使用活船 API `BOAT_API_KEY` 已存在.

```bash
# Unit tests and real-SDK/local-HTTP transport tests; no cloud resources.
pnpm --filter @daohoangson/computesdk-boat test:unit

# Shared conformance, shared CRUD, and Boat-specific integration tests.
# BOAT_API_KEY in the environment or root .env enables live calls.
pnpm --filter @daohoangson/computesdk-boat test:integration

# All tests (also live when credentials are available).
pnpm --filter @daohoangson/computesdk-boat test
pnpm --filter @daohoangson/computesdk-boat typecheck
pnpm --filter @daohoangson/computesdk-boat lint
```

`index.test.ts` 用途 `runProviderTestSuite` 财务报告和审定财务报表 `crud.test.ts` 用途 `runProviderCrudTest`共享合同检查命令、文件系统、流程和互动进程;其基线测试使用共享的无证书模型。 CRUD和专船的集成测试在没有证书的情况下跳过. 不需要单独的活式选入旗.

`unit.test.ts` 使用 SDK 模拟; `transport.test.ts` 使用真实的"船"SDK来对抗本地的HTTP服务器. 分开 `integration.test.ts` 覆盖已签名的大文本/ 二进制传输,被保护/公用本地主机预览路由,并命名为快照还原. 测试文件按顺序运行,以避免同时出现账户-配额压力。 共享的相容性入口也空出沙盒开始停留在"船"的标准每分钟12起限下;下限的账户可能需要更慢的节奏.

Creditived runs 创建了多个可计费的小沙箱. 共用套房的钩子清理了它们的情况;专船测试试图清理两个沙盒,并在最后的块中进行命名的快照. 即使 root.env 包含一个密钥, 也可以运行每个没有云访问的套件, 使用 `BOAT_API_KEY= pnpm --filter @daohoangson/computesdk-boat test`。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @daohoangson/computesdk-boat 是什么？

计算SDK- Ubuntu 云沙箱的船载服务商, 带有流线、 命名快照、 签名文件传输和预览 URL

### 如何安装 @daohoangson/computesdk-boat？

在项目目录运行 npm install @daohoangson/computesdk-boat，或使用 pnpm add / yarn add / bun add。

### @daohoangson/computesdk-boat 支持 TypeScript 吗？

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

### @daohoangson/computesdk-boat 支持 ESM 还是 CommonJS？

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

### @daohoangson/computesdk-boat 需要什么版本的 Node\.js？

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

### @daohoangson/computesdk-boat 可以商用吗？

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

### @daohoangson/computesdk-boat 的下载量有多少？

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

### @daohoangson/computesdk-boat 还在维护吗？

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