# @computesdk/opencomputer 中文文档

规范地址：https://npmcn.com/package/%40computesdk/opencomputer/

版本：1\.0\.21
npm 元数据更新时间：2026-11-06T13:39:46.951Z
中文译文更新时间：2026-11-10T14:47:49.271Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：94.6 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-07-23T18:30:05.678Z
- 最新版本发布：2026-11-06T13:39:46.593Z
- 近 30 天下载量：8995（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

计算SDK 的 OpenComputer 提供者 - 有检查点、 预览 URL、 命令执行以及文件系统访问的持久云 VMS

## 安装

```sh
npm install @computesdk/opencomputer
```

也可以使用：`pnpm add @computesdk/opencomputer`、`yarn add @computesdk/opencomputer`、`bun add @computesdk/opencomputer`

## README

# @ computesdk/ 打开计算机

ComputeSDK的OpenComputer提供者 - 创建持久云VM,运行命令,读取/写入文件,曝光预览URL,并通过ComputeSDK接口管理检查点.

## 安装

```bash
npm install computesdk @computesdk/opencomputer
```

## 设置

创建 OpenComputer API 密钥并设定 :

```bash
export OPENCOMPUTER_API_KEY=your_api_key_here
```

可选择地覆盖 API URL :

```bash
export OPENCOMPUTER_API_URL=https://app.opencomputer.dev
```

## 快速启动

```typescript
import { compute } from 'computesdk';
import { opencomputer } from '@computesdk/opencomputer';

compute.setConfig({
  provider: opencomputer({ apiKey: process.env.OPENCOMPUTER_API_KEY }),
});

const sandbox = await compute.instances.create({ templateId: 'base' });

const result = await sandbox.runCommand('echo "Hello from OpenComputer"');
console.log(result.stdout);

await sandbox.filesystem.writeFile('/tmp/hello.txt', 'Hello ComputeSDK');
console.log(await sandbox.filesystem.readFile('/tmp/hello.txt'));

const url = await sandbox.getUrl({ port: 3000 });
console.log(url);

await sandbox.destroy();
```

## 配置

```typescript
interface OpenComputerConfig {
  apiKey?: string;
  apiUrl?: string;
  template?: string;
  timeout?: number;
  envs?: Record<string, string>;
  metadata?: Record<string, string>;
  cpuCount?: number;
  memoryMB?: number;
  diskMB?: number;
  secretStore?: string;
  burst?: boolean;
  previewAuth?: { scheme?: 'bearer'; token?: 'auto' | string };
}
```

`timeout` 使用计算SDK的毫秒常规并被转换为OpenComputer以秒为基础的API.

## 特征

-   通过 OpenComputer exec 命令执行
-   文件系统读取、写入、 mkdir、 列表、 存在、 删除
-   Sandbox 创建, 通过 ID 重新连接, 并销毁
-   预览沙盒端口的 URL
-   通过计算SDK快照检查点

## 抓图

开放式计算机检查站被限制在源沙箱内。 此提供者返回窗体中的快照ID `instanceId:checkpointId` 因此计算SDK可以在以后删除检查点.

```typescript
const sandbox = await compute.instances.create();

const snapshot = await compute.snapshot.create(sandbox.instanceId, {
  name: 'ready-state',
});

const clone = await compute.instances.create({ snapshotId: snapshot.id });

await compute.snapshot.delete(snapshot.id);
await clone.destroy();
await sandbox.destroy();
```

您也可以通过原始的 OpenComputer 检查点ID `compute.instances.create({ snapshotId })` 当你只需要叉出它.

快照默认为打开计算机 `disk_only` 检查站 `promoteToFull: true`覆盖 `metadata: { kind: 'full' }` 或者说 `metadata: { promoteToFull: false }` 需要的时候.

## 常见问题

### @computesdk/opencomputer 是什么？

计算SDK 的 OpenComputer 提供者 - 有检查点、 预览 URL、 命令执行以及文件系统访问的持久云 VMS

### 如何安装 @computesdk/opencomputer？

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

### @computesdk/opencomputer 支持 TypeScript 吗？

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

### @computesdk/opencomputer 支持 ESM 还是 CommonJS？

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

### @computesdk/opencomputer 可以商用吗？

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

### @computesdk/opencomputer 的下载量有多少？

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

### @computesdk/opencomputer 还在维护吗？

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