@baomihuatop/popcorn-cli 0.1.0 → 0.1.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.
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  name: popcorn-cli
3
- description: popcorn-cli 是爆米花系统(Popcorn)的官方 CLI。需要生图、生视频时即可使用本工具:通过本地 API Key 查询可用模型、异步提交任务、按会话/任务 ID 查询最终结果。当要在终端、脚本或 Agent 流程中完成生图/生视频相关能力时使用此 skill。
4
- version: 0.1.0
3
+ description: popcorn-cli 是爆米花系统(Popcorn)的官方 CLI。需要生图、生视频时即可使用本工具:通过本地 API Key 查询可用模型、异步提交任务、按会话/任务 ID 查询最终结果。注意:API Key 会保存在本机配置文件中,任务参数、提示词和生成配置会发送到远程 Popcorn 后端;不要在共享机器、日志、提示词或任务参数中暴露敏感信息。
4
+ version: 0.1.2
5
5
  metadata:
6
6
  openclaw:
7
7
  requires:
@@ -23,6 +23,12 @@ metadata:
23
23
 
24
24
  **popcorn-cli 是爆米花(Popcorn)的命令行客户端;需要生图、生视频时,直接使用本 CLI 即可完成模型查询、任务提交与结果查询。** 按任务类型分组组织命令,面向脚本化、自动化和 Agent 场景。
25
25
 
26
+ ## 安全与隐私提示
27
+
28
+ - **API Key 本地存储**:`popcorn-cli config set-key` 会把 API Key 保存到 `~/.popcorn-cli/config.json`。该配置文件属于本机明文凭据存储,请不要提交到 Git、复制到日志、截图或共享给其他用户;在共享工作站、CI、Agent 运行环境中应限制 home 目录和配置文件访问权限。
29
+ - **远程传输**:执行 `models`、`submit`、`task list` 时,CLI 会调用远程 Popcorn 后端服务。`submit --params` 中的提示词、媒体生成参数、业务上下文、会话 ID 等会随请求发送到 Popcorn 后端;不要把密码、密钥、个人隐私、未授权客户资料或其他机密内容放入任务参数。
30
+ - **输出处理**:命令返回的 `task_id`、`session_id`、`result` URL 和错误信息可能包含业务上下文或资源地址。请按敏感数据处理,不要无意写入公开日志、公开 issue、聊天记录或可被无关人员读取的构建产物。
31
+
26
32
  ## 概念
27
33
 
28
34
  - **会话(session)**:一次业务上下文,`session_id` 由调用方生成(例如一次剧本推进、一次 Agent 会话)。同一 session 下可提交多个任务,便于统一追踪。
@@ -60,6 +66,8 @@ CLI 不接受在命令行显式传入 API Key,统一从本地配置读取。
60
66
 
61
67
  **配置文件位置**:`~/.popcorn-cli/config.json`
62
68
 
69
+ **用户警告**:该配置文件会在本机保存 API Key,属于明文 secret 存储。请确保文件只对当前用户可读,不要把 `~/.popcorn-cli/config.json` 纳入备份共享、代码仓库、日志采集或公开工单。若怀疑 API Key 泄露,应立即在 Popcorn 后台吊销并重新生成。
70
+
63
71
  **配置字段**:
64
72
 
65
73
  | 字段 | 说明 |
@@ -103,6 +111,12 @@ popcorn-cli <image|video> models
103
111
  两类任务的 `submit` 子命令签名一致,仅调用不同后端接口。
104
112
 
105
113
  > **异步接口**:`submit` 仅负责入队,立即返回 `task_id` 等受理信息,**不会等待生成完成,也不包含最终结果**。拿到 `task_id`(或传入的 `session_id`)后,须通过下方 `task list` 轮询任务状态,待 `status` 为终态后再读取 `result` / `error_message`。
114
+ >
115
+ > **预计耗时**(不排队、任务已开始执行时的参考时长;若处于 `queued` 排队中则还需额外等待):
116
+ > - 生图(image):约 **1–2 分钟**
117
+ > - 生视频(video):约 **4–10 分钟**
118
+ >
119
+ > 轮询时请按上述时长设置合理间隔与超时,避免过早判定失败。
106
120
 
107
121
  ```bash
108
122
  popcorn-cli <image|video> submit -p <JSON> [-s <SESSION_ID>]
@@ -9,7 +9,7 @@ import { buildTaskCommand } from '../src/commands/task.js';
9
9
  program
10
10
  .name('popcorn-cli')
11
11
  .description('Popcorn CLI - 通过 API Key 调用 Popcorn 后端服务')
12
- .version('0.1.0');
12
+ .version('0.1.2');
13
13
 
14
14
  program.addCommand(buildConfigCommand());
15
15
  program.addCommand(buildImageCommand());
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@baomihuatop/popcorn-cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Popcorn CLI - 通过 API Key 提交生图任务",
5
5
  "type": "module",
6
6
  "bin": {
@@ -27,13 +27,13 @@ npm install -g @baomihuatop/popcorn-cli
27
27
  popcorn-cli --version
28
28
  ```
29
29
 
30
- 预期输出为版本号(例如 `0.1.0`)。返回该输出即视为安装成功。
30
+ 预期输出为版本号(例如 `0.1.2`)。返回该输出即视为安装成功。
31
31
 
32
32
  `command not found` 时,检查 `npm bin -g` 输出的目录是否在 `PATH` 中。
33
33
 
34
34
  ## 安装 Skill
35
35
 
36
- CLI 安装并校验通过后,继续安装对应的 Agent Skill,以便在对话中按规范调用 `popcorn-cli` 能力:
36
+ CLI 安装并校验通过后,继续安装对应的 Agent Skill,以便在对话中按规范调用 `popcorn-cli` 能力(包括popcorn-cli apikey的设置,如果用户没有提供apikey,引导用户去爆米花后台创建apikey):
37
37
 
38
38
  ```bash
39
39
  npx skills add https://clawhub.ai/zeyiy/skills/popcorn-cli
package/src/config.js CHANGED
@@ -7,7 +7,7 @@ const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
7
7
 
8
8
  const DEFAULT_CONFIG = {
9
9
  apiKey: '',
10
- baseUrl: 'https://mangaforge.svcs.n1q.cn',
10
+ baseUrl: 'https://baomihua.top',
11
11
  };
12
12
 
13
13
  export function getConfigPath() {