@workclaw/cli 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +119 -0
- package/dist/bin/cli.d.ts +3 -0
- package/dist/bin/cli.d.ts.map +1 -0
- package/dist/index-M9uYCvsL.js +1175 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +4 -0
- package/dist/init/index.d.ts +6 -0
- package/dist/init/index.d.ts.map +1 -0
- package/dist/init/src/init.d.ts +39 -0
- package/dist/init/src/init.d.ts.map +1 -0
- package/dist/init/src/installer/base-installer.d.ts +36 -0
- package/dist/init/src/installer/base-installer.d.ts.map +1 -0
- package/dist/init/src/installer/box-installer.d.ts +39 -0
- package/dist/init/src/installer/box-installer.d.ts.map +1 -0
- package/dist/init/src/installer/index.d.ts +4 -0
- package/dist/init/src/installer/index.d.ts.map +1 -0
- package/dist/init/src/installer/local-installer.d.ts +27 -0
- package/dist/init/src/installer/local-installer.d.ts.map +1 -0
- package/dist/init/src/types/index.d.ts +36 -0
- package/dist/init/src/types/index.d.ts.map +1 -0
- package/dist/lib/command/base-command.d.ts +16 -0
- package/dist/lib/command/base-command.d.ts.map +1 -0
- package/dist/lib/index.d.ts +2 -0
- package/dist/lib/index.d.ts.map +1 -0
- package/dist/utils/config-default.d.ts +28 -0
- package/dist/utils/config-default.d.ts.map +1 -0
- package/dist/utils/config.d.ts +21 -0
- package/dist/utils/config.d.ts.map +1 -0
- package/dist/utils/crypto.d.ts +13 -0
- package/dist/utils/crypto.d.ts.map +1 -0
- package/dist/utils/error.d.ts +34 -0
- package/dist/utils/error.d.ts.map +1 -0
- package/dist/utils/http.d.ts +27 -0
- package/dist/utils/http.d.ts.map +1 -0
- package/dist/utils/index.d.ts +8 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/logger.d.ts +16 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/path.d.ts +23 -0
- package/dist/utils/path.d.ts.map +1 -0
- package/package.json +39 -0
package/README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# WorkClaw CLI
|
|
2
|
+
|
|
3
|
+
WorkClaw CLI 是一个用于初始化和配置 WorkClaw 插件的命令行工具。
|
|
4
|
+
|
|
5
|
+
## 特性
|
|
6
|
+
|
|
7
|
+
- 🚀 **快速初始化** - 一键安装 WorkClaw 插件
|
|
8
|
+
- 🔐 **安全认证** - RSA 加密密码,保护用户隐私
|
|
9
|
+
- 🌐 **多平台支持** - Windows, macOS, Linux
|
|
10
|
+
- 📊 **详细日志** - 完整的请求/响应日志
|
|
11
|
+
- 🎨 **友好界面** - 彩色输出和加载动画
|
|
12
|
+
|
|
13
|
+
## 安装
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g @workclaw/cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## 快速开始
|
|
20
|
+
|
|
21
|
+
### 交互式初始化
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
workclaw init
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 命令行参数
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
workclaw init --phone 13800138000 --user-pass mypassword
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## 使用文档
|
|
34
|
+
|
|
35
|
+
### 命令
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# 初始化
|
|
39
|
+
workclaw init [options]
|
|
40
|
+
|
|
41
|
+
# 帮助
|
|
42
|
+
workclaw --help
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 参数
|
|
46
|
+
|
|
47
|
+
| 参数 | 必填 | 说明 |
|
|
48
|
+
|------|------|------|
|
|
49
|
+
| --phone | ✅ | 手机号码 |
|
|
50
|
+
| --user-pass | ✅ | 用户密码 |
|
|
51
|
+
| --scenario | ❌ | 安装场景 |
|
|
52
|
+
| --env | ❌ | 环境 (test/prod) |
|
|
53
|
+
| --base-url | ❌ | API 地址 |
|
|
54
|
+
| --ws-url | ❌ | WebSocket 地址 |
|
|
55
|
+
| --force | ❌ | 强制覆盖 |
|
|
56
|
+
|
|
57
|
+
## 安装场景
|
|
58
|
+
|
|
59
|
+
| 场景 | 说明 |
|
|
60
|
+
|------|------|
|
|
61
|
+
| windows-local | Windows 本地安装 |
|
|
62
|
+
| mac-local | macOS 本地安装 |
|
|
63
|
+
| linux-local | Linux 本地安装 |
|
|
64
|
+
| linux-box | Linux Box 环境安装 |
|
|
65
|
+
|
|
66
|
+
## 开发
|
|
67
|
+
|
|
68
|
+
### 项目结构
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
packages/cli/
|
|
72
|
+
├── src/
|
|
73
|
+
│ ├── bin/ # CLI 入口
|
|
74
|
+
│ ├── lib/ # 核心库和基类
|
|
75
|
+
│ ├── init/ # 初始化命令
|
|
76
|
+
│ │ └── installer/ # 安装器
|
|
77
|
+
│ └── utils/ # 工具函数
|
|
78
|
+
├── vite.config.ts
|
|
79
|
+
└── README.md
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### 构建
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npm run build # 构建
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## 更新日志
|
|
89
|
+
|
|
90
|
+
### v2.0.0 (2026-04-08)
|
|
91
|
+
|
|
92
|
+
- ✨ 新增 phone + userPass 认证方式
|
|
93
|
+
- 🔒 新增 RSA 密码加密
|
|
94
|
+
- 📝 新增完整请求日志
|
|
95
|
+
- 🎨 优化交互式提示和进度显示
|
|
96
|
+
- 🌐 支持 NPM 安装插件
|
|
97
|
+
- 🔧 统一错误码管理
|
|
98
|
+
|
|
99
|
+
### v1.0.0
|
|
100
|
+
|
|
101
|
+
- 🎉 初始版本
|
|
102
|
+
- ✨ 支持 appKey + appSecret 认证
|
|
103
|
+
- ✨ 支持多平台安装
|
|
104
|
+
|
|
105
|
+
## 许可证
|
|
106
|
+
|
|
107
|
+
MIT License
|
|
108
|
+
|
|
109
|
+
## 联系方式
|
|
110
|
+
|
|
111
|
+
- 项目主页: [GitHub]()
|
|
112
|
+
- 问题反馈: [Issue Tracker]()
|
|
113
|
+
|
|
114
|
+
## 致谢
|
|
115
|
+
|
|
116
|
+
- [commander](https://github.com/tj/commander.js) - 命令行解析
|
|
117
|
+
- [chalk](https://github.com/chalk/chalk) - 彩色输出
|
|
118
|
+
- [ora](https://github.com/sindresorhus/ora) - 加载动画
|
|
119
|
+
- [axios](https://github.com/axios/axios) - HTTP 客户端
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/bin/cli.ts"],"names":[],"mappings":""}
|