# @clisbot/client 中文文档

规范地址：https://npmcn.com/package/%40clisbot/client/

版本：2\.2\.3
npm 元数据更新时间：2026-11-05T01:29:45.241Z
中文译文更新时间：2026-11-10T02:17:58.261Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：560 kB，54 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-10-10T10:27:18.371Z
- 最新版本发布：2026-11-05T01:29:45.042Z
- 近 30 天下载量：3425（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

Clisbot 客户端 SDK 软件包

## 安装

```sh
npm install @clisbot/client
```

也可以使用：`pnpm add @clisbot/client`、`yarn add @clisbot/client`、`bun add @clisbot/client`

## README

# @ clisbot/ 客户端

TypeScript SDK用于在Clisbot守护进程上方构建集成.

```bash
npm install @clisbot/client
```

```ts
import { createClisbotClient } from "@clisbot/client";

const client = createClisbotClient({ url: "ws://127.0.0.1:6868/ws" });
await client.connect();

const agent = await client.agents.create({
  config: { provider: "codex/gpt-5.5" },
  cwd: "/Users/me/dev/storefront",
  prompt: "Review the current diff and name the riskiest change.",
});

const result = await agent.waitForFinish();
console.log(result.lastMessage);

await client.close();
```

公共API是包根. 进口 `@clisbot/client/internal/*` 是Clisbot自己的软件包所使用的不支持的操作细节.

读取 [SDK 文档](https://clisbot.com/docs/sdk) 用于代理,工作空间,终端,提供者发现,事件,食谱,以及API参考. 可运行类型Script模式也存在 [`examples/`](https://npmcn.com/package/%40clisbot/client/examples/README.md)。 。 。 .

## 运行时间

客户端需要WebSocket执行. 现代浏览器和Node.js 22在全球提供了一款.

使用结束于 `/ws`,例如 `ws://127.0.0.1:6868/ws`。通过 `password` 当守护进程需要认证时.

客户端默认发布其支持的协议能力. 可选 `capabilities` 覆盖扩展或覆盖该声明;浏览器托管必须由调用者提供. 单独连接不订阅代理时间或目录事件. 见 [事件指南](https://clisbot.com/docs/sdk/events) 用于订阅寿命和更换时间表.

## 稳定

高级API出口自 `@clisbot/client` 是支持的 SDK 表面。 SDK和守护进程仍然是跨版本的协议相容的,但新加入的能力需要更新守护进程.

## 常见问题

### @clisbot/client 是什么？

Clisbot 客户端 SDK 软件包

### 如何安装 @clisbot/client？

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

### @clisbot/client 支持 TypeScript 吗？

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

### @clisbot/client 支持 ESM 还是 CommonJS？

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

### @clisbot/client 可以商用吗？

@clisbot/client 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @clisbot/client 的下载量有多少？

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

### @clisbot/client 还在维护吗？

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