# @arker-ai/sdk 中文文档

规范地址：https://npmcn.com/package/%40arker-ai/sdk/

版本：1\.3\.0
npm 元数据更新时间：2026-10-19T17:48:28.240Z
中文译文更新时间：2026-11-06T19:32:47.766Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：2.6 MB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：3 个
- peer 依赖：computesdk ^4\.1\.3，@computesdk/e2b ^1\.7\.51，@computesdk/modal ^1\.9\.3，@computesdk/daytona ^1\.7\.30
- 首次发布：2026-04-30T23:49:26.802Z
- 最新版本发布：2026-10-19T17:48:27.604Z
- 近 30 天下载量：6028（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 34 个）

## 中文简介

用于Arker虚拟计算机平台的TypeScript SDK——产卵沙箱VM,运行代码,同步文件.

## 安装

```sh
npm install @arker-ai/sdk
```

也可以使用：`pnpm add @arker-ai/sdk`、`yarn add @arker-ai/sdk`、`bun add @arker-ai/sdk`

## README

![Arker](https://npmcn.com/package/%40arker-ai/assets/banner.png)

[文档](https://arker.ai/docs) 编号 : [基准](https://arker.ai/benchmarks) 编号 : [控制台](https://arker.ai/console)

# Arker 类型脚本 SDK

使用Arker TypeScript SDK来叉出VM,运行命令并同步文件.

[![npm](https://img.shields.io/npm/v/@arker-ai/sdk.svg?style=flat-square&label=npm)](https://www.npmjs.com/package/@arker-ai/sdk)

## 安装

```bash
bun add @arker-ai/sdk
```

SDK需要节点.js 18或后.

## 开始吧

签名并获得您的 API 密钥 [方舟(arker.ai)/主机](https://arker.ai/console)。 。 。 .

`ARKER_API_KEY`, (中文(简体) ), `ARKER_PROVIDER`,以及 `ARKER_REGION` 必须在环境中设置或直接传递给 `new Arker()`。 。 。 .

叉出一个源 VM,运行一个命令,同步一个文件,并删除 VM :

```ts
import { Arker } from "@arker-ai/sdk";

const arker = new Arker();
const vm = await arker.fork({ source_vm_name: "ubuntu-coding" });

const result = await vm.run("python3 -c 'print(2 + 2)'");
if (result.type === "completed") {
  console.log(result.stdout);
}

await vm.sync("/tmp/hello.txt", "hello from Arker");
const data = await vm.sync("/tmp/hello.txt");
console.log(new TextDecoder().decode(data));

await vm.delete();
```

## 文件和实例

读取 [方舟文档](https://arker.ai/docs) 浏览可运行的 [实例](https://npmcn.com/package/%40arker-ai/examples)。 。 。 .

## 许可证

阿帕奇 - 2.0

## 池数 v2

游泳池需要每个组织的游泳池旗帜;残疾组织接收 `404 not_found`。这三种池型是: `managed` (亚克多云) 计算, `byoc` (工人Arker发射 在你的云账户),和 `self_hosted` (BLAST工人你运行). 这取代了集合v1和早先的BYOC API:引文、固定购买条件、价格和 购买一能键被去除,没有相容层.

为集合操作配置区域终点(或提供者和区域). 列表池使用跨区域控制平面;使用每个返回池的 用于以后的行动。 叉子上有一个 `pool_id` 或者说 `pool_name`; 名称在一个区域内对大小写不敏感。 舰队不能是 叉入池: 使用支持的图像源 。 集合 VM 不支持 交互式贝壳; 使用 `run` 为命令.

`managed` 财务报告和审定财务报表 `byoc` 集合请求 `resources` 全部3个数量 (单位:千美元)`vcpu`, (中文(简体) ), `memory_mib`, (中文(简体) ), `disk_mib`),包括零;a `self_hosted` 游泳池的电话 `resources` 是一个可选的盖。 每个集合报告 `resources_reserved` (怎样) (其工人缴款) `resources_provisioned` (VMs使用的内容). 一个游泳池 实值 `creating` 直至第一个工人开始工作(a) `managed` 池开始 `running`,则 `running`· ; `reason` 说什么需要注意。 A 类 `byoc` 池 (提供者) `aws`(中文(简体) ) 需要设置: 打开 `byoc.setup_url` 并创建 云形相叠. A 类 `self_hosted` 游泳池的平台是第一个 工人; 工人加入一个仅限于游泳池的API键, `ar.createApiKey({ name, scopes: [{ pool_id: poolId }] })`。 。 。 . 仅 `managed` 集体承担承诺.

承诺至少24小时,不能重叠,新承诺不能 从过去开始。 开始的承诺必须保持不变,包括到期的承诺 这些。 附加承诺帮助者读取池并附加到整个列表中. **序列化承诺编辑 :** aPI 没有条件更新或原子 附录,因此并行编辑可以覆盖未启动的承诺. 活动 承诺 防止缩小或删除; 调整为零,否则释放 保留地。 删除一个池删除其中的每个 VM .

API错误保留其代码,状态,消息和服务器细节. A 类 `429 quota_exceeded` 立即返回; 调整预定/配额或 删除未使用的池来代替重试 。 普通费率限额 SDK的重试政策. `capacity_unavailable` 意味着安置没有能力; 检查池子的预留资源,工人,和州。 舰队对舰队叉 不支持的外壳拒绝被浮出水面而不进行倒置. 创造没有文件证明的一能性保证:经过模棱两可的运输 失败, 请在再次创建前检查池列表 .

```ts
const pool = await arker.createPool({
  type: "managed", platform: "icelake",
  resources: { vcpu: 8, memory_mib: 32768, disk_mib: 102400 },
});
await arker.addPoolCommitment(pool.pool_id, {
  starts_at: "2027-01-01T00:00:00Z", ends_at: "2027-01-02T00:00:00Z",
});
await arker.fork({ image: "ubuntu", pool_id: pool.pool_id });
```

见 [bYOC 集合示例](https://npmcn.com/package/%40arker-ai/sdk/examples/aws-pool.ts) 为AWS设置和准备.

## 常见问题

### @arker-ai/sdk 是什么？

用于Arker虚拟计算机平台的TypeScript SDK——产卵沙箱VM,运行代码,同步文件\.

### 如何安装 @arker-ai/sdk？

在项目目录运行 npm install @arker-ai/sdk，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 arker，可以用 npx arker 直接运行。

### @arker-ai/sdk 支持 TypeScript 吗？

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

### @arker-ai/sdk 支持 ESM 还是 CommonJS？

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

### @arker-ai/sdk 需要什么版本的 Node\.js？

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

### @arker-ai/sdk 可以商用吗？

@arker-ai/sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @arker-ai/sdk 的下载量有多少？

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

### @arker-ai/sdk 还在维护吗？

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