codewave-openclaw-installer 1.0.2 → 2.1.0

package/README.md

@@ -1,41 +1,114 @@
-# 🦀 网易智企寄居蟹 Skill 包 — 一键安装器
+# codewave-openclaw-installer
 
-一条命令完成网易智企寄居蟹智能客服的飞书部署。
+网易智企 CodeWave 低代码平台 OpenClaw 扩展安装器。
 
-## 功能
-
-- 🤖 **寄居蟹智能客服 Skill 安装** — 自动将智能客服 Skill 部署到 `~/.openclaw/skills/`
-- 🔗 **飞书机器人绑定** — 自动调用 `@larksuite/openclaw-lark` 安装飞书 OpenClaw 插件，扫码即可绑定机器人
-
-## 使用方法
-
-### 方式一：npx 直接运行（推荐）
+## 一键安装
 
 ```bash
 npx codewave-openclaw-installer
 ```
 
-### 方式二：全局安装后运行
+> 等同于运行 `codewave-install` 命令。
+
+## 安装内容
+
+### CLI 工具
+
+| 工具 | 包管理器 | 说明 |
+|------|---------|------|
+| `razel-py-cli` | pipx | Python CLI（验收文档、音视频转写等） |
+| `razel-cli` | npm | Node CLI（PoPo 文档、PoPo 机器人、腾讯会议等） |
+
+Python CLI 安装建议：
 
 ```bash
-npm install -g codewave-openclaw-installer
-codewave-install
+brew install pipx
+pipx ensurepath
+pipx install razel-py-cli
 ```
 
-## 安装过程
+### OpenClaw Skills（自动注册）
+
+安装后 Skills 作为 OpenClaw Extension 自动加载，无需手动复制：
+
+| Skill | 说明 |
+|-------|------|
+| acceptance-doc-entry | 项目验收文档生成 |
+| meeting-to-prd | 会议纪要增量聚合 PRD |
+| pmo-weekly-report | PMO 项目看板周报 |
+| popo-doc | PoPo 文档查询下载 |
+| popo-robot-api | PoPo 机器人 API |
+| smart-customer-service | 智能客服知识库 |
+| speed-to-text | 通用音视频转文字稿 |
+| tencent-meeting | 腾讯会议回放嗅探与下载 |
+| yidun-skill-sec | 代码包安全扫描（易盾） |
+
+### 渠道自动引导
+
+安装器会自动检测本机是否存在飞书/钉钉相关环境线索，并按官方入口继续安装和初始化：
+
+| 渠道 | 触发线索 | 自动执行 |
+|------|----------|----------|
+| Feishu / Lark | `~/.openclaw/openclaw.json` 中已有 `channels.feishu`、飞书环境变量、已有 Feishu 扩展目录等 | `openclaw plugins install @openclaw/feishu`，然后调用 `openclaw onboard` |
+| DingTalk | `dws` 相关配置目录、`DWS_CLIENT_ID` / `DWS_CLIENT_SECRET` 环境变量、已安装 `dws` 命令等 | 通过 [官方安装脚本](https://github.com/DingTalk-Real-AI/dingtalk-workspace-cli?tab=readme-ov-file#installation) 安装，再调用 `dws auth login` |
 
-运行后会依次执行：
+说明：
 
-1. **安装寄居蟹智能客服 Skill** — 自动复制到 `~/.openclaw/skills/smart-customer-service/`
-2. **安装飞书插件** — 弹出二维码，用飞书扫码绑定机器人
+- 安装策略采用“先复用，再补装，最后才重装”
+- 如果用户机器上已经有旧的飞书入口、已有 Feishu 配置，或已经装过钉钉 `dws`，安装器会优先直接复用安装入口，但仍继续执行 `openclaw onboard` / `dws auth login`
+- 飞书和钉钉都按各自官方入口安装，不强行统一成 `npm install -g xxx`
+- 需要扫码或管理员授权时，安装器会直接进入对应初始化流程
+- 未检测到渠道线索时，不会强行安装该渠道能力
 
-安装完成后，即可在飞书中与机器人对话，体验寄居蟹智能客服。
+## 工作原理
 
-## 系统要求
+1. `preflight`：检测本机依赖、配置和渠道线索
+2. `core-install`：安装并初始化 `razel-py-cli` / `razel-cli`
+3. `channel-bootstrap`：检测到飞书或钉钉线索时，按官方入口自动安装并初始化
+4. `extension-install`：将本包安装到 `~/.openclaw/extensions/codewave-toolkit/`
+5. `postflight`：重启 OpenClaw Gateway，并运行统一检查输出最终状态
 
-- Node.js >= 16.7
-- npm >= 7
+## 目录结构
+
+```
+codewave-openclaw-installer/
+├── openclaw.plugin.json    # OpenClaw Extension 声明
+├── index.js                # Plugin 入口（空壳，仅声明 id）
+├── package.json
+├── bin/
+│   ├── install-lib.mjs     # 安装状态与渠道定义
+│   ├── install.mjs         # 安装脚本
+│   └── check.mjs           # 统一预检 / 结果校验
+├── skills/
+│   ├── acceptance-doc-entry/
+│   ├── meeting-to-prd/
+│   ├── pmo-weekly-report/
+│   ├── popo-doc/
+│   ├── popo-robot-api/
+│   ├── smart-customer-service/
+│   ├── speed-to-text/
+│   ├── tencent-meeting/
+│   └── yidun-skill-sec/
+├── tests/
+│   ├── check-json.test.mjs
+│   └── install-lib.test.mjs
+└── README.md
+```
+
+## 检查当前状态
+
+```bash
+codewave-check
+codewave-check --json
+```
+
+## 卸载
+
+```bash
+rm -rf ~/.openclaw/extensions/codewave-toolkit
+openclaw gateway restart
+```
 
-## 许可证
+## License
 
 MIT