@kg-ai/kugou-skill 0.0.18 → 0.0.19

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/SKILL.md CHANGED
@@ -25,16 +25,20 @@ description: |
25
25
  ```
26
26
  1. 检查安装 → npm install -g @kg-ai/kugou-skill
27
27
  2. 检查登录 → kugou-cli auth status
28
- 3. 未登录 → 引导用户执行 kugou-cli auth login,等待 status: success
28
+ 3. 未登录 → 引导用户执行以下步骤:
29
+ a. kugou-cli auth login(获取二维码图片,输出包含 qrcode 字段)
30
+ b. 将二维码图片(qrcode_img_path)发送给用户
31
+ c. 从 login 输出中提取 qrcode 字段值,执行 kugou-cli auth check -q <qrcode>(轮询等待确认,直到 status: success)
29
32
  4. 执行用户请求的音乐命令
30
33
  5. 解析 JSON 输出,格式化展示给用户
31
34
  ```
32
35
 
33
36
  ### 关键注意事项
34
37
 
35
- - **登录是阻塞操作**:`kugou-cli auth login` 会持续轮询直到用户扫码确认。必须等到输出 `"status":"success"` 才能继续后续音乐操作。
36
- - 登录命令会保存二维码到临时文件,**必须将二维码图片发送给用户供扫码**
37
- - **音乐命令依赖登录**:除了 `auth`、`install`、`version`、`--help` 以外,所有 `music` 子命令都需要先登录。如果收到 `"not logged in"` 错误,引导用户执行 `kugou-cli auth login`。
38
+ - **登录流程分为两步**:
39
+ 1. `auth login` - 获取二维码图片,输出包含 `qrcode` 和 `qrcode_img_path`(**必须将图片发送给用户**)
40
+ 2. `auth check -q <qrcode>` - login 输出中提取 qrcode 值,传入此命令轮询等待扫码确认,必须等到 `"status":"success"` 才能继续
41
+ - **音乐命令依赖登录**:除了 `auth`、`install`、`version`、`--help` 以外,所有 `music` 子命令都需要先登录。如果收到 `"not logged in"` 错误,引导用户执行登录流程。
38
42
  - **输出均为 JSON**:所有命令输出原始 JSON 到 stdout,错误输出到 stderr。解析 `errcode` 字段判断成功与否(`0` 为成功)。
39
43
  - **链接展示**:输出中的 `play_link` 字段,展示给用户时转为可点击格式:
40
44
  - Markdown: `[歌曲名](https://www.kugou.com/...)`
@@ -51,23 +55,28 @@ description: |
51
55
 
52
56
  ### 登录
53
57
 
54
- 使用前需要扫码登录。登录采用轮询机制,需等待用户扫码确认。
58
+ 使用前需要扫码登录。流程分为两步:
55
59
 
56
60
  ```bash
57
- kugou-cli auth login # 保存二维码图片到临时文件(需发送图片给用户扫码)
61
+ # Step 1: 获取二维码图片
62
+ kugou-cli auth login
63
+
64
+ # Step 2: 轮询等待用户扫码确认(使用 Step 1 返回的 qrcode)
65
+ kugou-cli auth check -q <qrcode>
58
66
  ```
59
67
 
60
- **登录轮询流程**(`kugou-cli auth login` 内部自动处理):
68
+ **登录流程**:
61
69
 
62
70
  ```
63
- 1. 输出 {"qrcode": "...", "qrcode_img_path": "...", "status": "waiting"}
64
- 2. 2 秒轮询一次,持续等待用户扫码
65
- 3. 用户扫码后输出 {"status": "scanned", ...} 继续等待确认
66
- 4. 用户确认后输出 {"status": "success", "nickname": "...", ...} → 登录完成
67
- 5. 若超时/二维码过期输出 {"status": "failed", "message": "..."}
71
+ 1. auth login → 输出 {"qrcode": "...", "qrcode_img_path": "..."}
72
+ 2. qrcode_img_path 对应的图片发送给用户扫码
73
+ 3. auth check -q <qrcode> 轮询等待用户确认
74
+ 4. 用户扫码后输出 {"status": "scanned", ...} → 继续等待确认
75
+ 5. 用户确认后输出 {"status": "success", ...} → 登录完成
76
+ 6. 若超时/二维码过期输出 {"status": "failed", "message": "..."}
68
77
  ```
69
78
 
70
- > **重要**:登录命令只保存二维码到临时文件,**必须将 `qrcode_img_path` 对应的图片文件发送给用户**,否则用户无法扫码登录。
79
+ > **重要**:`auth login` 只获取二维码图片,**必须将 `qrcode_img_path` 对应的图片文件发送给用户**。轮询检查由 `auth check` 命令完成。
71
80
 
72
81
  ---
73
82
 
@@ -79,7 +88,8 @@ kugou-cli auth login # 保存二维码图片到临时文件(需发送图片
79
88
 
80
89
  | 命令 | 说明 | 需要登录 |
81
90
  |------|------|---------|
82
- | `kugou-cli auth login` | 扫码登录(轮询等待确认) | 否 |
91
+ | `kugou-cli auth login` | 获取二维码图片 | 否 |
92
+ | `kugou-cli auth check -q <qrcode>` | 轮询等待扫码确认 | 否 |
83
93
  | `kugou-cli auth status` | 查看登录状态 | 否 |
84
94
  | `kugou-cli auth logout` | 登出 | 否 |
85
95
 
@@ -121,18 +131,21 @@ kugou-cli auth login # 保存二维码图片到临时文件(需发送图片
121
131
  ### 1. 扫码登录
122
132
 
123
133
  ```bash
124
- kugou-cli auth login # 保存二维码图片到临时文件(需发送图片给用户扫码)
134
+ # Step 1: 获取二维码图片
135
+ kugou-cli auth login
136
+
137
+ # Step 2: 轮询等待扫码确认(使用 Step 1 返回的 qrcode)
138
+ kugou-cli auth check -q <qrcode>
125
139
  ```
126
140
 
127
- **输出示例**:
141
+ **auth login 输出示例**:
128
142
  ```json
129
- {"qrcode": "xxx", "qrcode_img_path": "C:\\Users\\xxx\\AppData\\Local\\Temp\\kugou-qrcode.png", "status": "waiting"}
143
+ {"qrcode": "xxx", "qrcode_img_path": "C:\\Users\\xxx\\AppData\\Local\\Temp\\kugou-qrcode.png"}
130
144
  ```
131
145
 
132
146
  > **重要**:必须将 `qrcode_img_path` 对应的图片文件**发送给用户**供扫码登录。
133
147
 
134
- **轮询过程中的状态输出**:
135
- - `{"status": "waiting", ...}` — 等待扫码
148
+ **auth check 轮询状态输出**:
136
149
  - `{"status": "scanned", "nickname": "...", ...}` — 已扫码,等待用户在手机上确认
137
150
  - `{"status": "success", "nickname": "...", "secret": "..."}` — 登录成功,token 已持久化
138
151
  - `{"status": "failed", "message": "QR code expired or login failed"}` — 登录失败(二维码过期),需重新执行
@@ -465,8 +478,9 @@ echo $? # 非 0 表示出错
465
478
  ### 完整使用流程
466
479
 
467
480
  ```bash
468
- # 1. 登录
469
- kugou-cli auth login
481
+ # 1. 登录(两步流程)
482
+ kugou-cli auth login # 获取二维码
483
+ kugou-cli auth check -q <qrcode> # 轮询等待确认
470
484
 
471
485
  # 2. 查看登录状态
472
486
  kugou-cli auth status
Binary file
Binary file
Binary file
Binary file
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kg-ai/kugou-skill",
3
- "version": "0.0.18",
3
+ "version": "0.0.19",
4
4
  "description": "Kugou Skill CLI",
5
5
  "main": "index.js",
6
6
  "bin": {