# @aiyiran/myclaw 中文文档

规范地址：https://npmcn.com/package/%40aiyiran/myclaw/

版本：1\.1\.210
npm 元数据更新时间：2026-11-07T02:36:45.559Z
中文译文更新时间：2026-11-06T22:01:55.143Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：3.3 MB，173 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2026-03-29T17:48:52.701Z
- 最新版本发布：2026-11-07T02:36:45.398Z
- 近 30 天下载量：2288（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：424（近 12 个月 424 个）

## 中文简介

为 OpenClaw 教学环境设计的一站式命令行工具。

## 安装

```sh
npm install @aiyiran/myclaw
```

也可以使用：`pnpm add @aiyiran/myclaw`、`yarn add @aiyiran/myclaw`、`bun add @aiyiran/myclaw`

## README

# MyClaw CLI

为 OpenClaw 教学环境设计的一站式命令行工具。

```bash
npm install -g @aiyiran/myclaw
```

* * *

## 命令速查

| 命令 | 说明 | 平台 |
| --- | --- | --- |
| `myclaw prepare` | 🚀 一键初始化（推荐第一次用） | 全平台 |
| `myclaw open` | 打开浏览器（自动带 Token） | 全平台 |
| `myclaw update` `up` | 自动升级 MyClaw 到最新版（无缓存） | 全平台 |
| `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` — 初始化链条

自动检测环境并按需执行安装、配置、注入：

```
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` 自动触发

**postinstall 模式（无交互）：**

-   OpenClaw 已装 → 自动 patch
-   OpenClaw 未装 → 跳过，提示手动安装
-   不会弹出 y/n 询问

* * *

### `myclaw bat` — Windows 桌面启动器

生成一个 `.bat` 启动脚本 + 桌面快捷方式，双击即可智能启动。

**快捷方式命名规则：**

```
版本号_OpenClaw_MM-DD_HH-MM-SS.lnk
例: 1.0.46_OpenClaw_04-01_00-36-19.lnk
```

> 通过桌面图标名称可验证 prepare 是否执行过，以及执行的版本和时间。

**双击后的完整流程：**

```
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>` 标签。

```bash
myclaw patch     # 注入
myclaw unpatch   # 还原
```

> 注意：每次 OpenClaw 更新后需要重新 patch（index.html 会被覆盖）。

* * *

### `myclaw open` — 打开浏览器

自动检测 Chrome 路径，拼接 Token 打开：

```
http://127.0.0.1:18789?token=aiyiran
```

支持的 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):
```

* * *

## 配置文件

### `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              # 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/           # 共享步骤定义
```

* * *

## 调试

### 查看 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)
```

### npm 缓存问题

如果 `npm install -g @aiyiran/myclaw` 拿到旧版本：

```bash
# 方案 1: 强制最新
npm install -g @aiyiran/myclaw@latest --prefer-online

# 方案 2: 清缓存
npm cache clean --force
npm install -g @aiyiran/myclaw

# 方案 3: 先 view 刷新元数据
npm view @aiyiran/myclaw version
npm install -g @aiyiran/myclaw
```

* * *

## 发布

```bash
cd myclaw
sh publish.sh
```

自动完成：git commit → 版本号 +1 → git push + tag → npm publish

## 常见问题

### @aiyiran/myclaw 是什么？

为 OpenClaw 教学环境设计的一站式命令行工具。

### 如何安装 @aiyiran/myclaw？

在项目目录运行 npm install @aiyiran/myclaw，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 mc、myclaw，可以用 npx mc 直接运行。

### @aiyiran/myclaw 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/aiyiran\_\_myclaw 是否存在。

### @aiyiran/myclaw 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @aiyiran/myclaw 可以商用吗？

@aiyiran/myclaw 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aiyiran/myclaw 的下载量有多少？

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

### @aiyiran/myclaw 还在维护吗？

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