@workclaw/cli 1.0.27 → 1.0.29

package/README.md

@@ -1,161 +1,119 @@
-# WorkClaw CLI
-
-WorkClaw CLI 是一个用于初始化和配置 WorkClaw 插件的命令行工具。
-
-## 安装
-
-```bash
-# 使用 npm 安装
-npm install -g @workclaw/cli
-
-# 使用 npx 直接运行（无需安装）
-npx @workclaw/cli local
-```
-
-## 使用
-
-### 命令
-
-本 CLI 提供两个命令：
-
-| 命令 | 说明 |
-|------|------|
-| `workclaw local` | 本地账户安装（需要登录） |
-| `workclaw box` | 盒子设备安装（无需登录，仅支持 Linux） |
-
-### 交互式初始化
-
-```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 命令参数
-
-| 参数               | 缩写 | 说明 |
-| ---------------- | -- | ---- |
-| --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 进行安装。**仅支持 Linux 环境**。
-
-```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
-```
-
-### 指定插件版本
-
-可以使用 `--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
+# 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 客户端

package/dist/bin/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/bin/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/bin/cli.ts"],"names":[],"mappings":""}

package/dist/box/error/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 错误码枚举
+ */
+export declare const ERROR_CODES: {
+    readonly APP_KEY_REQUIRED: "APP_KEY_REQUIRED";
+    readonly APP_SECRET_REQUIRED: "APP_SECRET_REQUIRED";
+    readonly NODE_VERSION_LOW: "NODE_VERSION_LOW";
+    readonly NODE_NOT_FOUND: "NODE_NOT_FOUND";
+    readonly NPM_NOT_FOUND: "NPM_NOT_FOUND";
+    readonly NPM_INSTALL_FAILED: "NPM_INSTALL_FAILED";
+    readonly CONFIG_WRITE_FAILED: "CONFIG_WRITE_FAILED";
+    readonly PLUGIN_EXTRACT_FAILED: "PLUGIN_EXTRACT_FAILED";
+};
+export type ErrorCode = keyof typeof ERROR_CODES;
+/**
+ * 中文错误提示
+ */
+export declare const ERROR_MESSAGES: Record<ErrorCode, string>;
+/**
+ * 应用错误类
+ */
+export declare class AppError extends Error {
+    code: ErrorCode;
+    constructor(code: ErrorCode, message: string);
+}
+/**
+ * 格式化错误信息
+ */
+export declare function formatError(error: unknown): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/box/error/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/box/error/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;;;CASd,CAAA;AAEV,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,WAAW,CAAA;AAEhD;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CASpD,CAAA;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,KAAK;IAExB,IAAI,EAAE,SAAS;gBAAf,IAAI,EAAE,SAAS,EACtB,OAAO,EAAE,MAAM;CAKlB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAUlD"}

package/dist/box/index.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+export declare function registerCommands(program: Command): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/box/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/box/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGxC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CASvD"}

package/dist/box/installer/index.d.ts

@@ -0,0 +1,2 @@
+export { BoxInstaller } from './installer';
+//# sourceMappingURL=index.d.ts.map

package/dist/box/installer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/box/installer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA"}

package/dist/box/installer/installer.d.ts

@@ -0,0 +1,16 @@
+import { BoxInstallerConfig } from '../types';
+export declare class BoxInstaller {
+    private config;
+    private spinner;
+    private prefixText;
+    constructor(config: BoxInstallerConfig);
+    validateConfig(): void;
+    private getPaths;
+    private updateSpinner;
+    getPrefixText(): string;
+    install(): Promise<void>;
+    private doCleanOldFiles;
+    private doDownloadFromNpm;
+    private doUpdateConfig;
+}
+//# sourceMappingURL=installer.d.ts.map

package/dist/box/installer/installer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"installer.d.ts","sourceRoot":"","sources":["../../../src/box/installer/installer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAgB,MAAM,UAAU,CAAA;AAoDhE,qBAAa,YAAY;IAIX,OAAO,CAAC,MAAM;IAH1B,OAAO,CAAC,OAAO,CAAK;IACpB,OAAO,CAAC,UAAU,CAAa;gBAEX,MAAM,EAAE,kBAAkB;IAI9C,cAAc,IAAI,IAAI;IAatB,OAAO,CAAC,QAAQ;IAmBhB,OAAO,CAAC,aAAa;IAMrB,aAAa,IAAI,MAAM;IAIjB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;YA0BhB,eAAe;YA0Bf,iBAAiB;YAuBjB,cAAc;CAmQ7B"}

package/dist/box/src/box.d.ts

@@ -0,0 +1,3 @@
+import { BoxOptions } from '../types';
+export declare function createBoxCommand(options: BoxOptions): Promise<void>;
+//# sourceMappingURL=box.d.ts.map

package/dist/box/src/box.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"box.d.ts","sourceRoot":"","sources":["../../../src/box/src/box.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAgC1C,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAqHzE"}

package/dist/box/types/index.d.ts

@@ -0,0 +1,30 @@
+import { Environment } from '../../shared/config';
+export interface BoxOptions {
+    env?: string;
+    appKey?: string;
+    appSecret?: string;
+    pluginVersion?: string;
+    debug?: boolean;
+}
+export interface BoxInstallerConfig {
+    env: Environment;
+    baseUrl?: string;
+    wsUrl?: string;
+    appKey: string;
+    appSecret: string;
+    pluginVersion?: string;
+}
+export interface InstallResult {
+    success: boolean;
+    message?: string;
+    error?: string;
+}
+export interface InstallPaths {
+    home: string;
+    extensions: string;
+    target: string;
+    config: string;
+    workspace: string;
+    temp: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/box/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/box/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAElD,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,WAAW,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;CACb"}

package/dist/box/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { getHomeDir } from './path';
+//# sourceMappingURL=index.d.ts.map

package/dist/box/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/box/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA"}

package/dist/box/utils/path.d.ts

@@ -0,0 +1,2 @@
+export declare function getHomeDir(): string;
+//# sourceMappingURL=path.d.ts.map

package/dist/box/utils/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../../src/box/utils/path.ts"],"names":[],"mappings":"AAEA,wBAAgB,UAAU,IAAI,MAAM,CAEnC"}

package/dist/command/index.d.ts

@@ -0,0 +1,3 @@
+export { BaseCommand } from './src/base-command';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/command/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/command/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChD,cAAc,SAAS,CAAA"}

package/dist/command/src/base-command.d.ts

@@ -0,0 +1,12 @@
+import { Command } from 'commander';
+import { Option } from '../types';
+export declare abstract class BaseCommand<T = Record<string, any>> {
+    protected program: Command;
+    constructor(program: Command);
+    protected options: Array<Option>;
+    protected init(): void;
+    abstract action(options: T): void | Promise<void>;
+    abstract command: string;
+    abstract description: string;
+}
+//# sourceMappingURL=base-command.d.ts.map

package/dist/command/src/base-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.d.ts","sourceRoot":"","sources":["../../../src/command/src/base-command.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,8BAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC3C,SAAS,CAAC,OAAO,EAAE,OAAO;gBAAhB,OAAO,EAAE,OAAO;IAItC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAK;IAErC,SAAS,CAAC,IAAI,IAAI,IAAI;IAStB,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAC7B"}

package/dist/command/types/index.d.ts

@@ -0,0 +1,14 @@
+export interface Option {
+    name: string;
+    description: string;
+}
+export interface InitOptions {
+    scenario?: string;
+    env?: string;
+    phone?: string;
+    userPass?: string;
+    appKey?: string;
+    appSecret?: string;
+    debug?: boolean;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/command/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/command/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB"}