让开源，少一点语言距离。
npm包中文文档

@computesdk/sail

中文文档
1.0.21发布于 2026/11/06MITTypeScriptESM + CJS近 30 天下载 9202

Sail provider for ComputeSDK - fast, isolated microVM sandboxes with native filesystem access

原始使用文档
中文原文
文档目录4 节
  1. Installation
  2. Configuration
  3. Usage
  4. Supported Operations

@computesdk/sail

Sail provider for ComputeSDK. Sailboxes are isolated Firecracker microVM sandboxes with command execution, native filesystem operations, and public HTTP or TCP listeners.

Installation

npm install computesdk @computesdk/sail

Node.js 22 or newer is required by the Sail SDK.

Configuration

Create a Sail API key at app.sailresearch.com, then export it:

export SAIL_API_KEY=your_sail_api_key

The provider accepts:

interface SailConfig {
  apiKey?: string;
  app?: string;
  image?: ImageSpec | Image;
}
  • apiKey falls back to SAIL_API_KEY.
  • app owns the created Sailboxes and falls back to SAIL_APP, then computesdk. It is created on first use when missing.
  • image defaults to Sail's ARM64 Devbox builtin, which includes Node.js and Bun. Pass another Sail image when the workload needs a different runtime or architecture.
  • Creates default to an S Sailbox. Pass size: 'm' or size: 'l' to create() when the workload needs more compute.

Usage

import { sail } from '@computesdk/sail';

const compute = sail({ app: 'my-app' });

const sandbox = await compute.instances.create();
const result = await sandbox.runCommand('node --version');
console.log(result.stdout);

await sandbox.filesystem.writeFile('/tmp/result.txt', result.stdout);
console.log(await sandbox.filesystem.readFile('/tmp/result.txt'));

await sandbox.destroy();

It can also be registered with ComputeSDK's shared client:

import { compute } from 'computesdk';
import { sail } from '@computesdk/sail';

compute.setConfig({ provider: sail({ app: 'my-app' }) });
const sandbox = await compute.instances.create();

Supported Operations

OperationSupportedNotes
createYesDefaults to an ARM64 Devbox on S; supports name, size, memoryGib, and cancellation.
getByIdYesReturns null for missing or terminated Sailboxes.
listYesScoped to the configured app.
destroyYesTerminates the Sailbox.
runCommandYesSupports cwd, environment, timeout, and background mode.
getInfoYesRefreshes current lifecycle state.
getUrlYesExposes or reuses HTTP/HTTPS and TCP listeners.
FilesystemYesNative read, write, mkdir, list, exists, and remove.
TemplatesNoConfigure a Sail Image on the provider instead.
Pause/resumeYespause() holds the Sailbox in memory; files and running processes survive resume().
SnapshotsYesCheckpoints keep the whole filesystem (including /tmp) and memory; the source keeps running.

getUrl does not replace an existing listener because doing so would replace its allowlist. A listener with a conflicting protocol produces an error.

ComputeSDK's create timeout is not supported: it represents a hard sandbox lifetime, while Sail's autosleep only sleeps an idle Sailbox. Bound individual commands with runCommand's timeout or explicitly call destroy().

Use sandbox.getInstance() for Sail-specific to-disk sleep, fork, SSH, listener allowlist, and credential-injection APIs.

版本与发布记录

@computesdk/sail 共发布 21 个版本，首次发布于 2026/08/04；过去 12 个月发布了 21 个版本。

版本发布日期距今
1.0.21latest2026/11/064 天前
1.0.202026/11/046 天前
1.0.192026/10/2812 天前
1.0.182026/10/2317 天前
1.0.172026/10/2318 天前
1.0.162026/10/2218 天前

关于 @computesdk/sail 的常见问题

@computesdk/sail 是什么？

Sail provider for ComputeSDK - fast, isolated microVM sandboxes with native filesystem access

如何安装 @computesdk/sail？

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

@computesdk/sail 支持 TypeScript 吗？

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

@computesdk/sail 支持 ESM 还是 CommonJS？

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

@computesdk/sail 需要什么版本的 Node.js？

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

@computesdk/sail 可以商用吗？

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

@computesdk/sail 的下载量有多少？

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

@computesdk/sail 还在维护吗？

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