beervid-app-cli 0.2.0 → 0.2.2

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 CHANGED
@@ -2,34 +2,53 @@
2
2
 
3
3
  BEERVID 第三方应用 Open API 的 TypeScript CLI 和 Claude Code Skill,提供 TikTok 视频发布、账号授权、数据查询等完整能力。
4
4
 
5
- ## 安装
5
+ ## 安装与调用
6
6
 
7
- ### npm CLI
7
+ ### 全局安装
8
8
 
9
9
  ```bash
10
10
  npm install -g beervid-app-cli
11
11
  beervid --help
12
12
  ```
13
13
 
14
- ### Claude Code Skill
14
+ ### npx 免安装调用
15
15
 
16
- 将本仓库克隆到 Claude Code 的 skills 目录:
16
+ ```bash
17
+ npx beervid-app-cli --help
18
+ npx beervid-app-cli config --show
19
+ npx beervid-app-cli upload --file ./video.mp4
20
+ ```
21
+
22
+ ### node 直接调用
17
23
 
18
24
  ```bash
19
- git clone <repo-url> ~/.claude/skills/beervid-app-cli
25
+ # 克隆仓库后先构建
26
+ npm install && npm run build
27
+
28
+ # 通过 node 运行入口文件
29
+ node dist/cli.mjs --help
30
+ node dist/cli.mjs config --show
20
31
  ```
21
32
 
22
- ## 环境变量
33
+ ## 配置
23
34
 
24
35
  ```bash
36
+ # 方式一:通过 config 命令持久化(推荐)
37
+ beervid config --app-key "your-api-key"
38
+
39
+ # 方式二:通过环境变量(优先级高于 config)
25
40
  export BEERVID_APP_KEY="your-api-key"
26
41
  export BEERVID_APP_BASE_URL="https://open.beervid.ai" # 可选,有默认值
42
+
43
+ # 查看当前配置
44
+ beervid config --show
27
45
  ```
28
46
 
29
47
  ## 功能概览
30
48
 
31
49
  | 命令 | 功能 |
32
50
  |------|------|
51
+ | `beervid config` | 设置/查看全局配置(APP_KEY、BASE_URL) |
33
52
  | `beervid get-oauth-url` | 获取 TT/TTS OAuth 授权链接 |
34
53
  | `beervid get-account-info` | 查询账号信息 |
35
54
  | `beervid upload` | 上传视频(支持本地文件和 URL) |
@@ -64,4 +83,4 @@ beervid publish-tts-flow --creator-id open_user_abc --file ./video.mp4 --interac
64
83
  beervid publish-tts-flow --creator-id open_user_abc --file ./video.mp4 --product-id prod_123 --product-title "Widget"
65
84
  ```
66
85
 
67
- 详细用法见 [SKILL.md](./SKILL.md)。如需查看完整 API 参考,请在仓库源码中阅读 `references/api-reference.md`。
86
+ 详细用法见 [SKILL.md](./SKILL.md)。完整 API 参考见 [references/api-reference.md](./references/api-reference.md)。
package/SKILL.md CHANGED
@@ -5,20 +5,18 @@ description: >
5
5
  不同于 BEERVID 自身应用内部的 API。当用户需要以第三方应用身份调用 BEERVID 平台接口、开发 TikTok 视频发布/上传/数据统计功能、
6
6
  处理 TT/TTS 账号授权绑定、查询商品列表、或涉及 openApiGet/openApiPost/openApiUpload 相关代码时,使用此 skill。
7
7
  包括:账号 OAuth 授权、视频上传与发布(普通/挂车)、发布状态轮询、视频数据查询、TTS 商品查询等完整业务流程。
8
- 即使用户只是提到"发布视频"、"绑定账号"、"查询视频数据"、"挂车发布"、"第三方应用"、"APP_KEY"等关键词,也应触发此 skill。
8
+ 当用户在 BEERVID 项目上下文中提到"发布视频"、"绑定账号"、"查询视频数据"、"挂车发布"、"BEERVID 第三方应用"、"BEERVID_APP_KEY"等关键词时,应触发此 skill。
9
9
  ---
10
10
 
11
11
  # BEERVID 第三方应用 Open API 集成开发指南
12
12
 
13
- > **版本:** `0.1.0` &nbsp;|&nbsp; **Node.js:** `>=20.0.0`
14
-
15
13
  本 skill 专用于 **BEERVID 面向第三方应用开放的 Open API**,覆盖 6 大能力模块。
16
14
 
17
15
  > **与 BEERVID 内部 API 的区别:** BEERVID 平台有两套 API 体系:
18
16
  >
19
17
  > - **第三方应用 Open API(本 skill)**:面向外部开发者,通过 `BEERVID_APP_KEY` 认证,API 路径前缀 `/api/v1/open/`,用于第三方应用集成 TikTok 视频发布、账号管理等能力。
20
18
  > - **BEERVID 内部 API**:BEERVID 自身产品使用的接口,认证方式和接口设计不同,不在本 skill 覆盖范围内。
21
- > 详细的请求/响应示例和错误码说明见 `references/api-reference.md`。
19
+ > 详细的请求/响应示例和错误码说明见 [`references/api-reference.md`](./references/api-reference.md)。
22
20
 
23
21
  ## 环境配置
24
22
 
@@ -149,7 +147,7 @@ async function openApiUpload<T>(
149
147
  **状态流转:**
150
148
 
151
149
  ```
152
- PROCESSING_DOWNLOAD → PUBLISH_COMPLETE(成功,携带 post_ids
150
+ PROCESSING_DOWNLOAD → PUBLISH_COMPLETE(仅当携带非空 post_ids 时才算完成)
153
151
  → FAILED(失败,携带 reason)
154
152
  ```
155
153
 
@@ -264,7 +262,7 @@ OAuth 回调
264
262
  1. 获取上传凭证 POST /api/v1/open/upload-token/generate
265
263
  2. 上传视频文件 POST /api/v1/open/file-upload(返回 fileUrl)
266
264
  3. 发布视频 POST /api/v1/open/tiktok/video/publish(返回 shareId)
267
- 4. 轮询发布状态 POST /api/v1/open/tiktok/video/status(直到 PUBLISH_COMPLETE)
265
+ 4. 轮询发布状态 POST /api/v1/open/tiktok/video/status(直到 PUBLISH_COMPLETE 且返回非空 post_ids
268
266
  5. 拉取视频数据 POST /api/v1/open/tiktok/video/query(获取播放量等)
269
267
  ```
270
268
 
@@ -285,7 +283,7 @@ OAuth 回调
285
283
  4. 发布挂车视频 POST /api/v1/open/tts/shoppable-video/publish(立即完成)
286
284
  ```
287
285
 
288
- 详细的请求/响应示例见 → `references/api-reference.md`
286
+ 详细的请求/响应示例见 → [`references/api-reference.md`](./references/api-reference.md)
289
287
 
290
288
  ## CLI 命令
291
289
 
@@ -302,6 +300,16 @@ export BEERVID_APP_KEY="your-api-key"
302
300
  export BEERVID_APP_BASE_URL="https://open.beervid.ai" # 可选,有默认值
303
301
  ```
304
302
 
303
+ > **注意:** 当参数值以 `-` 开头时(如 `businessId`、`creatorUserOpenId`),必须使用 `=` 连接选项名和值,否则 CLI 会将其误判为选项标志:
304
+ >
305
+ > ```bash
306
+ > # 正确
307
+ > beervid publish-tt-flow --business-id=-0006dmtMOdKRY...
308
+ >
309
+ > # 错误 — 会报 "Unknown option `-0`"
310
+ > beervid publish-tt-flow --business-id -0006dmtMOdKRY...
311
+ > ```
312
+
305
313
  ### 命令一览
306
314
 
307
315
  | 命令 | 功能 | 核心参数 |
@@ -382,7 +390,7 @@ beervid publish --type shoppable \
382
390
  #### 轮询发布状态
383
391
 
384
392
  ```bash
385
- # 默认每 3 秒轮询一次,最多 60 次
393
+ # 默认每 5 秒轮询一次,最多 60 次
386
394
  beervid poll-status --business-id biz_12345 --share-id share_abc123
387
395
 
388
396
  # 自定义间隔和次数
@@ -0,0 +1,7 @@
1
+ interface:
2
+ display_name: "BEERVID App CLI"
3
+ short_description: "BEERVID third-party Open API CLI skill"
4
+ default_prompt: "Use $beervid-app-cli to implement or troubleshoot BEERVID third-party Open API flows for OAuth, TikTok publishing, status polling, and product queries."
5
+
6
+ policy:
7
+ allow_implicit_invocation: true