@next-open-ai/openbot 0.2.1 → 0.3.2

package/README.md

@@ -36,7 +36,7 @@
          ▼                        ▼                             ▼
 ┌─────────────────────────────────────────────────────────────────────────────┐
 │                            Gateway Server (Node)                             │
-│  • 静态资源 • 自动发现端口 • 子进程拉起 Desktop Server                        │
+│  • 内嵌 Nest（/server-api）• 按 path 分流 • 静态资源 • 自动发现端口             │
 └────────────────────────────────────┬────────────────────────────────────────┘
                                       │
          ┌────────────────────────────┼────────────────────────────┐
@@ -55,21 +55,55 @@
 └─────────────────────────────────────────────────────────────────────────────┘
 ```
 
-- **CLI**：直接调用 Agent 核心，单次提示或批量脚本。
-- **WebSocket Gateway**（`src/gateway/`）：对外提供 WebSocket（JSON-RPC），供 Web/移动端连接；负责起端口、拉 Nest 后端子进程、代理 `/server-api` 请求。**与「Desktop 后端」是不同进程。**
-- **Desktop 后端**（`src/server/`）：NestJS HTTP API，即 **server-api**；默认端口 38081。会话、智能体配置、技能、任务、工作区、鉴权等由本模块提供。
+- **CLI**：直接调用 Agent 核心，单次提示或批量脚本；可启动 Gateway（`openbot gateway`）及配置开机自启（`openbot service install/uninstall`）。
+- **WebSocket Gateway**（`src/gateway/`）：单进程内嵌 Nest，对外提供 WebSocket（JSON-RPC）与 HTTP；按 path 分流：`/server-api` 走 Nest、`/ws` 为 Agent 对话、`/ws/voice`/`/sse`/`/channel` 为扩展占位，其余为静态资源。供 Web/移动端连接；支持以开机/登录自启方式常驻（Linux cron、macOS LaunchAgent、Windows 计划任务）。
+- **Desktop 后端**（`src/server/`）：NestJS HTTP API，即 **server-api**；可被 Gateway 内嵌或独立监听（默认端口 38081）。会话、智能体配置、技能、任务、工作区、鉴权等由本模块提供。
 - **Desktop**：Electron 包一层 Vue 前端 + 上述后端；通过 Gateway 或直连 Desktop 后端与 Agent 通信。
 - **Agent 核心**：统一由 `AgentManager` 管理会话、技能注入与工具注册；记忆与 compaction 作为扩展参与 system prompt 与经验写入。
 
+### 项目目录结构
+
+```
+openbot/
+├── src/                    # 源码（构建输出 dist/）
+│   ├── core/               # 公共核心，CLI 与 Gateway 共用
+│   │   ├── agent/          # AgentManager、run、技能与配置
+│   │   ├── config/         # 桌面配置（~/.openbot/desktop）
+│   │   ├── memory/         # 向量存储、嵌入、compaction
+│   │   ├── installer/      # 技能安装
+│   │   └── tools/          # 内置工具（browser、install-skill、save-experience 等）
+│   ├── cli/                # CLI 入口与 service 子命令
+│   │   ├── cli.ts          # 主入口，构建为 dist/cli/cli.js
+│   │   └── service.ts      # 开机自启 install/uninstall/stop
+│   ├── gateway/            # WebSocket 网关（内嵌 Nest、path 分流）
+│   ├── server/             # Desktop 后端（NestJS）
+│   ├── cli.ts              # 兼容入口，仅转发到 cli/cli.js
+│   └── index.ts            # 包导出
+├── apps/
+│   ├── desktop/            # Electron + Vue 桌面端
+│   ├── web/                # 预留
+│   ├── mobile/             # 预留
+│   ├── miniprogram/        # 预留
+│   └── browser-extension/  # 预留
+├── deploy/                 # Docker、K8s 等部署
+├── test/                   # 单元与 e2e 测试
+├── examples/               # 示例（含 workspace、gateway-client）
+└── skills/                 # 内置技能（find-skills、agent-browser）
+```
+
 ### 目录与模块对应
 
 | 目录 | 说明 |
 |------|------|
-| `src/server/` | **Desktop 后端**（NestJS），HTTP API，前缀 `server-api`。 |
-| `src/gateway/` | **WebSocket 网关**，独立进程，提供 WS JSON-RPC 并代理到 Desktop 后端。 |
-| `src/agent/` | Agent 核心（CLI 与 Gateway 共用）。 |
-| `src/config/` | 桌面配置（~/.openbot/desktop）：config.json、agents.json、provider-support.json；CLI 与 Gateway 共用。 |
-| `examples/workspace/` | 示例工作区数据（仅示例/测试用）。真实工作区根目录为 `~/.openbot/workspace/`。 |
+| `src/core/` | **公共核心**：`agent/`（AgentManager、pi-coding-agent）、`config/`（桌面配置）、`memory/`、`installer/`、`tools/`；CLI 与 Gateway 共用。 |
+| `src/cli/` | **CLI**：`cli.ts` 主入口（构建为 `dist/cli/cli.js`），`service.ts` 提供开机自启（install/uninstall/stop）。 |
+| `src/gateway/` | **WebSocket 网关**：单进程内嵌 Nest，按 path 分流：`/server-api`、`/ws`、`/ws/voice`、`/sse`、`/channel`、`/health`、静态资源（`apps/desktop/renderer/dist`）。 |
+| `src/server/` | **Desktop 后端**（NestJS），HTTP API 前缀 `server-api`；可内嵌到 Gateway 或独立监听。 |
+| `apps/desktop/` | **桌面端**（Electron + Vue），前端构建产物由 Gateway 提供。 |
+| `deploy/` | Dockerfile、K8s 等部署配置。 |
+| `test/` | 单元与 e2e 测试（config、gateway、server、installer）。 |
+| `examples/` | 示例工作区、gateway 客户端等。真实工作区根目录为 `~/.openbot/workspace/`。 |
+| `skills/` | 内置技能（SKILL.md 规范）。 |
 
 ---
 
@@ -82,8 +116,9 @@
 | 运行时 | Node.js 20+ |
 | 语言 | TypeScript 5.7 |
 | 入口 | `openbot`（bin → `dist/cli/cli.js`） |
-| 框架 | Commander（子命令：`gateway`、`login`、`config`） |
-| 配置 | `~/.openbot/agent`（API Key、模型、技能等） |
+| 框架 | Commander（子命令：`gateway`、`login`、`config`、`service`） |
+| 配置 | `~/.openbot/agent`（API Key、模型、技能等）；`~/.openbot/desktop`（与桌面共用） |
+| 开机自启 | `openbot service install` / `uninstall`（Linux cron、macOS LaunchAgent、Windows 计划任务）；`openbot service stop` 停止当前 gateway |
 
 ### WebSocket Gateway
 
@@ -91,7 +126,8 @@
 |------|------|
 | 协议 | JSON-RPC over WebSocket（`ws`） |
 | 端口 | 默认 38080，可 `-p` 指定 |
-| 职责 | 连接管理、消息路由、静态资源、拉 Nest 子进程 |
+| 架构 | 单进程内嵌 Nest；按 path 分流：`/server-api`、`/ws`、`/ws/voice`、`/sse`、`/channel`、`/health`、静态资源 |
+| 职责 | 连接管理、消息路由、鉴权钩子、静态资源（Desktop 前端） |
 | 方法 | `connect`、`agent.chat`、`agent.cancel`、`subscribe_session`、`unsubscribe_session` 等 |
 
 ### Agent 核心
@@ -156,8 +192,29 @@
 
 适用于：使用 **CLI**，或在自有环境中运行 **Gateway（Web）**。
 
+### 前置环境准备
+
+需先安装 **Node.js 20+**（Node >=20）。任选一种方式安装即可：
+
+| 方式 | 说明 |
+|------|------|
+| **官网安装包** | 打开 [nodejs.org](https://nodejs.org/)，下载 LTS 并安装；安装后终端执行 `node -v` 应显示 v20.x 或更高。 |
+| **nvm（推荐）** | 多版本切换方便：`curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh \| bash`，重启终端后 `nvm install 20`、`nvm use 20`。 |
+| **macOS (Homebrew)** | `brew install node@20`，或 `brew install nvm` 再用 nvm 安装 20。 |
+| **Windows** | 使用 [nodejs.org](https://nodejs.org/) 安装包，或 `winget install OpenJS.NodeJS.LTS`。 |
+| **Linux** | 使用发行版包管理器（如 `apt install nodejs`）或 [nvm](https://github.com/nvm-sh/nvm) 安装。 |
+
+安装后请确认：
+
 ```bash
-# 全局安装（测试过node版本：20/22 24太新，有一些库要本地编译环境）
+node -v   # 应为 v20.x 或 v22.x
+npm -v    # 能正常输出版本号
+```
+
+### 安装命令
+
+```bash
+# 全局安装（测试过 node 版本：20/22；24 太新，部分库需本地编译环境）
 npm install -g @next-open-ai/openbot
 ```
 
@@ -194,7 +251,20 @@ npm link   # 或 npm install -g . 本地全局安装
 适用于：仅使用 **桌面端**，无需 Node 环境。
 
 - 从 [Releases](https://github.com/next-open-ai/openbot/releases) 下载对应平台的安装包（macOS / Windows）。
-- 安装后启动 OpenBot Desktop，按界面引导配置 API Key 与默认模型即可使用。
+- 安装后启动 OpenBot，按界面引导配置 API Key 与默认模型即可使用。
+
+**macOS 若提示「已损坏、无法打开」**：因安装包未做 Apple 公证，从浏览器下载后会被系统加上「隔离」属性，出现“已损坏”的误报。请用**终端**去掉隔离属性后即可正常打开（一次性操作）：
+
+1. 将下载的 `.dmg` 打开，把 `OpenBot.app` 拖到「应用程序」文件夹（或你想放的目录）。
+2. 打开「终端」（应用程序 → 实用工具 → 终端），执行（路径按你实际放置位置修改）：
+   ```bash
+   xattr -c /Applications/OpenBot.app
+   find /Applications/OpenBot.app -exec xattr -c {} \; 2>/dev/null
+   ```
+   若系统支持递归可简化为：`xattr -cr /Applications/OpenBot.app`
+3. 之后像普通应用一样打开 OpenBot 即可，无需再右键或重复操作。
+
+安装包由仓库通过 **Desktop 打包** 流程生成（见下方「三、开发 → 3.3 Desktop 开发 → Desktop 打包」）。
 
 首次使用建议在设置中配置默认 Provider/模型，或通过 CLI 执行 `openbot login <provider> <apiKey> [model]` / `openbot config set-model <provider> <modelId>`（与桌面端共用 `~/.openbot/desktop/` 配置）。
 
@@ -268,6 +338,8 @@ openbot "总结一下当前有哪些技能"
 openbot gateway --port 38080
 ```
 
+若需网关开机/登录自启，可执行 `openbot service install`（支持 Linux / macOS / Windows）；移除自启用 `openbot service uninstall`，停止当前网关用 `openbot service stop`。
+
 客户端连接 `ws://localhost:38080`，使用 JSON-RPC 调用 `connect`、`agent.chat`、`agent.cancel` 等（详见下方「Gateway API 简述」）。  
 前端可自行实现或使用仓库内 Web 示例（若有）。
 
@@ -326,8 +398,9 @@ npm run build
 ## 3.1 CLI 开发
 
 - 入口：`openbot` → bin → `dist/cli/cli.js`
-- 技术：Commander（子命令 `gateway`、`login`、`config`）、TypeScript 5.7
+- 技术：Commander（子命令 `gateway`、`login`、`config`、`service`）、TypeScript 5.7
 - 配置与数据：`~/.openbot/agent`、`~/.openbot/desktop`（与桌面共用）
+- Gateway 开机自启：`openbot service install` / `uninstall` / `stop`（见 `src/cli/service.ts`）
 
 修改 CLI 后重新构建并本地安装：
 
@@ -341,7 +414,7 @@ openbot --help
 
 ## 3.2 Web 开发（Gateway + 前端）
 
-- **Gateway**：`src/gateway/`，默认端口 38080，可 `-p` 指定；协议 JSON-RPC over WebSocket；职责包括连接管理、消息路由、静态资源、拉 Nest 子进程。
+- **Gateway**：`src/gateway/`，默认端口 38080，可 `-p` 指定；单进程内嵌 Nest，按 path 分流（`/server-api`、`/ws`、静态资源等）；协议 JSON-RPC over WebSocket；职责包括连接管理、消息路由、鉴权、静态资源。
 - **方法**：`connect`、`agent.chat`、`agent.cancel`、`subscribe_session`、`unsubscribe_session` 等。
 
 本地启动网关：
@@ -357,7 +430,7 @@ openbot gateway --port 38080
 
 ## 3.3 Desktop 开发
 
-- **后端**：NestJS（`src/server/`），前缀 `server-api`，默认端口 38081；Gateway 启动时会拉该子进程并代理 `/server-api`。
+- **后端**：NestJS（`src/server/`），前缀 `server-api`，默认端口 38081；Gateway 内嵌时直接挂载该 Express，无独立子进程。
 - **前端**：Electron 28 + Vue 3 + Pinia + Vite 5，位于 `apps/desktop/`。
 
 ```bash
@@ -371,6 +444,33 @@ npm run desktop:dev
 npm run desktop:install
 ```
 
+### Desktop 打包
+
+从源码构建可安装的桌面安装包（DMG/NSIS/AppImage），供发布或本地安装使用。
+
+**命令（在仓库根目录执行）：**
+
+```bash
+npm run desktop:pack
+```
+
+该命令会依次执行：
+
+1. **根目录构建**：`npm run build`，生成 `dist/`（含 Gateway、Server、Agent 等）。
+2. **桌面构建**：`cd apps/desktop && npm run build`，其中包含：
+   - **build:gateway**：若需则再次构建根目录 `dist`；
+   - **build:copy-gateway**：将根目录 `dist` 复制到 `apps/desktop/gateway-dist`，写入 `package.json`（`type: "module"` + 生产依赖），并执行 `npm install --production`，得到带 `node_modules` 的 gateway 运行时；
+   - **build:renderer**：Vite 构建前端到 `renderer/dist`；
+   - **electron-builder**：打包为各平台安装包，并将 `gateway-dist` 作为 **extraResources** 拷贝到应用内 `Contents/Resources/dist`（含 Gateway 代码与依赖），无需用户安装 Node 即可运行。
+
+**产出物：**
+
+- **macOS**：`apps/desktop/dist/` 下生成 `.dmg`、`.zip`（如 `OpenBot Desktop-0.1.1-arm64.dmg`）；
+- **Windows**：nsis 安装程序；
+- **Linux**：AppImage。
+
+安装包安装后，Gateway 与前端均内嵌在应用内，用户无需单独安装 Node.js。
+
 ---
 
 ## 测试