# @ellipsis-dev/sdk 中文文档

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

版本：0\.49\.0
npm 元数据更新时间：2026-11-09T17:32:37.830Z
中文译文更新时间：2026-11-14T03:21:02.508Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ellipsis-dev/sdk
原文对照：https://npmcn.com/package/%40ellipsis-dev/sdk/?lang=original

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

- 包体积（解压后）：2.6 MB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-07-21T21:38:54.188Z
- 最新版本发布：2026-11-09T17:32:37.624Z
- 近 30 天下载量：2397（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 47 个）

## 中文简介

椭圆代理平台的TypeScript SDK: /v1 REST类型+客户端,会话流WebSocket客户端,会话笔录存储.

## 安装

```sh
npm install @ellipsis-dev/sdk
```

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

## README

# @ ellipsis- dev/ sdk

脚本 SDK 类型 [椭圆](https://www.ellipsis.dev/) 探员平台. 3个子路径输出, 运行时没有依赖性 :

-   **`@ellipsis-dev/sdk`** ——生成 `/v1` REST 类型+ `EllipsisClient`一个瘦子 输入时输入客户端 `fetchJson`。 。 。 .
-   **`@ellipsis-dev/sdk/stream`** — 会话流 WebSocket 客户端 (单位:千美元)`streamSession`心跳活跃, 重新连接后退,并通过 `after_seq` 记录 光标。 运输是注射的 `openSocket`,所以同样的机器运行在 浏览器、终端或服务器.
-   **`@ellipsis-dev/sdk/store`** —— 说 `SessionTranscriptStore` (单位:千美元)`subscribe`编号 :`getSnapshot`的形状 `useSyncExternalStore` 不过 框架无)加上纯成形的帮助者,将原始会话记录翻转 进入可翻译的录音记录和聊天室.

## 类型生成, 从未手写

-   `schema/frames.schema.json` - 制作WebSocket帧的JSON Schema 从服务器的框架模型.
-   `schema/openapi.v1.json` ——SDK的REST表面的OpenAPI文档.

`pnpm gen` 来源 `src/generated/` 从这些文件 (单位:千美元)`json-schema-to-typescript` + 键 `openapi-typescript`) CI再生和 diffs,服务器自己的测试套件将承诺的策略文件钉入 它的模型,所以类型不能从部署的API向任一方向漂移.

`test/fixtures/golden_stream.json` 是真实记录的帧序列 服务器流回路( ids and timetamps commondd); 商店的测试重放 因此,客户行为被验证 真实的排放,而不是手写 实例.

## 流线

流程(框架分类、交付类别、恢复/编码合同) 记录 [页:1](https://www.ellipsis.dev/docs)客户 **忽略未知的框架 类型和未知 `source`编号 :`record_type`编号 :`kind` 数值**。 。 。 .

## 共享聊天工作部分

Web 和 CLI 渲染器可以使用 `splitLedger(groupRecordsToChatTurns(records))` 财务报告和审定财务报表 `entryBody(entry, { live, now, liveText, liveSummary, harness })` 从 `@ellipsis-dev/sdk/store`。 。 。 . `now` 是划时代的毫秒,并且 `harness` 实值 `harnessName(session)`返回时 `items` 是崩溃的视图 : 一个 `isWorkFold(item)` 关于进展、思考和工具的章节 答复、转出结果和关闭通知保持可见. `members.get(item.key)` 包含 区域中的行; 嵌入工具折叠使用相同的映射和 `isToolFold`。 。 。 . 渲染者拥有扩张状态并可以递归地显示成员.

工作密钥作为记录流在回放中和播放后保持稳定. 现场直播 标签垫款来源 `Preparing environment` 改为 `Starting Claude Code` (单位:千美元) 绳子的名称,或 `Starting agent` 改为 `Working` 随着平台和本土转弯事件的到来. 特工工作的时候 标题 从 `store.getSnapshot().liveSummary` 替换 `Working` 当可用时. 只将摘要传给正在回答的条目(`loading: true`,添加装入 。在显示器中。 回来的 `seconds` 使用平台转动 和完成时间戳,甚至在第一个内容项目到达之前。 没错 转动开始前无效; 省略时钟 . `entry.progress.phase` 识别 每个消息的活动独立于最新消息或会话状态. 确定标签是 `Worked for 4m 43s`只有工作头正在装入; 部分 文本保留在其中。 Codex 信件阶段确定最终答案; 用于记录 没有阶段,确定转弯的最后信息会留在折叠外. 不需要DOM、React或终端依赖关系.

## 常见问题

### @ellipsis-dev/sdk 是什么？

椭圆代理平台的TypeScript SDK: /v1 REST类型\+客户端,会话流WebSocket客户端,会话笔录存储\.

### 如何安装 @ellipsis-dev/sdk？

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

### @ellipsis-dev/sdk 支持 TypeScript 吗？

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

### @ellipsis-dev/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @ellipsis-dev/sdk 可以商用吗？

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

### @ellipsis-dev/sdk 的下载量有多少？

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

### @ellipsis-dev/sdk 还在维护吗？

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