# @factory/droid-sdk 中文文档

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

版本：0\.11\.0
npm 元数据更新时间：2026-11-12T23:21:58.727Z
中文译文更新时间：2026-11-14T08:26:22.376Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40factory/droid-sdk
原文对照：https://npmcn.com/package/%40factory/droid-sdk/?lang=original
项目主页：https://github.com/Factory-AI/droid-sdk-typescript#readme
源码仓库：https://github.com/Factory-AI/droid-sdk-typescript

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

- 包体积（解压后）：23 MB，76 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：9 个
- 首次发布：2026-03-25T19:18:49.743Z
- 最新版本发布：2026-11-12T23:21:58.550Z
- 近 30 天下载量：85553（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

工厂机器人 CLI 的脚本 SDK

## 安装

```sh
npm install @factory/droid-sdk
```

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

## README

# @ factory/droid-sdk (英语)

Factory TypeScript SDK让应用程序运行Droid,继续对话, 流工作,控制工具,并连接到运行中的Droid守护进程.

## 安装

```bash
npm install @factory/droid-sdk
```

SDK需要节点.js 18或后.

## 入境点

| 导入 | 运行时间 | 目的 |
| --- | --- | --- |
| `@factory/droid-sdk/node` | 节点 | 启动 Droid 子进程, 运行提示, 管理本地会话, 定义 SDK MCP 工具 |
| `@factory/droid-sdk` | 浏览器或节点 | 连接到现有的 Droid 守护进程并使用浏览器安全计划、类型和 REST 帮助器 |
| `@factory/droid-sdk/api` | 浏览器或节点 | 通过从公共 API 光谱生成的客户端调用任何 Factory REST API 操作 |

默认情况下,节点会话 API 启动 `droid` 来自CLI `PATH` 读取 `FACTORY_API_KEY`。可以提供自定义可执行文件、 API 密钥或运输工具 通过会话选项.

## 快开始

```ts
import { run } from '@factory/droid-sdk/node';

const result = await run('Summarize this repository.');

if (!result.success) {
  throw new Error(result.error?.message ?? 'The run did not complete.');
}

console.log(result.text);
```

使用 `createSession()` 多回合节点对话。 使用 `connectToDaemon()` 从根切入点开始管理会话 已有守护进程.

## 文档

这个 [脚本 SDK 文档](https://docs.factory.ai/sdk/typescript) 实值 canonic 用户化指南:

-   节点和守护进程运行时间
-   运行、会话、流出、附件和结构化输出
-   权限、询问用户、工具、技能、MCP和钩子
-   会话替换和清理行为
-   浏览器和守护进程集成
-   可观察性、REST帮助者、先进资源和公众API

可用示例 [`examples/node`](https://npmcn.com/package/%40factory/droid-sdk/examples/node) 财务报告和审定财务报表 [`examples/browser`](https://npmcn.com/package/%40factory/droid-sdk/examples/browser)。 。 。 .

### 自定义运输迁移

-   **中断代理客户更改 :** `DroidClientOptions.transport` 和习惯 现在需要的会话传输 `DroidClientTransport`交换 `JsonRpcMessage` 对象通过 `send` 财务报告和审定财务报表 `onMessage`无格式标记或 需要运行时间检测.
-   内建 `ProcessTransport` 拥有它的STDIO JSON代码. 它的直接 `send` 财务报告和审定财务报表 `onMessage` 呼叫者现在必须通过并接收对象而不是字符串. 在进程执行中交换快取而无需解码器.
-   对于已有的习惯 `StringFramedDroidClientTransport`,明确通过 `withJsonRpcCodec(stringTransport)` 改为 `DroidClient` 或会话选项. 适配器和两个接口均导出自 `@factory/droid-sdk/node`。 。 。 . 不要包写已经输入的传输 .
-   **中断守护进程客户端更改 :** 替换 `DaemonClient.onMessage` 与 `onTransportMessage` 删除 `JSON.parse` 从召回。 自定义 `DaemonClientTransport.send` 财务报告和审定财务报表 `message` 听众现在交换 `JsonRpcMessage` 对象。 将编码器放入跨越序列的运输工具 边界。 外线格式不变.

### 共享显示信件

-   `filterMessagesForUI` 不再复制信件。 一条没有消息的信息 隐藏作为同一个对象回来, 一个剥去的信息作为投影 后来又打回电话 将结果视为只读: 变异 更改您的输入或后起的调值。 替换信件而不是 编辑它.

### 打开状态值( 0.11.0)

-   `RemoteSession['status']`, (中文(简体) ), `MachineTemplateBuildStatus['status']`,以及 `MachineTemplateBuildStatus['failureReason']` 现在接受更新的值 服务器添加而不是失败响应 。 详尽无遗 `switch` 结束 其中之一需要一个未知值的分支.
-   这些领域 `RemoteSessionSchema` 财务报告和审定财务报表 `MachineTemplateBuildStatusSchema` 是现在的工会,不是工会: `.enum` 打开 他们走了 `.options` 列出工会成员计划,而不是 已知的数值.

### 机器模板列表 (0.1.10

-   `listMachineTemplates` 不再需要钱 `limit` 或者说 `cursor`API 软件 返回一个回复中的每个模板,与 `pagination.hasMore` 永远 `false` 财务报告和审定财务报表 `pagination.nextCursor` 永远 `null`。 。 。 .
-   `ListMachineTemplatesOptions` 滴数 `limit` 财务报告和审定财务报表 `cursor` 但别走开 界面结束 `FactoryApiOptions`,所以声明合并到它 保持 编译。 一个通过任意一字段的选项对象文字失败 类型检查; 带有额外属性的可变键编译, 帮助器 不发送它们.

这个 [犬类 SDK 指南](https://docs.factory.ai/sdk/typescript) 仍为 完整 API 参考.

## 浏览器安全

守护进程客户端目前以 Factory API 密钥认证 。 浏览器 集成是用于可信赖的本地工具。 不运送工厂 API 密钥 在公共网站上,将其用于源控制,或将其放入URL.

## 许可证

Apache 2.0 (英语)

## 常见问题

### @factory/droid-sdk 是什么？

工厂机器人 CLI 的脚本 SDK

### 如何安装 @factory/droid-sdk？

在项目目录运行 npm install @factory/droid-sdk，或使用 pnpm add / yarn add / bun add。

### @factory/droid-sdk 支持 TypeScript 吗？

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

### @factory/droid-sdk 支持 ESM 还是 CommonJS？

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

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

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

### @factory/droid-sdk 可以商用吗？

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

### @factory/droid-sdk 的下载量有多少？

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

### @factory/droid-sdk 还在维护吗？

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