@compozy/client

中文文档
0.5.5发布于 2026/11/09MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 3243

用于 CompozyOS 应用程序的实验零依赖性类型Script客户端

中文使用文档

@ compozy/ 客户端

一个零依赖性TypeScript客户端用于在CompozzyOS上构建的应用程序. 支持节点18+, Bun, 德诺,浏览器,和边缘运行时间。 守护进程仍然是单独的服务.

此放出中的实验:在下一次放出时,名字和形状可能会有变化,而不会有被贬损的窗口. 把准确的版本.

import { Compozy } from "@compozy/client";

const compozy = await Compozy.connect();
const { workspace } = await compozy.workspaces.resolveWorkspace({ body: { path: process.cwd() } });
const { session } = await compozy.sessions.createSession({
  body: { workspace: workspace.id, agent_name: "claude" },
});
const reply = await compozy.prompt({
  workspaceId: workspace.id,
  sessionId: session.id,
  message: "Summarize this repository.",
});
if (reply.kind === "stream") {
  for await (const chunk of reply.chunks) {
    if (chunk.type === "text-delta") process.stdout.write(chunk.delta);
  }
}

节点发现检查 baseUrl, (中文(简体) ), COMPOZY_URL,则 daemon.json 内 home编号 :COMPOZY_HOME编号 :~/.compozy, (中文(简体) ), 接下来 http://127.0.0.1:2123。浏览器默认为 http://localhost:2123。通过 token 以物配给; 节点也读作 COMPOZY_APP_TOKEN。所有操作接受中止信号.

使用 promptResponse() 在服务器路由中转发AI SDK UI消息流,不变. 读取 其他SSE业务通过 events(operationId, options),与 Last-Event-ID 在网络或服务器失败后。 客户端错误立即停止; 连续20次失败停止 流线。 中止快速停止读取而不取消守护进程转弯 .

提示助手生成命令身份时 idempotencyKey 省略。 提供同样的钥匙 当重试相同的输入以保留其消息身份并重放守护进程收件时.

只有节点 @compozy/client/node 条目添加 Compozy.start({ home }) 财务报告和审定财务报表 close({ stopDaemon: true })。它只停止守护进程 此实例在同一家开始 仍然命名自有进程。 关闭信号 保留的孩子手柄 等待它的退出, 所以一个守护进程 取代它不能成为停止目标。 主浏览器条目包含Node模块.

生成的资源方法涵盖JSON业务. 导出 paths, (中文(简体) ), operations, (中文(简体) ), components,以及 Operation* 帮助者还与其他HTTP客户端合作. 没有依赖反应或 ai。 。 。 .

见 构建应用程序, (中文(简体) ), 聊天用户界面,以及 浏览器访问 用于教学和API参考样本.

版本与发布记录

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

版本发布日期距今
0.5.5latest2026/11/091 天前
0.5.42026/11/082 天前
0.5.32026/11/064 天前
0.5.22026/11/055 天前
0.5.12026/11/046 天前
0.5.02026/11/037 天前

其他发布通道:bootstrap → 0.3.0-beta.35,beta → 0.4.0。

关于 @compozy/client 的常见问题

@compozy/client 是什么?

用于 CompozyOS 应用程序的实验零依赖性类型Script客户端

如何安装 @compozy/client?

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

@compozy/client 支持 TypeScript 吗?

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

@compozy/client 支持 ESM 还是 CommonJS?

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

@compozy/client 需要什么版本的 Node.js?

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

@compozy/client 可以商用吗?

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

@compozy/client 的下载量有多少?

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

@compozy/client 还在维护吗?

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