@workclaw/cli 1.0.1 → 1.0.16

package/README.md

@@ -1,119 +1,165 @@
-# WorkClaw CLI
-
-WorkClaw CLI 是一个用于初始化和配置 WorkClaw 插件的命令行工具。
-
-## 特性
-
-- 🚀 **快速初始化** - 一键安装 WorkClaw 插件
-- 🔐 **安全认证** - RSA 加密密码，保护用户隐私
-- 🌐 **多平台支持** - Windows, macOS, Linux
-- 📊 **详细日志** - 完整的请求/响应日志
-- 🎨 **友好界面** - 彩色输出和加载动画
-
-## 安装
-
-```bash
-npm install -g @workclaw/cli
-```
-
-## 快速开始
-
-### 交互式初始化
-
-```bash
-workclaw init
-```
-
-### 命令行参数
-
-```bash
-workclaw init --phone 13800138000 --user-pass mypassword
-```
-
-## 使用文档
-
-### 命令
-
-```bash
-# 初始化
-workclaw init [options]
-
-# 帮助
-workclaw --help
-```
-
-### 参数
-
-| 参数 | 必填 | 说明 |
-|------|------|------|
-| --phone | ✅ | 手机号码 |
-| --user-pass | ✅ | 用户密码 |
-| --scenario | ❌ | 安装场景 |
-| --env | ❌ | 环境 (test/prod) |
-| --base-url | ❌ | API 地址 |
-| --ws-url | ❌ | WebSocket 地址 |
-| --force | ❌ | 强制覆盖 |
-
-## 安装场景
-
-| 场景 | 说明 |
-|------|------|
-| windows-local | Windows 本地安装 |
-| mac-local | macOS 本地安装 |
-| linux-local | Linux 本地安装 |
-| linux-box | Linux Box 环境安装 |
-
-## 开发
-
-### 项目结构
-
-```
-packages/cli/
-├── src/
-│   ├── bin/              # CLI 入口
-│   ├── lib/              # 核心库和基类
-│   ├── init/             # 初始化命令
-│   │   └── installer/   # 安装器
-│   └── utils/            # 工具函数
-├── vite.config.ts
-└── README.md
-```
-
-### 构建
-
-```bash
-npm run build    # 构建
-```
-
-## 更新日志
-
-### v2.0.0 (2026-04-08)
-
-- ✨ 新增 phone + userPass 认证方式
-- 🔒 新增 RSA 密码加密
-- 📝 新增完整请求日志
-- 🎨 优化交互式提示和进度显示
-- 🌐 支持 NPM 安装插件
-- 🔧 统一错误码管理
-
-### v1.0.0
-
-- 🎉 初始版本
-- ✨ 支持 appKey + appSecret 认证
-- ✨ 支持多平台安装
-
-## 许可证
-
-MIT License
-
-## 联系方式
-
-- 项目主页: [GitHub]()
-- 问题反馈: [Issue Tracker]()
-
-## 致谢
-
-- [commander](https://github.com/tj/commander.js) - 命令行解析
-- [chalk](https://github.com/chalk/chalk) - 彩色输出
-- [ora](https://github.com/sindresorhus/ora) - 加载动画
-- [axios](https://github.com/axios/axios) - HTTP 客户端
+# WorkClaw CLI
+
+WorkClaw CLI 是一个用于初始化和配置 WorkClaw 插件的命令行工具。
+
+## 安装
+
+```bash
+# 使用 npm 安装
+npm install -g @workclaw/cli
+
+# 使用 npx 直接运行（无需安装）
+npx @workclaw/cli local
+```
+
+## 使用
+
+### 命令
+
+本 CLI 提供两个命令：
+
+| 命令 | 说明 |
+|------|------|
+| `workclaw local` | 本地账户安装（需要登录） |
+| `workclaw box` | 盒子设备安装（无需登录） |
+
+### 交互式初始化
+
+```bash
+# 本地安装（需要手机号密码）
+workclaw local
+# 或使用 npx
+npx @workclaw/cli local
+
+# 盒子安装（需要 AppKey 和 AppSecret）
+workclaw box
+# 或使用 npx
+npx @workclaw/cli box
+```
+
+### 命令行参数
+
+#### local 命令参数
+
+| 参数               | 缩写 | 说明             |
+| ---------------- | -- | -------------- |
+| --scenario       | -s | 安装场景           |
+| --env            | -e | 环境 (test/prod) |
+| --phone          | 无  | 手机号码           |
+| --user-pass      | 无  | 用户密码           |
+| --plugin-version | 无  | 插件版本号         |
+| --debug          | 无  | 调试模式           |
+
+#### box 命令参数
+
+| 参数               | 缩写 | 说明             |
+| ---------------- | -- | -------------- |
+| --scenario       | -s | 安装场景           |
+| --env            | -e | 环境 (test/prod) |
+| --app-key        | 无  | App Key         |
+| --app-secret     | 无  | App Secret      |
+| --plugin-version | 无  | 插件版本号         |
+| --debug          | 无  | 调试模式           |
+
+### 安装场景
+
+| 场景            | 说明           |
+| ------------- | ------------ |
+| windows-local | Windows 本地安装 |
+| mac-local     | macOS 本地安装   |
+| linux-local   | Linux 本地安装   |
+
+### 环境
+
+| 环境   | 说明   |
+| ---- | ---- |
+| test | 测试环境 |
+| prod | 正式环境 |
+
+## 示例
+
+### 本地安装
+
+#### 交互式安装（推荐新手使用）
+
+```bash
+# 全局安装后运行
+workclaw local
+
+# 或使用 npx 直接运行
+npx @workclaw/cli local
+```
+
+#### 仅指定手机号和密码
+
+```bash
+workclaw local --phone 13800138000 --user-pass your_password
+```
+
+#### 完整参数指定
+
+```bash
+workclaw local --scenario windows-local --env test --phone 13800138000 --user-pass your_password
+```
+
+#### 使用正式环境
+
+```bash
+workclaw local --env prod --phone 13800138000 --user-pass your_password
+```
+
+#### macOS 安装
+
+```bash
+workclaw local --scenario mac-local --phone 13800138000 --user-pass your_password
+```
+
+#### Linux 安装
+
+```bash
+workclaw local --scenario linux-local --phone 13800138000 --user-pass your_password
+```
+
+### 盒子安装
+
+盒子安装适用于不需要用户登录的场景，直接使用 AppKey 和 AppSecret 进行安装：
+
+```bash
+# 基本用法
+workclaw box --app-key your_app_key --app-secret your_app_secret
+
+# 指定环境
+workclaw box --app-key your_app_key --app-secret your_app_secret --env prod
+
+# 指定场景
+workclaw box --app-key your_app_key --app-secret your_app_secret --scenario linux-local
+```
+
+### 指定插件版本
+
+可以使用 `--plugin-version` 参数安装指定版本的插件（默认安装最新版）：
+
+```bash
+# 安装指定版本
+workclaw local --phone 13800138000 --user-pass your_password --plugin-version 1.0.0
+workclaw box --app-key your_app_key --app-secret your_app_secret --plugin-version 1.0.0
+```
+
+### 调试模式
+
+当安装失败时，可以使用 `--debug` 参数查看详细日志：
+
+```bash
+# 本地安装 + 调试模式
+workclaw local --phone 13800138000 --user-pass your_password --debug
+
+# 盒子安装 + 调试模式
+workclaw box --app-key your_app_key --app-secret your_app_secret --debug
+
+# 完整参数 + 调试模式
+workclaw local --scenario windows-local --env test --phone 13800138000 --user-pass your_password --debug
+```
+
+## 许可证
+
+MIT License