@alwith/api

中文文档
0.6.0发布于 2026/11/03MIT OR Apache-2.0TypeScriptES Module零依赖构建来源已验证近 30 天下载 4959

ALWE 的公共运行时运输和应用程序状态

中文使用文档
文档目录4 节
  1. 移徙
  2. (原始内容存档于2018-03-21) (英语). Rust SDK
  3. 许可证和再分配
  4. 孤立测试运行时间

@ alwis/ api

公共运行时交通和框架独立应用状态. 非加太集团的要求, 能力,会话投影,回放和扩展字段属于引擎适配器. 对于Codex,从 @nyssance/codex-acp-v2/client。 。 。 .

条目目录
@alwith/api 或者说 /runtime运行时传输类型, WebSocketRuntimeClient, 运行状态观测
/node进程运行时间
/tauriTauriRuntimeClient, 连接到主机中继器
/client通用创建 Store 和更新Scheduler
/module模块运输
/tools模块工具声明

所有传输扩展 FramleRuntime Client. 运行时间拥有进程、运行状态和 读取确认。 原始请求信封仍然是不透明的运输有效载荷; 此软件包不解释或构建引擎扩展字段.

import { WebSocketRuntimeClient, observeRunStates } from "@alwith/api"
import { CodexClient } from "@nyssance/codex-acp-v2/client"

const port = new WebSocketRuntimeClient(url, token)
const client = new CodexClient(async () => port, {
  agentId: "codex", launch: { engine: "codex" }
})
const observer = observeRunStates(port, (records, source) =>
  client.applyRunStates(records, source === "snapshot" ? "snapshot" : undefined)
)
await observer.ready
// On teardown:
observer.dispose()

在读取快照前订阅观察, 丢弃快照被取代 由新的事件。 处置处理迟到的订阅登记,并具有一能性.

移徙

非加太代理/会议出口和协议会话 /client 条目; 本软件包没有兼容性再导出. 通用商店还在 /client。对于含有扩展的呼叫,使用 适配器,它通过不透明的运行时请求传输编码请求. 基本的跑时便利方法只接受他们的标准论证.

(原始内容存档于2018-03-21) (英语). Rust SDK

罗斯SDK是 alwith-api 以此软件包为版本的箱子:协议类型、运行时客户端和处理助手.

[dependencies]
alwith-api = { version = "0.6", features = ["client"] }

使用 default-features = false 如果你只需要类型.

许可证和再分配

由麻省理工学院(LICENSE-MIT)或Apache-2.0(LICENSE-APACHE)许可,由您自行选择;第三方通知为Terrict PARTY NOTICES.md. 在0.6.0前公布的版本保留着他们被释放的许可证.

孤立测试运行时间

使用 startTestRuntime 从 @alwith/api/node 用于测试脚本,包括临时 探测器 它拥有一个私人临时代码之家,工作空间,日记和注意力 状态为任一 stdio 或者说 ws工艺、发动机和发射环境有围栏 去那个家 它从来没有改变 呼叫者的环境或原始证书.

import { startTestRuntime } from "@alwith/api/node"
await using runtime = await startTestRuntime({
  binary: runtimeBinary,
  engines: { mock: mockEngine },
  transport: "stdio"
})
await runtime.client.start("test", { engine: "mock" })

默认家为空. 只有明确要求的现场测试用品 authFrom: existingCodexHome,复制 仅限 auth.json 拥有仅所有者权限. 固定在进程退出后删除副本和所有测试状态, 包括 启动失败 。 使用 try/finally 与 await runtime.dispose() 当主机运行时 不支持 await using。从不将测试的 CODEQHOME 指向原始目录.

版本与发布记录

@alwith/api 共发布 41 个版本,首次发布于 2026/09/16;过去 12 个月发布了 41 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.6.0latest2026/11/032 天前
0.5.42026/10/288 天前
0.5.32026/10/279 天前
0.5.22026/10/279 天前
0.5.12026/10/279 天前
0.5.02026/10/279 天前

关于 @alwith/api 的常见问题

@alwith/api 是什么?

ALWE 的公共运行时运输和应用程序状态

如何安装 @alwith/api?

在项目目录运行 npm install @alwith/api,或使用 pnpm add / yarn add / bun add。

@alwith/api 支持 TypeScript 吗?

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

@alwith/api 支持 ESM 还是 CommonJS?

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

@alwith/api 可以商用吗?

@alwith/api 使用 MIT OR Apache-2.0 许可。可在 MIT、Apache-2.0 中任选其一遵守。选择 MIT 时,宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@alwith/api 的下载量有多少?

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

@alwith/api 还在维护吗?

最新版本 0.6.0 发布于 2026/11/03(2 天前);至今共发布 41 个版本,其中过去 12 个月发布了 41 个;首次发布于 2026/09/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。