@next-open-ai/openclawx 0.8.32 → 0.8.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +55 -47
- package/apps/desktop/renderer/dist/assets/index-BSfTiTKo.css +10 -0
- package/apps/desktop/renderer/dist/assets/index-DgLpQsA-.js +89 -0
- package/apps/desktop/renderer/dist/index.html +2 -2
- package/dist/cli/cli.js +29 -0
- package/dist/cli/extension-cmd.d.ts +15 -0
- package/dist/cli/extension-cmd.js +107 -0
- package/dist/core/agent/agent-dir.d.ts +6 -0
- package/dist/core/agent/agent-dir.js +8 -0
- package/dist/core/agent/agent-manager.d.ts +13 -0
- package/dist/core/agent/agent-manager.js +72 -6
- package/dist/core/agent/proxy/adapters/claude-code-adapter.d.ts +2 -0
- package/dist/core/agent/proxy/adapters/claude-code-adapter.js +186 -0
- package/dist/core/agent/proxy/adapters/local-adapter.js +2 -0
- package/dist/core/agent/proxy/adapters/opencode-adapter.js +65 -29
- package/dist/core/agent/proxy/adapters/opencode-local-runner.js +9 -0
- package/dist/core/agent/proxy/index.js +2 -0
- package/dist/core/agent/token-usage-log-extension.d.ts +14 -0
- package/dist/core/agent/token-usage-log-extension.js +61 -0
- package/dist/core/config/desktop-config.d.ts +22 -2
- package/dist/core/config/desktop-config.js +57 -1
- package/dist/core/extensions/index.d.ts +1 -0
- package/dist/core/extensions/index.js +1 -0
- package/dist/core/extensions/load.d.ts +11 -0
- package/dist/core/extensions/load.js +101 -0
- package/dist/core/mcp/adapter.d.ts +4 -2
- package/dist/core/mcp/adapter.js +10 -4
- package/dist/core/mcp/client.d.ts +4 -0
- package/dist/core/mcp/client.js +2 -0
- package/dist/core/mcp/index.d.ts +5 -1
- package/dist/core/mcp/index.js +5 -1
- package/dist/core/mcp/operator.d.ts +19 -2
- package/dist/core/mcp/operator.js +97 -30
- package/dist/core/mcp/transport/index.d.ts +4 -0
- package/dist/core/mcp/transport/index.js +6 -1
- package/dist/core/mcp/transport/stdio.d.ts +6 -0
- package/dist/core/mcp/transport/stdio.js +22 -1
- package/dist/core/session-outlet/index.d.ts +19 -0
- package/dist/core/session-outlet/index.js +33 -0
- package/dist/core/session-outlet/outlet.d.ts +15 -0
- package/dist/core/session-outlet/outlet.js +49 -0
- package/dist/core/session-outlet/types.d.ts +35 -0
- package/dist/core/session-outlet/types.js +5 -0
- package/dist/core/tools/index.d.ts +1 -0
- package/dist/core/tools/index.js +1 -0
- package/dist/core/tools/truncate-result.d.ts +14 -0
- package/dist/core/tools/truncate-result.js +27 -0
- package/dist/core/tools/web-search/create-web-search-tool.d.ts +17 -0
- package/dist/core/tools/web-search/create-web-search-tool.js +87 -0
- package/dist/core/tools/web-search/index.d.ts +4 -0
- package/dist/core/tools/web-search/index.js +2 -0
- package/dist/core/tools/web-search/providers/brave.d.ts +2 -0
- package/dist/core/tools/web-search/providers/brave.js +87 -0
- package/dist/core/tools/web-search/providers/duck-duck-scrape.d.ts +2 -0
- package/dist/core/tools/web-search/providers/duck-duck-scrape.js +47 -0
- package/dist/core/tools/web-search/providers/index.d.ts +5 -0
- package/dist/core/tools/web-search/providers/index.js +13 -0
- package/dist/core/tools/web-search/types.d.ts +35 -0
- package/dist/core/tools/web-search/types.js +4 -0
- package/dist/gateway/channel/channel-core.d.ts +1 -0
- package/dist/gateway/channel/channel-core.js +91 -70
- package/dist/gateway/methods/agent-cancel.js +3 -0
- package/dist/gateway/methods/agent-chat.d.ts +4 -0
- package/dist/gateway/methods/agent-chat.js +294 -240
- package/dist/gateway/methods/run-scheduled-task.js +2 -0
- package/dist/gateway/server.js +2 -0
- package/dist/server/agent-config/agent-config.controller.d.ts +1 -1
- package/dist/server/agent-config/agent-config.service.d.ts +15 -3
- package/dist/server/agent-config/agent-config.service.js +18 -0
- package/dist/server/config/config.controller.d.ts +26 -0
- package/dist/server/config/config.service.d.ts +14 -0
- package/package.json +3 -1
- package/presets/preset-agents.json +121 -91
- package/presets/workspaces/finance-expert/skills/akshare-helper/SKILL.md +9 -0
- package/presets/workspaces/office-automation/skills/rpa-helper/SKILL.md +9 -0
- package/presets/workspaces/self-media-bot/skills/self-media-tools/SKILL.md +9 -0
- package/apps/desktop/renderer/dist/assets/index-BGHtXhm3.js +0 -89
- package/apps/desktop/renderer/dist/assets/index-CB2-m4ae.css +0 -10
package/README.md
CHANGED
|
@@ -21,40 +21,17 @@
|
|
|
21
21
|
| **使用指南** | [CLI 使用](docs/zh/guides/cli-usage.md) | 命令行对话、登录、模型与技能、开机自启 |
|
|
22
22
|
| | [桌面端使用](docs/zh/guides/desktop-usage.md) | Desktop 安装与启动、智能体/会话/技能/设置;对话内 `//` 指令查询与切换智能体 |
|
|
23
23
|
| | [Web 与 Gateway](docs/zh/guides/gateway-web.md) | 启动网关、端口与路径、Web 端连接 |
|
|
24
|
-
| | [使用场景](docs/zh/guides/usage-scenarios.md) |
|
|
24
|
+
| | [使用场景](docs/zh/guides/usage-scenarios.md) | 整理下载目录、创建/切换智能体、B站下载助手、安装技能、MCP、定时任务等 |
|
|
25
25
|
| **配置** | [配置概览](docs/zh/configuration/config-overview.md) | 配置目录、config.json 与 agents.json |
|
|
26
|
-
| | [智能体配置](docs/zh/configuration/agents.md) | 本机/Coze/OpenClawX 执行方式与模型 |
|
|
27
|
-
| | [通道配置](docs/zh/configuration/channels.md) | 飞书、钉钉、Telegram
|
|
28
|
-
| **功能说明** | [代理模式与多节点](docs/zh/features/proxy-mode.md) | Coze 接入、OpenClawX 多节点协作 |
|
|
26
|
+
| | [智能体配置](docs/zh/configuration/agents.md) | 本机/Coze/OpenClawX/OpenCode/Claude Code 执行方式与模型 |
|
|
27
|
+
| | [通道配置](docs/zh/configuration/channels.md) | 飞书、钉钉、Telegram、微信启用与配置项 |
|
|
28
|
+
| **功能说明** | [代理模式与多节点](docs/zh/features/proxy-mode.md) | Coze/OpenCode/Claude Code 接入、OpenClawX 多节点协作 |
|
|
29
29
|
| | [技能系统](docs/zh/features/skills.md) | Agent Skills 规范与扩展 |
|
|
30
|
+
| | [插件与扩展](docs/zh/features/plugins.md) | 扩展安装与编写、openbot extension 命令、用户手册 |
|
|
30
31
|
| **参考** | [常见问题](docs/zh/reference/faq.md) | 安装失败、端口占用、通道不回复等 FAQ |
|
|
31
32
|
| | [发布说明](docs/zh/release-notes.md) | 各版本功能更新与问题修复记录 |
|
|
32
33
|
|
|
33
|
-
<details>
|
|
34
|
-
<summary><strong>📂 文档树结构 (Doc structure)</strong></summary>
|
|
35
34
|
|
|
36
|
-
```
|
|
37
|
-
docs/
|
|
38
|
-
├── README.md → 语言切换入口 (Language switcher)
|
|
39
|
-
├── zh/ → 中文文档 (Chinese)
|
|
40
|
-
│ ├── README.md 文档入口与导航
|
|
41
|
-
│ ├── release-notes.md 发布说明
|
|
42
|
-
│ ├── guides/ 使用指南
|
|
43
|
-
│ ├── configuration/ 配置说明
|
|
44
|
-
│ ├── features/ 功能说明
|
|
45
|
-
│ ├── reference/ 参考
|
|
46
|
-
│ └── channel-streaming-design.md
|
|
47
|
-
└── en/ → 英文文档 (English)
|
|
48
|
-
├── README.md Index and navigation
|
|
49
|
-
├── release-notes.md Release notes
|
|
50
|
-
├── guides/ Guides
|
|
51
|
-
├── configuration/ Configuration
|
|
52
|
-
├── features/ Features
|
|
53
|
-
├── reference/ Reference
|
|
54
|
-
└── channel-streaming-design.md
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
</details>
|
|
58
35
|
|
|
59
36
|
### 常见问题(简要)
|
|
60
37
|
|
|
@@ -74,13 +51,15 @@ docs/
|
|
|
74
51
|
| **浏览器自动化** | 内置 [agent-browser](https://www.npmjs.com/package/agent-browser),可导航、填表、截图与数据抓取 |
|
|
75
52
|
| **长期记忆** | 向量存储(Vectra)+ 本地嵌入,支持经验总结与会话压缩(compaction) |
|
|
76
53
|
| **多端接入** | CLI、WebSocket 网关、Electron 桌面端,同一套 Agent 核心;各端技术栈见下方「各端技术栈」 |
|
|
77
|
-
| **多通道接入** | 飞书、钉钉、Telegram
|
|
78
|
-
| **代理模式** | 智能体执行方式可选 **本机** / **Coze** / **OpenClawX** / **OpenCode**;本机使用当前模型与 Skills
|
|
79
|
-
| **Coze 接入** | 支持 Coze 国内站(api.coze.cn)与国际站(api.coze.com);按站点分别配置 Bot ID 与 Access Token(PAT/OAuth/JWT),桌面端与通道均可选用 Coze
|
|
80
|
-
| **OpenClawX 多节点协作** | 可将智能体代理到另一台 OpenClawX 实例(baseUrl + 可选 API Key
|
|
81
|
-
| **OpenCode 代理** | 可将智能体代理至 [OpenCode](https://opencode.ai/) 官方 Server(本地 `opencode serve` 或远程);支持流式回复、斜杠指令 `/init`、`/undo`、`/redo`、`/share`、`/help`,与 TUI
|
|
54
|
+
| **多通道接入** | 飞书、钉钉、Telegram、微信等 IM 通道,Gateway 根据配置注册;入站经统一格式进 Agent,回复经通道回传 |
|
|
55
|
+
| **代理模式** | 智能体执行方式可选 **本机** / **Coze** / **OpenClawX** / **OpenCode** / **Claude Code**;本机使用当前模型与 Skills,**代理模式下本机 0 Token 消耗**,推理与消息处理在对方平台完成 |
|
|
56
|
+
| **Coze 接入** | 支持 Coze 国内站(api.coze.cn)与国际站(api.coze.com);按站点分别配置 Bot ID 与 Access Token(PAT/OAuth/JWT),桌面端与通道均可选用 Coze 智能体;**0 Token 消耗**,适合 Coze 侧大量消息与长对话场景 |
|
|
57
|
+
| **OpenClawX 多节点协作** | 可将智能体代理到另一台 OpenClawX 实例(baseUrl + 可选 API Key),实现多节点分工、负载与协作;本机 0 Token 消耗 |
|
|
58
|
+
| **OpenCode 代理** | 可将智能体代理至 [OpenCode](https://opencode.ai/) 官方 Server(本地 `opencode serve` 或远程);支持流式回复、斜杠指令 `/init`、`/undo`、`/redo`、`/share`、`/help`,与 TUI 使用方式一致;**0 Token 消耗**,适合 OpenCode 侧大量代码与长上下文能力 |
|
|
59
|
+
| **Claude Code 代理** | 可将智能体代理至本机 [Claude Code](https://github.com/anthropics/claude-code) CLI;需本机已安装 `claude` 命令(如 `npm install -g @anthropic-ai/claude-code`),可选配置工作目录(默认使用智能体工作区 `~/.openbot/workspace/<workspace>/`);**0 Token 消耗**,推理由 Claude Code CLI 完成 |
|
|
82
60
|
| **MCP** | 已支持 [MCP](https://modelcontextprotocol.io/)(Model Context Protocol):智能体可配置 stdio/SSE 两种连接方式,按智能体绑定 MCP 服务器,会话内自动加载对应工具,降低 Token 消耗与大模型幻觉 |
|
|
83
61
|
| **RPA(影刀)** | 通过 MCP 可接入影刀 RPA:在智能体 MCP 配置中添加 [yingdao-mcp-server](https://www.npmjs.com/package/yingdao-mcp-server)(命令 `npx -y yingdao-mcp-server`,可选 env 如 `RPA_MODEL`、`SHADOWBOT_PATH`、`USER_FOLDER`),即可在对话中调用影刀自动化能力 |
|
|
62
|
+
| **插件支持** | 通过 `openbot extension install/list/uninstall` 在 `~/.openbot/plugins` 安装 npm 包形式扩展;详见 [插件与扩展](docs/zh/features/plugins.md) |
|
|
84
63
|
|
|
85
64
|
---
|
|
86
65
|
|
|
@@ -109,7 +88,8 @@ docs/
|
|
|
109
88
|
│ 执行方式: │ │ Agents · Skills · Tasks │ │ compaction 扩展 │
|
|
110
89
|
│ local/coze/ │ │ Auth · Users · Workspace │ │ sql.js │
|
|
111
90
|
│ openclawx/ │ │ │ │ │
|
|
112
|
-
│ opencode
|
|
91
|
+
│ opencode/ │ │ │ │ │
|
|
92
|
+
│ claude_code(代理)│ │ │ │ │
|
|
113
93
|
│ pi-coding-agent│ │ │ │ │
|
|
114
94
|
│ pi-ai 多模型 │ │ │ │ │
|
|
115
95
|
└────────┬────────┘ └─────────────────────────────┘ └─────────────────────┘
|
|
@@ -117,23 +97,27 @@ docs/
|
|
|
117
97
|
▼
|
|
118
98
|
┌─────────────────────────────────────────────────────────────────────────────┐
|
|
119
99
|
│ Tools: read/write/edit · bash · find/grep/ls · browser · install-skill · │
|
|
120
|
-
│ save-experience (写入记忆) · Proxy(local/coze/openclawx)
|
|
100
|
+
│ save-experience (写入记忆) · Proxy(local/coze/openclawx/opencode/claude_code) │
|
|
121
101
|
└─────────────────────────────────────────────────────────────────────────────┘
|
|
122
102
|
```
|
|
123
103
|
|
|
124
104
|
- **CLI**:直接调用 Agent 核心,单次提示或批量脚本;可启动 Gateway(`openbot gateway`)及配置开机自启(`openbot service install/uninstall`)。
|
|
125
|
-
- **WebSocket Gateway**(`src/gateway/`):单进程内嵌 Nest,对外提供 WebSocket(JSON-RPC)与 HTTP;按 path 分流:`/server-api` 走 Nest、`/ws` 为 Agent 对话、`/ws/voice`/`/sse`/`/channel` 为扩展占位,其余为静态资源。根据配置注册**飞书、钉钉、Telegram
|
|
105
|
+
- **WebSocket Gateway**(`src/gateway/`):单进程内嵌 Nest,对外提供 WebSocket(JSON-RPC)与 HTTP;按 path 分流:`/server-api` 走 Nest、`/ws` 为 Agent 对话、`/ws/voice`/`/sse`/`/channel` 为扩展占位,其余为静态资源。根据配置注册**飞书、钉钉、Telegram、微信**等通道,入站消息经统一格式进入 Agent,回复经该通道发回对应平台。供 Web/移动端连接;支持以开机/登录自启方式常驻(Linux cron、macOS LaunchAgent、Windows 计划任务)。
|
|
126
106
|
- **Desktop 后端**(`src/server/`):NestJS HTTP API,即 **server-api**;可被 Gateway 内嵌或独立监听(默认端口 38081)。会话、智能体配置、技能、任务、工作区、鉴权等由本模块提供。
|
|
127
107
|
- **Desktop**:Electron 包一层 Vue 前端 + 上述后端;通过 Gateway 或直连 Desktop 后端与 Agent 通信。
|
|
128
|
-
- **Agent 核心**:统一由 `AgentManager` 管理会话、技能注入与工具注册;**执行方式**可为 **local**(本机 pi-coding-agent + Skills)、**coze**(代理至 Coze 国内/国际站)、**openclawx**(代理至其他 OpenClawX 节点,多节点协作)、**opencode**(代理至 OpenCode 官方 Server,支持流式与 `/init`、`/undo`、`/redo`、`/share`、`/help`
|
|
108
|
+
- **Agent 核心**:统一由 `AgentManager` 管理会话、技能注入与工具注册;**执行方式**可为 **local**(本机 pi-coding-agent + Skills)、**coze**(代理至 Coze 国内/国际站)、**openclawx**(代理至其他 OpenClawX 节点,多节点协作)、**opencode**(代理至 OpenCode 官方 Server,支持流式与 `/init`、`/undo`、`/redo`、`/share`、`/help` 等指令)、**claude_code**(代理至本机 Claude Code CLI,需已安装 `claude` 命令,可选工作目录)。记忆与 compaction 作为扩展参与 system prompt 与经验写入。
|
|
109
|
+
|
|
110
|
+
### 插件支持(Extensions)
|
|
111
|
+
|
|
112
|
+
扩展以 npm 包形式安装到 **`~/.openbot/plugins`**(可通过环境变量 `OPENBOT_PLUGINS_DIR` 覆盖)。使用 **`openbot extension install <pkg>`** 安装、**`openbot extension list`** 查看、**`openbot extension uninstall <pkg>`** 卸载。扩展包需**默认导出一个函数** `(pi) => void`(或 `() => (pi) => void`),在函数内通过 **`pi.registerTool`** 注册新工具,即可在会话中被模型调用。仓库内示例:`examples/plugins/openclawx-demo-extension`;完整说明与用户手册见 [插件与扩展](docs/zh/features/plugins.md)。
|
|
129
113
|
|
|
130
114
|
## 各端技术栈
|
|
131
115
|
|
|
132
116
|
| 端 | 技术 |
|
|
133
117
|
|------|------|
|
|
134
118
|
| **CLI** | Node.js 20+、TypeScript 5.7、Commander(gateway/login/config/service);`openbot` 入口,配置 `~/.openbot/desktop`,支持开机自启 |
|
|
135
|
-
| **WebSocket Gateway** | JSON-RPC over WebSocket,默认 38080;单进程内嵌 Nest,path 分流(/server-api、/ws、/channel 等);连接管理、通道(飞书/钉钉/Telegram
|
|
136
|
-
| **Agent 核心** | pi-coding-agent、pi-ai 多模型;执行方式 local/coze/openclawx;工具 read/write/bash/browser 等,SKILL.md 技能注入 |
|
|
119
|
+
| **WebSocket Gateway** | JSON-RPC over WebSocket,默认 38080;单进程内嵌 Nest,path 分流(/server-api、/ws、/channel 等);连接管理、通道(飞书/钉钉/Telegram/微信) |
|
|
120
|
+
| **Agent 核心** | pi-coding-agent、pi-ai 多模型;执行方式 local/coze/openclawx/opencode/claude_code;工具 read/write/bash/browser 等,SKILL.md 技能注入 |
|
|
137
121
|
| **Desktop 后端** | NestJS 10、Express、Socket.io,前缀 `server-api`;sql.js;Agents·Skills·Config·Auth·Workspace·Tasks |
|
|
138
122
|
| **Desktop 前端** | Electron 28、Vue 3、Pinia、Vite 5;Dashboard、Agents、Sessions、Skills、Settings、Tasks、Workspace |
|
|
139
123
|
| **记忆与向量** | Vectra 向量索引、远端嵌入、compaction 会话压缩、memory 目录持久化 |
|
|
@@ -217,7 +201,7 @@ docker compose up -d
|
|
|
217
201
|
docker compose -f deploy/docker-compose.yaml up -d
|
|
218
202
|
```
|
|
219
203
|
|
|
220
|
-
默认使用镜像 `ccr.ccs.tencentyun.com/windwithlife/openclawx:latest`。若需指定版本,可修改 `deploy/docker-compose.yaml` 中 `image` 的 tag(如 `0.8.28` 或 CI 生成的 `build-ci-openbot-<BUILD_NUMBER>`)。
|
|
204
|
+
默认使用镜像 `ccr.ccs.tencentyun.com/windwithlife/openclawx:latest`。若需指定版本,可修改 `deploy/docker-compose.yaml` 中 `image` 的 tag(如 `0.8.32`、`0.8.28`、`0.8.26` 或 CI 生成的 `build-ci-openbot-<BUILD_NUMBER>`)。
|
|
221
205
|
|
|
222
206
|
### 方式二:本地构建并运行(开发/无 CI 时)
|
|
223
207
|
|
|
@@ -234,6 +218,8 @@ docker compose -f docker-compose-dev.yaml up --build -d
|
|
|
234
218
|
|
|
235
219
|
构建完成后服务同样监听 **38080** 端口,镜像名为 `openclawx:dev`,容器名为 `openclawx-dev`。
|
|
236
220
|
|
|
221
|
+
**Docker 部署启动后,可通过 Web 方式配置与使用**:在浏览器中打开 **`http://localhost:38080`**(本机)或 **`http://宿主机IP:38080`**(局域网/远程),即可访问 server-api、健康检查及静态资源(若已挂载或内置前端),进行智能体、模型、通道等配置及对话,使用方式与 npm 启动网关一致(见下方「二、使用方式 → 2.2 Web」)。
|
|
222
|
+
|
|
237
223
|
### 配置与数据持久化
|
|
238
224
|
|
|
239
225
|
- Gateway 默认从容器内 `~/.openbot/desktop/` 读取配置(智能体、模型、通道等)。若需持久化或预置配置,可在 compose 中挂载宿主机目录,例如在 `deploy/docker-compose.yaml` 或 `deploy/docker-compose-dev.yaml` 的 `openclawx` 服务下增加:
|
|
@@ -273,7 +259,7 @@ docker compose -f docker-compose-dev.yaml up --build -d
|
|
|
273
259
|
|
|
274
260
|
# 二、使用方式
|
|
275
261
|
|
|
276
|
-
按**使用端**划分:CLI、Web、Desktop;另支持**飞书、钉钉、Telegram
|
|
262
|
+
按**使用端**划分:CLI、Web、Desktop;另支持**飞书、钉钉、Telegram、微信**等通道(见 2.4);后续将支持 iOS、Android 等。
|
|
277
263
|
|
|
278
264
|
## 2.1 CLI
|
|
279
265
|
|
|
@@ -298,7 +284,7 @@ openbot --model deepseek-chat --provider deepseek "写一段 TypeScript 示例"
|
|
|
298
284
|
CLI 与桌面端共用**桌面配置**(`~/.openbot/desktop/`)。主要文件:
|
|
299
285
|
|
|
300
286
|
- **config.json**:全局缺省 provider/model、**defaultModelItemCode**(缺省模型在 configuredModels 中的唯一标识)、缺省智能体 id(`defaultAgentId`)、各 provider 的 API Key/baseUrl、已配置模型列表(configuredModels)等。
|
|
301
|
-
- **agents.json**:智能体列表;每个智能体可配置 provider、model、**modelItemCode**(匹配 configuredModels)、工作区。**执行方式**可为 **local** / **coze** / **openclawx**。Coze 代理:`
|
|
287
|
+
- **agents.json**:智能体列表;每个智能体可配置 provider、model、**modelItemCode**(匹配 configuredModels)、工作区。**执行方式**可为 **local** / **coze** / **openclawx** / **opencode** / **claude_code**。Coze 代理:`runnerType: "coze"`,并配置 **region**(`cn` 国内 / `com` 国际)、**coze.cn** / **coze.com**(各含 botId、apiKey)。OpenClawX 代理:`runnerType: "openclawx"`,配置 **openclawx.baseUrl**、**openclawx.apiKey**(可选)。OpenCode 代理:`runnerType: "opencode"`,配置 **opencode**(mode、port、model、workingDirectory 等)。Claude Code 代理:`runnerType: "claude_code"`,可选 **claudeCode.workingDirectory**(默认使用工作区路径)。
|
|
302
288
|
- **provider-support.json**:Provider 与模型目录,供设置页下拉选择。
|
|
303
289
|
|
|
304
290
|
| 操作 | 命令 | 说明 |
|
|
@@ -334,6 +320,10 @@ openbot "总结一下当前有哪些技能"
|
|
|
334
320
|
|
|
335
321
|
通过 **WebSocket 网关** 使用 OpenBot:先启动网关,再通过 Web 客户端连接。
|
|
336
322
|
|
|
323
|
+
**配置与访问地址**:可使用 **`http://localhost:38080`**(本机)或 **`http://你的IP:38080`**(局域网/远程)进行配置与使用;WebSocket 为 `ws://` 同 host/端口,HTTP 接口(如 `/server-api`、`/health`)与静态资源均通过上述地址访问。
|
|
324
|
+
|
|
325
|
+
### 通过 npm 启动网关
|
|
326
|
+
|
|
337
327
|
```bash
|
|
338
328
|
# 启动网关(默认端口 38080)
|
|
339
329
|
openclawx gateway --port 38080
|
|
@@ -341,7 +331,11 @@ openclawx gateway --port 38080
|
|
|
341
331
|
|
|
342
332
|
若需网关开机/登录自启,可执行 `openbot service install`(支持 Linux / macOS / Windows);移除自启用 `openbot service uninstall`,停止当前网关用 `openbot service stop`。
|
|
343
333
|
|
|
344
|
-
|
|
334
|
+
### 通过 Docker 启动后使用 Web 浏览器
|
|
335
|
+
|
|
336
|
+
若通过 **Docker** 方式启动(见上方「1.2 Docker 部署」),同样可通过 Web 浏览器进行配置与对话:在浏览器中打开 **`http://localhost:38080`** 或 **`http://宿主机IP:38080`**,即可进行智能体、模型、通道等配置及对话,使用方式与 npm 启动网关一致。WebSocket 客户端连接 `ws://localhost:38080` 或 `ws://宿主机IP:38080`,使用 JSON-RPC 调用 `connect`、`agent.chat`、`agent.cancel` 等。
|
|
337
|
+
|
|
338
|
+
客户端连接 `ws://localhost:38080`(或 `ws://你的IP:38080`),使用 JSON-RPC 调用 `connect`、`agent.chat`、`agent.cancel` 等(详见下方「Gateway API 简述」)。
|
|
345
339
|
前端可自行实现或使用仓库内 Web 示例(若有)。
|
|
346
340
|
|
|
347
341
|
---
|
|
@@ -366,6 +360,7 @@ openclawx gateway --port 38080
|
|
|
366
360
|
| **飞书** | WebSocket 事件订阅(im.message.receive_v1) | 开放 API + 流式卡片更新 | `channel:feishu:<chat_id>` |
|
|
367
361
|
| **钉钉** | dingtalk-stream SDK(Stream 模式) | sessionWebhook POST | `channel:dingtalk:<conversationId>` |
|
|
368
362
|
| **Telegram** | 长轮询 getUpdates | sendMessage / editMessageText 流式更新 | `channel:telegram:<chat_id>` |
|
|
363
|
+
| **微信** | Wechaty(Web/UOS 协议)扫码登录 | say 一次性发送(不支持流式) | `channel:wechat:<thread_id>` |
|
|
369
364
|
|
|
370
365
|
### 飞书
|
|
371
366
|
|
|
@@ -392,20 +387,31 @@ openclawx gateway --port 38080
|
|
|
392
387
|
|
|
393
388
|
**配置**:enabled、botToken、defaultAgentId。**用法**:通过 [@BotFather](https://t.me/BotFather) 获取 Bot Token;OpenClawX **设置 → 通道** 启用 Telegram 并填写 Bot Token → 保存后**重启 Gateway**。在 Telegram 内与机器人对话即可。也可编辑 `config.json` 中 `channels.telegram`。
|
|
394
389
|
|
|
390
|
+
### 微信
|
|
391
|
+
|
|
392
|
+
**说明**:微信通道基于 **Wechaty**(Web/UOS 协议),通过扫码登录个人微信账号接收与发送消息。不支持流式(微信无法编辑已发消息),回复在 agent_end 后一次性发送。支持单聊、群聊。
|
|
393
|
+
|
|
394
|
+
- **会话与 Agent**:同一微信会话(单聊为联系人 id、群聊为群 id)对应一个 Agent Session(`channel:wechat:<thread_id>`),由通道配置中的 `defaultAgentId` 指定智能体。
|
|
395
|
+
- **使用方式**:OpenClawX **设置 → 通道** 勾选「启用微信」,可选填写 **puppet**(如 `wechaty-puppet-wechat4u`,不填则使用 Wechaty 默认);保存后**重启 Gateway**。启动后在设置页或通过 `/server-api/wechat/qrcode` 获取二维码,使用**微信扫码登录**。登录成功后即可在微信内与机器人对话。对话中同样支持 **`//` 指令** 查询与切换智能体。
|
|
396
|
+
- **账号说明**:微信对第三方协议有风控限制,**注册较早、使用时间较长的微信号** 相对更容易登录成功;新注册或存在风控的账号可能无法登录或易被限制,建议优先使用老号尝试。
|
|
397
|
+
|
|
398
|
+
**配置**:enabled、puppet、defaultAgentId。也可直接编辑 `~/.openbot/desktop/config.json` 中 `channels.wechat`。
|
|
399
|
+
|
|
395
400
|
未配置或未启用某通道时,Gateway 会跳过该通道启动;若已启用但必填项为空,控制台会提示到「设置 → 通道」检查。
|
|
396
401
|
|
|
397
402
|
### 2.4.1 代理模式与多节点协作
|
|
398
403
|
|
|
399
|
-
智能体除在本机运行(**local**)外,可配置为**代理模式**,将对话转发至 Coze 或另一台 OpenClawX
|
|
404
|
+
智能体除在本机运行(**local**)外,可配置为**代理模式**,将对话转发至 Coze、OpenCode、Claude Code 或另一台 OpenClawX,实现生态接入与多节点协作。**代理智能体为本机 0 Token 消耗模式**:推理与消息处理均在对方平台完成,本机仅做转发与展示,不占用本机模型 API 的 Token。特别适合 **Coze**、**OpenCode**、**Claude Code** 等具备大量消息、长上下文或代码协作能力的平台,在桌面端与通道中直接使用其能力而无需消耗本机配额。
|
|
400
405
|
|
|
401
406
|
| 模式 | 说明 | 配置要点 |
|
|
402
407
|
|------|------|----------|
|
|
403
408
|
| **local** | 本机执行,使用当前模型的 pi-coding-agent 与 Skills | 默认;无需额外配置 |
|
|
404
|
-
| **coze** | 代理至 Coze 平台 | 在桌面端「智能体 → 编辑 → 执行方式」选 Coze;**站点**选国内(cn)或国际(com);分别填写该站点的 **Bot ID**、**Access Token**(PAT / OAuth 2.0 / JWT 等)。`agents.json` 中对应智能体为 `"
|
|
405
|
-
| **openclawx** | 代理至其他 OpenClawX 实例(多节点) | 执行方式选 OpenClawX;填写目标实例 **baseUrl**(如 `http://另一台机器:38080`)、可选 **API Key**。`agents.json` 中为 `"
|
|
409
|
+
| **coze** | 代理至 Coze 平台 | 在桌面端「智能体 → 编辑 → 执行方式」选 Coze;**站点**选国内(cn)或国际(com);分别填写该站点的 **Bot ID**、**Access Token**(PAT / OAuth 2.0 / JWT 等)。`agents.json` 中对应智能体为 `"runnerType": "coze"`,并含 `coze.region`、`coze.cn` / `coze.com`(botId、apiKey) |
|
|
410
|
+
| **openclawx** | 代理至其他 OpenClawX 实例(多节点) | 执行方式选 OpenClawX;填写目标实例 **baseUrl**(如 `http://另一台机器:38080`)、可选 **API Key**。`agents.json` 中为 `"runnerType": "openclawx"`,含 `openclawx.baseUrl`、`openclawx.apiKey`(可选) |
|
|
406
411
|
| **opencode** | 代理至 OpenCode 官方 Server | 执行方式选 OpenCode;本地模式需先在本机运行 `opencode serve`(默认 4096 端口),填写端口;远程模式填写地址与端口。可选密码、工作目录、默认模型。支持 `/init`、`/undo`、`/redo`、`/share`、`/help` 等斜杠指令,分享链接会回显到对话中 |
|
|
412
|
+
| **claude_code** | 代理至本机 Claude Code CLI | 执行方式选 Claude Code;需本机已安装 `claude` 命令(如 `npm install -g @anthropic-ai/claude-code` 并执行 `claude login`)。可选配置**工作目录**(默认使用智能体工作区 `~/.openbot/workspace/<workspace>/`)。`agents.json` 中为 `"runnerType": "claude_code"`,可选 `claudeCode.workingDirectory` |
|
|
407
413
|
|
|
408
|
-
- **入口**:桌面端「设置」→「智能体」中新建/编辑智能体时可选择执行方式;通道使用的默认智能体也可设为 Coze 或
|
|
414
|
+
- **入口**:桌面端「设置」→「智能体」中新建/编辑智能体时可选择执行方式;通道使用的默认智能体也可设为 Coze、OpenClawX、OpenCode 或 Claude Code 代理。
|
|
409
415
|
- **多节点**:多台机器各跑一个 OpenClawX Gateway,将部分智能体指向对方 baseUrl,即可实现分工、专机专用或负载均衡。
|
|
410
416
|
|
|
411
417
|
---
|
|
@@ -419,6 +425,7 @@ openclawx gateway --port 38080
|
|
|
419
425
|
| **飞书** | 已支持,见上文「2.4 通道支持」。 |
|
|
420
426
|
| **钉钉** | 已支持,见上文「2.4 通道支持」。 |
|
|
421
427
|
| **Telegram** | 已支持,见上文「2.4 通道支持」。 |
|
|
428
|
+
| **微信** | 已支持,见上文「2.4 通道支持」(Wechaty 扫码登录;注册较早的微信号相对更易成功)。 |
|
|
422
429
|
| **iOS** | 规划中 |
|
|
423
430
|
| **Android** | 规划中 |
|
|
424
431
|
|
|
@@ -433,6 +440,7 @@ openclawx gateway --port 38080
|
|
|
433
440
|
| **Coze 生态** | **已支持**:智能体执行方式可选 coze,按站点(国内 cn / 国际 com)配置 Bot ID 与 Access Token,桌面端与通道均可使用 |
|
|
434
441
|
| **OpenClawX 多节点** | **已支持**:执行方式可选 openclawx,通过 baseUrl(及可选 apiKey)将对话代理到另一 OpenClawX 实例,实现多节点协作与负载分工 |
|
|
435
442
|
| **OpenCode 代理** | **已支持**:执行方式可选 opencode,对接 OpenCode 官方 Server(本地 `opencode serve` 或远程);流式回复、`/init`/`/undo`/`/redo`/`/share`/`/help` 等指令,分享链接回显;失败时展示「执行失败」提示 |
|
|
443
|
+
| **Claude Code 代理** | **已支持**:执行方式可选 claude_code,对接本机 Claude Code CLI(需已安装 `claude` 并登录);可选工作目录,默认使用智能体工作区路径 |
|
|
436
444
|
|
|
437
445
|
文档与发布节奏后续更新。
|
|
438
446
|
|