@aiyiran/myclaw 1.0.47 → 1.0.48

package/README.md

@@ -1,126 +1,234 @@
-# MyClaw - 学生友好的 OpenClaw 工具
+# MyClaw CLI
 
-一个简化 OpenClaw 日常操作的命令行工具，专为教学环境设计。
+为 OpenClaw 教学环境设计的一站式命令行工具。
 
-## 跨平台要求 ⚠️
+```bash
+npm install -g @aiyiran/myclaw
+```
+
+---
+
+## 命令速查
+
+| 命令 | 说明 | 平台 |
+|------|------|------|
+| `myclaw prepare` | 🚀 一键初始化（推荐第一次用） | 全平台 |
+| `myclaw open` | 打开浏览器（自动带 Token） | 全平台 |
+| `myclaw patch` | 注入 UI 扩展（语音输入等） | Mac/Linux |
+| `myclaw unpatch` | 移除 UI 扩展 | Mac/Linux |
+| `myclaw install` | 安装 OpenClaw | 全平台 |
+| `myclaw status` | 查看 Gateway / Agent 状态 | 全平台 |
+| `myclaw new <name>` | 创建新 Agent | 全平台 |
+| `myclaw restart` | 重启 Gateway | 全平台 |
+| `myclaw bat` | 生成 Windows 桌面快捷启动器 | Windows |
+| `myclaw wsl2` | WSL2 安装向导 | Windows |
+| `myclaw weixin` | 微信绑定向导 | 全平台 |
+| `myclaw rebind` | 微信重绑向导 | 全平台 |
+| `myclaw help` | 显示帮助 | 全平台 |
+
+---
+
+## 核心流程
+
+### `myclaw prepare` — 初始化链条
+
+自动检测环境并按需执行安装、配置、注入：
 
 ```
-╔══════════════════════════════════════════════════════════════════════╗
-║                       跨平台兼容性说明                               ║
-╠══════════════════════════════════════════════════════════════════════╣
-║                                                                      ║
-║  支持系统:                                                           ║
-║    ✅ macOS      - 完全支持，包括颜色和 Emoji                         ║
-║    ✅ Linux      - 完全支持，包括颜色和 Emoji                         ║
-║    ✅ Windows 10/11 - 基本支持，推荐使用 Windows Terminal            ║
-║    ⚠️ Windows 7/8 - 支持，但 Emoji 可能显示为方块                    ║
-║                                                                      ║
-║  Windows 用户建议:                                                   ║
-║    • 安装 Windows Terminal (Microsoft Store 免费下载)                ║
-║    • 或使用 PowerShell 7+ (https://aka.ms/powershell)               ║
-║                                                                      ║
-║  颜色说明:                                                           ║
-║    • macOS/Linux: 正常显示 ANSI 颜色                                ║
-║    • Windows: 自动禁用颜色输出，避免乱码                             ║
-║                                                                      ║
-╚══════════════════════════════════════════════════════════════════════╝
+Step 1: 检测环境 (Mac / Windows / Linux / WSL)
+Step 2: 检测 Chrome 浏览器
+Step 3: 检测 OpenClaw → 未装则安装
+Step 4: 执行 Patch（受 AUTO_PATCH 开关控制）
+Step 5: [Windows] 生成桌面快捷启动器
 ```
 
-## 安装
+**触发方式：**
+- 手动运行 `myclaw prepare`
+- `npm install -g @aiyiran/myclaw` 时通过 `postinstall` 自动触发
 
-```bash
-# 方式一: 直接运行
-node myclaw/index.js <command>
+**postinstall 模式（无交互）：**
+- OpenClaw 已装 → 自动 patch
+- OpenClaw 未装 → 跳过，提示手动安装
+- 不会弹出 y/n 询问
 
-# 方式二: 添加到 PATH (macOS/Linux)
-ln -s /path/to/myclaw/index.js /usr/local/bin/myclaw
-chmod +x /usr/local/bin/myclaw
+---
 
-# 方式三: Windows PowerShell
-# 将 myclaw/index.js 路径添加到系统 PATH
+### `myclaw bat` — Windows 桌面启动器
+
+生成一个 `.bat` 启动脚本 + 桌面快捷方式，双击即可智能启动。
+
+**快捷方式命名规则：**
+```
+版本号_OpenClaw_MM-DD_HH-MM-SS.lnk
+例: 1.0.46_OpenClaw_04-01_00-36-19.lnk
 ```
 
-## 使用方法
+> 通过桌面图标名称可验证 prepare 是否执行过，以及执行的版本和时间。
+
+**双击后的完整流程：**
 
-### 查看状态
-```bash
-myclaw status
 ```
-简化版的 OpenClaw 状态面板，一眼看清 Gateway、Agents、Sessions 状态。
+Gateway 未运行:
+  [1/5] WSL              → 检测/安装 WSL2
+  [2/5] OpenClaw Linux   → 检测/导入 WSL 发行版
+  [3/5] Gateway          → 未运行 → 更新 myclaw
+  [4/5] Patch            → 注入 UI 扩展
+  [5/5] Browser          → myclaw open（带 Token）
+        → 启动 openclaw gateway（保持窗口）
+
+Gateway 已运行:
+  [1/4] WSL
+  [2/4] OpenClaw Linux
+  [3/4] Gateway          → 已运行
+  [4/4] Browser          → myclaw open（带 Token）
+        → 进入 WSL 终端（cd /root/.openclaw）
+```
+
+---
+
+### `myclaw patch` — UI 扩展注入
+
+向 OpenClaw 的 control-ui 注入自定义功能：
+- `myclaw-inject.js` — 自定义 UI 逻辑
+- `voice-input.js` — 语音输入 SDK
+
+**原理：** 修改 `control-ui/index.html`，在 `</body>` 前插入 `<script>` 标签。
 
-### 创建新 Agent
 ```bash
-myclaw new <agent名称>
+myclaw patch     # 注入
+myclaw unpatch   # 还原
 ```
-快速创建一个新的 OpenClaw Agent，自动完成：
-- 创建 workspace 目录
-- 配置 agent 文件
-- 发送出生消息
 
-示例：
-```bash
-myclaw new helper      # 创建名为 helper 的 Agent
-myclaw new testbot     # 创建名为 testbot 的 Agent
+> 注意：每次 OpenClaw 更新后需要重新 patch（index.html 会被覆盖）。
+
+---
+
+### `myclaw open` — 打开浏览器
+
+自动检测 Chrome 路径，拼接 Token 打开：
+
+```
+http://127.0.0.1:18789?token=aiyiran
 ```
 
-### 安装 OpenClaw
-```bash
-myclaw install
+支持的 Chrome 路径：
+- **Mac:** `/Applications/Google Chrome.app`
+- **Windows:** `C:\Program Files\Google\Chrome\Application\chrome.exe`
+- **Linux:** `google-chrome` / `chromium-browser`
+
+---
+
+### `myclaw wsl2` — WSL2 安装向导
+
+Windows 专用，分两阶段：
+
+| 阶段 | 内容 |
+|------|------|
+| Phase 1 | 启用 WSL 功能 + 安装 WSL2（需要重启） |
+| Phase 2 | 下载并导入 OpenClaw rootfs.tar |
+
+已安装时会提示：
+```
+是否要重新安装 Linux 环境? (y/N):
 ```
-自动检测操作系统并执行对应的安装命令。
 
-### 帮助
-```bash
-myclaw help
+---
+
+## 配置文件
+
+### `config.js`
+
+```js
+module.exports = {
+  TOKEN: 'aiyiran',                      // Gateway 认证 Token
+  DEFAULT_URL: 'http://127.0.0.1:18789', // 默认地址
+  AUTO_PATCH: true,                      // prepare 时是否自动 patch
+};
 ```
 
+| 配置项 | 说明 |
+|--------|------|
+| `TOKEN` | 所有 open 命令和 bat 启动器使用的认证令牌 |
+| `DEFAULT_URL` | Gateway 地址 |
+| `AUTO_PATCH` | `true` = prepare/postinstall 自动 patch；`false` = 跳过 |
+
+---
+
 ## 文件结构
 
 ```
 myclaw/
-├── index.js          # 主入口，命令解析和输出
-├── create_agent.js   # Agent 创建逻辑模块
-└── README.md         # 本文件
+├── index.js              # CLI 主入口 + 命令路由 + bat 模板
+├── config.js             # 全局配置（Token、URL、开关）
+├── prepare.js            # 初始化链条
+├── patch.js              # UI 扩展注入逻辑
+├── wsl2.js               # WSL2 安装向导
+├── create_agent.js       # Agent 创建
+├── package.json          # npm 包配置（含 postinstall）
+├── publish.sh            # 一键发布脚本
+├── assets/
+│   ├── myclaw-inject.js  # 注入到 control-ui 的 JS
+│   └── detect-browser.sh # Chrome 检测脚本
+├── voice-input/
+│   ├── index.html        # 语音输入独立页
+│   └── voice-input.js    # 语音 SDK
+└── wizards/              # 交互式向导系统
+    ├── index.js           # 向导入口
+    ├── runner/            # 向导运行引擎
+    ├── configs/           # 向导配置文件
+    ├── scripts/           # Python 后端脚本
+    └── commons/           # 共享步骤定义
 ```
 
-### 模块说明
+---
 
-| 文件 | 职责 |
-|------|------|
-| `index.js` | 主入口，解析命令、颜色输出、调用模块 |
-| `create_agent.js` | Agent 创建的完整逻辑，可独立使用 |
+## 调试
+
+### 查看 prepare 执行日志
 
-## 开发说明
+prepare 运行时会写入日志文件：
+- **Mac/Linux:** `/tmp/myclaw-prepare.log`
+- **Windows WSL:** `/tmp/myclaw-prepare.log`
+
+```bash
+cat /tmp/myclaw-prepare.log
+```
 
-### 代码规范
+示例输出：
+```
+[2026-04-01T00:30:00.000Z] === prepare start (postinstall=true, version=1.0.46)
+[2026-04-01T00:30:00.100Z] Step 1: env=linux
+[2026-04-01T00:30:00.200Z] Step 2: chrome=true
+[2026-04-01T00:30:00.300Z] Step 3: openclaw=installed
+[2026-04-01T00:30:00.400Z] Step 4: AUTO_PATCH=true, env=linux
+[2026-04-01T00:30:01.000Z] Step 4: patch executed
+[2026-04-01T00:30:01.100Z] === prepare end (success)
+```
 
-1. **跨平台兼容性** - 必须考虑 Windows 用户体验
-   - 使用 `os.platform()` 检测系统
-   - Windows 下禁用 ANSI 颜色输出
-   - 避免使用只在 Unix 系统有效的命令
+### npm 缓存问题
 
-2. **错误处理**
-   - 所有 `execSync` 调用必须使用 `try-catch`
-   - 失败时提供清晰的错误信息和解决方案
+如果 `npm install -g @aiyiran/myclaw` 拿到旧版本：
 
-3. **模块化**
-   - 业务逻辑放入独立模块
-   - 主入口只做命令解析和输出
+```bash
+# 方案 1: 强制最新
+npm install -g @aiyiran/myclaw@latest --prefer-online
 
-### 测试清单
+# 方案 2: 清缓存
+npm cache clean --force
+npm install -g @aiyiran/myclaw
 
-发布前请在以下环境测试：
-- [ ] macOS (Terminal)
-- [ ] Linux (bash)
-- [ ] Windows 10/11 (PowerShell)
-- [ ] Windows 10/11 (CMD)
-- [ ] Windows Terminal (如果可用)
+# 方案 3: 先 view 刷新元数据
+npm view @aiyiran/myclaw version
+npm install -g @aiyiran/myclaw
+```
 
-## 依赖
+---
 
-- Node.js 14+
-- OpenClaw CLI (用于实际命令执行)
+## 发布
 
-## 许可证
+```bash
+cd myclaw
+sh publish.sh
+```
 
-内部教学工具
+自动完成：git commit → 版本号 +1 → git push + tag → npm publish

package/index.js

@@ -404,7 +404,7 @@ pause
   // 写入 bat 文件（Windows CMD 需要 CRLF 换行符）
   fs.writeFileSync(batPath, batContent.replace(/\n/g, '\r\n'), 'utf8');
 
-  // 用 PowerShell 创建带图标的桌面快捷方式
+  // 用 PowerShell 创建带图标的桌面快捷方式 + 刷新桌面
   const psScript = `
 $ws = New-Object -ComObject WScript.Shell
 $sc = $ws.CreateShortcut('${lnkPath.replace(/\\/g, '\\\\')}')
@@ -412,8 +412,10 @@ $sc.TargetPath = '${batPath.replace(/\\/g, '\\\\')}'
 $sc.WorkingDirectory = '${myClawDir.replace(/\\/g, '\\\\')}'
 $sc.WindowStyle = 1
 $sc.IconLocation = '%SystemRoot%\\System32\\shell32.dll,176'
-$sc.Description = 'OpenClaw 智能启动器'
+$sc.Description = 'OpenClaw'
 $sc.Save()
+Add-Type -TypeDefinition 'using System; using System.Runtime.InteropServices; public class Shell { [DllImport("shell32.dll")] public static extern void SHChangeNotify(int e, int f, IntPtr i1, IntPtr i2); }' -ErrorAction SilentlyContinue
+[Shell]::SHChangeNotify(0x08000000, 0, [IntPtr]::Zero, [IntPtr]::Zero)
 `;
 
   try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiyiran/myclaw",
-  "version": "1.0.47",
+  "version": "1.0.48",
   "description": "",
   "main": "index.js",
   "bin": {