# @computesdk/createos-sandbox 中文文档

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

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

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

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

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

- 包体积（解压后）：176 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- 首次发布：2026-07-01T19:07:07.538Z
- 最新版本发布：2026-11-06T13:39:05.451Z
- 近 30 天下载量：9450（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 27 个）

## 中文简介

计算SDK的创建OS提供商 — 有暂停/ 重现/ 叉快照的节点Ops VM 沙盒

## 安装

```sh
npm install @computesdk/createos-sandbox
```

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

## README

# @ computesdk/ 创建os- sandbox

[计算SDK](https://github.com/computesdk/computesdk) 提供方 **创建OS** —— 说 节点Ops的creatos-sandbox VM沙盒服务. 细适配器于 正式 [`@nodeops-createos/sandbox`](https://www.npmjs.com/package/@nodeops-createos/sandbox)。 。 。 .

## 安装

```bash
npm install computesdk @computesdk/createos-sandbox
```

## 使用量

```typescript
import { compute } from "computesdk";
import { createosSandbox } from "@computesdk/createos-sandbox";

compute.setConfig({
  provider: createosSandbox({
    apiKey: process.env.CREATEOS_SANDBOX_API_KEY,
    baseUrl: process.env.CREATEOS_SANDBOX_BASE_URL,
  }),
});

const sandbox = await compute.instances.create({ memoryMb: 1024, image: "devbox:1" });
const { stdout } = await sandbox.runCommand("echo hello");
await sandbox.filesystem.writeFile("/tmp/x.txt", "hi");
await sandbox.destroy();
```

## 配置

| 外地 | 信封倒置 | 页:1 |
| --- | --- | --- |
| `apiKey` | `CREATEOS_SANDBOX_API_KEY` | 要求。 creatos-sandbox API 密钥 . |
| `baseUrl` | `CREATEOS_SANDBOX_BASE_URL` | 控制飞机URL. 可选;默认为生产控制平面. |
| `shape` | —— 说 | 默认 VM 形状( 如 . `s-1vcpu-1gb`) (中文(简体) ). |
| `rootfs` | —— 说 | 默认 rootfs 分类名/ 模板 . |
| `timeout` | —— 说 | 已报告 `getInfo().timeout` (数). 腾讯. |

## 能力绘图

从 a 创建 sandbox 大小 VM **形状目录** (不是免费的cpu/mem),所以 `create()` 获取实时目录( r)`GET /v1/shapes`)和地图 `cpus`编号 :`memoryMb` 在最小的形状适合。 传递指定提供者 `shape` 精确地标出一个( 跳过目录获取) 。 没有大小被钉住 默认是最小的活体形状,带有% 1 GiB RAM. `image`编号 :`runtime` 地图到 `rootfs`· ; `ephemeralDiskMb` 直接传递到 `disk_mib` (单位:千美元) 控制平面验证; `0`/出自 = 该形状的默认磁盘.

| 计算SDK | 创建沙盒 |
| --- | --- |
| 形状选择 | `GET /v1/shapes` (生活目录,最近的合适) |
| `sandbox.create` 编号 : `getById` 编号 : `list` 编号 : `destroy` | `POST/GET/DELETE /v1/sandboxes` |
| `sandbox.runCommand` | `POST /v1/sandboxes/:id/exec` (包装在 `sh -c`(中文(简体) ) |
| `sandbox.getInfo` | `GET /v1/sandboxes/:id` |
| `sandbox.getUrl({port})` | 每箱入侵 URL |
| `filesystem.readFile` 编号 : `writeFile` | `GET/PUT /v1/sandboxes/:id/files` |
| `filesystem.mkdir` 编号 : `readdir` 编号 : `exists` 编号 : `remove` | 合成通过 `runCommand` |
| `snapshot.create` 编号 : `list` 编号 : `delete` | 暂停 `fork({ start_paused: true })` \* 恢复/列表已暂停 `destroy` |

模板构建( E)`/v1/templates`已经 **没有** 通过计算SDK曝光 提供者表面——计算SDK的公开 `Provider` 类型无法携带 creas 特定 `dockerfile` 安全创建选项类型。 构建模板 当地人 `@nodeops-createos/sandbox` 客户端( e)`client.templates.create`(中文(简体) ) 直接说.

### 原生出逃舱

计算SDK的核心表面没有暂停/重置/叉. 全力以赴 `@nodeops-createos/sandbox` `Sandbox` 操作通过 `getInstance()`数字 :

```typescript
const native = sandbox.getInstance();
await native.pause();
await native.waitUntilPaused(); // pause() returns while the VM is still "pausing"
const clone = await native.fork();
await native.resume();
await native.attachDisk({ diskId: "my-bucket", mountPath: "/mnt/data" });
```

## 已知的限制

-   **`runCommand` env/cwd被合成** – 创建- sadbox 滴入每个执行内存 服务器侧,所以 `env`编号 :`cwd` 以内线将命令包入注入 `sh -c` 剧本. Sandbox-level env 应当设置在创建时间(`envs`) (中文(简体) ).
-   **快照被暂停了** - 只从一个暂停的沙盒里创造出叉子, 这样 `snapshot.create` 短暂地暂停源, 叉入已暂停的复制件 (快照,用自有的id)并恢复源. `create({ snapshotId })` 复制到新沙盒的叉子; `snapshot.delete` 摧毁它。 A 类 当进程运行时拍摄的快照也捕捉到其内存状态 .
-   **`getUrl` 打开入侵** ——沙盒由外出而来 (通过) `ingressEnabled: true` (一) 能够创造; `getUrl` 打开它 要求第一次请求 URL 。 入侵目前服务于非CA TLS 证书并剥去 `Authorization` 上游页眉-使用 `protocol: "http"` 编号 : `curl -k` 不要依赖 HTTP 认证 后入内地.
-   **`readdir` 剖析 `ls` 产出** ——依靠克来提斯 `ls` 在树根.

## 许可证

麻省理工学院

## 常见问题

### @computesdk/createos-sandbox 是什么？

计算SDK的创建OS提供商 — 有暂停/ 重现/ 叉快照的节点Ops VM 沙盒

### 如何安装 @computesdk/createos-sandbox？

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

### @computesdk/createos-sandbox 支持 TypeScript 吗？

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

### @computesdk/createos-sandbox 支持 ESM 还是 CommonJS？

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

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

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

### @computesdk/createos-sandbox 可以商用吗？

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

### @computesdk/createos-sandbox 的下载量有多少？

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

### @computesdk/createos-sandbox 还在维护吗？

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