wjx-cli 0.1.10 → 0.1.12

package/bundled/wjx-cli-use/references/dsl-syntax.md

@@ -0,0 +1,160 @@
+# DSL 语法参考
+
+使用 `wjx survey create-by-text --text "<DSL文本>"` 通过人类可读的文本格式创建问卷。
+
+## 基本结构
+
+```
+问卷标题
+
+可选的问卷描述（第一题前的空行后文本）
+
+1. 题目文本[题型标签]
+选项A
+选项B
+
+2. 另一个题目[题型标签]
+选项C
+选项D
+```
+
+**规则：**
+- 第一行 = 问卷标题
+- 第一题前的空行后文本 = 描述（可选）
+- 题目之间用空行分隔
+- 题号格式：`数字. 题目文本[标签]`
+- 选填题：在标签后加 `（选填）`（**注意：必须用中文全角括号**）
+- 仅支持方括号 `[...]` 包裹标签
+
+## 题型标签
+
+> **重要：DSL 解析器仅支持中文标签**，不支持英文标签。
+
+### 选择类
+
+| 标签 | 说明 | 别名 |
+|------|------|------|
+| `[单选题]` | 单选（默认题型，标签可省略） | — |
+| `[下拉框]` | 下拉单选 | `[下拉单选]` |
+| `[多选题]` | 多选 | — |
+| `[判断题]` | 判断对错 | — |
+| `[排序题]` | 拖拽排序选项 | — |
+
+### 量表评分类
+
+| 标签 | 说明 |
+|------|------|
+| `[量表题]` | 量表评分（选项用 `最小值~最大值` 格式，如 `1~5`） |
+| `[评分单选]` | 带评分的单选 |
+| `[评分多选]` | 带评分的多选 |
+| `[比重题]` | 百分比权重分配 |
+| `[滑动条]` | 滑动条控件 |
+
+### 填空类
+
+| 标签 | 说明 | 别名 |
+|------|------|------|
+| `[填空题]` | 单个文本输入 | `[简答题]`、`[问答题]` |
+| `[多项填空题]` | 多个填空。题目中**必须**包含 `{_}` 占位符 | — |
+| `[考试多项填空]` | 考试版多项填空。题目中**必须**包含 `{_}` 占位符 | — |
+| `[考试完形填空]` | 考试完形填空。题目中**必须**包含 `{_}` 占位符 | `[完形填空]` |
+
+### 矩阵类
+
+| 标签 | 说明 |
+|------|------|
+| `[矩阵题]` | 通用矩阵 |
+| `[矩阵量表题]` | 矩阵 + 量表评分 |
+| `[矩阵单选题]` | 矩阵 + 每行单选 |
+| `[矩阵多选题]` | 矩阵 + 每行多选 |
+| `[矩阵填空题]` | 矩阵 + 每行填空 |
+
+### 其他类型
+
+| 标签 | 说明 |
+|------|------|
+| `[文件上传]` | 文件上传字段 |
+| `[绘图题]` | 绘图/签名 |
+| `[段落说明]` | 说明文字（无题号）。**注意**：DSL 解析后会被自动过滤，不会出现在创建的问卷中（API 不支持段落类型） |
+| `[多级下拉题]` | 级联下拉 |
+| `[商品题]` | 商品选择 |
+| `[情景题]` | 情景选择 |
+
+## 矩阵题格式
+
+```
+4. 请评价各维度[矩阵量表题]
+行：
+- 沟通能力
+- 团队协作
+- 管理水平
+
+1~5
+```
+
+## 示例
+
+### 客户满意度调查
+
+```
+客户满意度调查
+
+请对我们的服务进行评价。
+
+1. 总体满意度[下拉框]
+非常满意
+满意
+一般
+不满意
+
+2. 工作环境评分[量表题]
+1~5
+
+3. 最看重的福利[多选题]
+薪资
+假期
+培训
+健康保险
+
+4. 您的建议[填空题]（选填）
+```
+
+### 英语考试（使用 --type 6）
+
+```
+英语期中考试
+
+请认真作答。
+
+1. "go"的过去式是什么？[单选题]
+Went
+Gone
+Going
+Goed
+
+2. 以下哪些是正确的英语句子？[多选题]
+She is a student.
+He go to school.
+They are playing.
+I has a book.
+
+3. "太阳从西边升起"这句话是正确的。[判断题]
+正确
+错误
+
+4. 请完成句子：She {_} to school every day.[填空题]
+
+5. 填空：The {_} sat on the {_}.[考试多项填空]
+```
+
+创建命令：`wjx survey create-by-text --text "<上述文本>" --type 6`
+
+## 限制
+
+DSL 格式**不支持**以下功能：
+- 分支逻辑（跳题规则）
+- 验证规则（正则、长度限制）
+- 评分权重
+- 随机化设置
+
+这些功能需要使用 JSON 格式通过 `wjx survey create --questions <json>` 创建。详见 [survey-commands.md](survey-commands.md)。

package/bundled/wjx-cli-use/references/question-types.md

@@ -0,0 +1,102 @@
+# Question Types Reference
+
+Complete mapping of q_type and q_subtype codes used in `wjx survey create --questions <json>`.
+
+## Main Types (q_type)
+
+| q_type | Name | Has Subtypes |
+|--------|------|-------------|
+| 1 | Page Break | No |
+| 2 | Paragraph/Section | No |
+| 3 | Single Choice | Yes |
+| 4 | Multiple Choice | Yes |
+| 5 | Fill-in | Yes |
+| 6 | Multi-fill | Yes |
+| 7 | Matrix | Yes |
+| 8 | File Upload | Yes |
+| 9 | Weight | No |
+| 10 | Slider | No |
+
+## All Subtypes (q_subtype)
+
+### Single Choice (q_type=3)
+| q_subtype | Name | DSL Label |
+|-----------|------|-----------|
+| 3 | Standard single choice | [单选题] (default, can omit) |
+| 301 | Dropdown | [下拉框] |
+| 302 | Scale/Likert | [量表题] |
+| 303 | Scoring single choice | [评分单选] |
+| 304 | Scenario | [情景题] |
+| 305 | True/False | [判断题] |
+
+### Multiple Choice (q_type=4)
+| q_subtype | Name | DSL Label |
+|-----------|------|-----------|
+| 4 | Standard multiple choice | [多选题] |
+| 401 | Scoring multiple choice | [评分多选] |
+| 402 | Sort/Ranking | [排序题] |
+| 403 | Commodity/Product | [商品题] |
+
+### Fill-in (q_type=5)
+| q_subtype | Name | DSL Label |
+|-----------|------|-----------|
+| 5 | Standard fill-in / Essay | [填空题] / [简答题] |
+| 501 | Multi-level dropdown | [多级下拉题] |
+
+### Multi-fill (q_type=6)
+| q_subtype | Name | DSL Label | Note |
+|-----------|------|-----------|------|
+| 6 | Standard multi-fill | [多项填空题] | q_title must contain {_} |
+| 601 | Exam multi-fill | [考试多项填空] | q_title must contain {_} |
+| 602 | Exam cloze | [考试完形填空] | q_title must contain {_} |
+
+### Matrix (q_type=7)
+| q_subtype | Name | DSL Label |
+|-----------|------|-----------|
+| 7 | Generic matrix | [矩阵题] |
+| 701 | Matrix scale | [矩阵量表题] |
+| 702 | Matrix single choice | [矩阵单选题] |
+| 703 | Matrix multiple choice | [矩阵多选题] |
+| 704 | Matrix fill-in | [矩阵填空题] |
+| 705 | Matrix slider | - |
+| 706 | Matrix numeric | - |
+| 707 | Table fill-in | - |
+| 708 | Table dropdown | - |
+| 709 | Table combo | - |
+| 710 | Table auto-increment | - |
+| 711 | Multi-file | - |
+| 712 | Multi-essay | - |
+
+### File Upload (q_type=8)
+| q_subtype | Name | DSL Label |
+|-----------|------|-----------|
+| 8 | File upload | [文件上传] |
+| 801 | Drawing/Signature | [绘图题] |
+
+## Exam Survey Notes
+
+For exam surveys, set survey type (`--type 6` or `atype=6`). The SAME q_type/q_subtype codes are used -- the distinction is at the survey level:
+
+| Exam Question | Configuration |
+|--------------|---------------|
+| Exam single choice | atype=6, q_type=3, q_subtype=3 |
+| Exam multiple choice | atype=6, q_type=4, q_subtype=4 |
+| Exam fill-in | atype=6, q_type=5, q_subtype=5 |
+| Exam multi-fill | q_type=6, q_subtype=601 |
+| Exam cloze | q_type=6, q_subtype=602 |
+
+## Survey Types (atype)
+
+| atype | Name | API Creatable |
+|-------|------|--------------|
+| 1 | Survey (调查) | Yes |
+| 2 | Assessment (测评) | Yes |
+| 3 | Vote (投票) | Yes |
+| 4 | 360 Assessment | No |
+| 5 | 360 (no assessment) | No |
+| 6 | Exam (考试) | Yes |
+| 7 | Form (表单) | Yes |
+| 8 | User System | No |
+| 9 | Teaching Evaluation | No |
+| 10 | Scale (量表) | No |
+| 11 | Democratic Review | No |

package/bundled/wjx-cli-use/references/response-commands.md

@@ -0,0 +1,164 @@
+# Response Commands Reference
+
+> **全参数访问**: 以下列出的是 CLI 显式 flags。SDK 支持的额外参数可通过 `--stdin` 传入 JSON。
+
+## wjx response query
+
+查询答卷明细数据，支持分页、时间范围、条件筛选。
+
+```bash
+wjx response query --vid 12345
+wjx response query --vid 12345 --page_size 50 --sort 1 --begin_time 1700000000000
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--page_index <n>` | 否 | 页码（默认 1） |
+| `--page_size <n>` | 否 | 每页数量（1-50，默认 10） |
+| `--sort <n>` | 否 | 0=升序, 1=降序 |
+| `--min_index <n>` | 否 | 最小答卷序号，返回 > 此序号的答卷 |
+| `--jid <s>` | 否 | 答卷编号，逗号分隔（最多 50） |
+| `--sojumpparm <s>` | 否 | 自定义链接参数，逗号分隔（最多 50） |
+| `--qid <s>` | 否 | 指定返回的题目编号，逗号分隔（最多 50） |
+| `--begin_time <n>` | 否 | 开始时间（Unix 毫秒时间戳） |
+| `--end_time <n>` | 否 | 结束时间（Unix 毫秒时间戳） |
+| `--file_view_expires <n>` | 否 | 文件链接有效期（小时，默认 1） |
+| `--query_note` | 否 | 包含标注信息 |
+| `--distinct_user` | 否 | 每用户只返回最新答卷 |
+| `--distinct_sojumpparm` | 否 | 每自定义参数只返回最新答卷 |
+| `--conds <json>` | 否 | 题目查询条件 JSON（最多 2 个，AND 关系） |
+
+**--stdin 额外参数**: `valid`(是否有效答卷，默认 true)
+
+### submitdata 编码格式
+
+答卷数据使用编码格式 `题号$答案}题号$答案`：
+
+| 分隔符 | 含义 |
+|--------|------|
+| `}` | 题目之间分隔 |
+| `$` | 题号与答案分隔 |
+| `\|` | 多选选项之间分隔 |
+
+示例：
+- 单选：`1$1`（第1题选第1个选项）
+- 多选：`2$1|3`（第2题选第1和第3个选项）
+- 填空：`3$答案文本`
+- 量表：`4$8`（第4题选8分）
+
+## wjx response report
+
+获取统计报告（频次、均值、汇总）。**建议作为数据分析的第一步**。
+
+```bash
+wjx response report --vid 12345
+wjx response report --vid 12345 --begin_time 1700000000000 --end_time 1700100000000
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--min_index <n>` | 否 | 最小答卷序号 |
+| `--jid <s>` | 否 | 答卷编号，逗号分隔（最多 50） |
+| `--sojumpparm <s>` | 否 | 自定义链接参数 |
+| `--begin_time <n>` | 否 | 开始时间（Unix 毫秒时间戳） |
+| `--end_time <n>` | 否 | 结束时间（Unix 毫秒时间戳） |
+| `--distinct_user` | 否 | 每用户只取最新答卷 |
+| `--distinct_sojumpparm` | 否 | 每自定义参数只取最新 |
+| `--conds <json>` | 否 | 题目查询条件 JSON |
+
+**--stdin 额外参数**: `valid`(是否有效答卷，默认 true)
+
+## wjx response download
+
+批量下载答卷。超过 3000 条自动转异步任务，需用 taskid 轮询。
+
+```bash
+wjx response download --vid 12345
+wjx response download --vid 12345 --suffix 1   # SAV 格式
+wjx response download --vid 12345 --taskid "abc123"   # 轮询异步任务
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--taskid <s>` | 否 | 异步任务 ID（轮询状态用） |
+| `--query_count <n>` | 否 | 最大答卷条数 |
+| `--begin_time <n>` | 否 | 开始时间（Unix 毫秒时间戳） |
+| `--end_time <n>` | 否 | 结束时间（Unix 毫秒时间戳） |
+| `--min_index <n>` | 否 | 最小答卷序号 |
+| `--qid <s>` | 否 | 指定题目，逗号分隔（最多 50） |
+| `--sort <n>` | 否 | 0=升序, 1=降序 |
+| `--query_type <n>` | 否 | 0=按文本, 1=按分数, 2=按序号 |
+| `--suffix <n>` | 否 | 格式：0=CSV（默认）, 1=SAV, 2=Word |
+| `--query_record` | 否 | 仅查询参与作答记录 |
+
+**--stdin 额外参数**: `valid`(是否有效答卷)
+
+## wjx response submit
+
+提交答卷（代填/数据导入）。
+
+```bash
+wjx response submit --vid 12345 --submitdata "1\$1}2\$hello" --inputcosttime 30
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--inputcosttime <n>` | 是 | 填写耗时（秒），必须 >1 否则视为机器提交 |
+| `--submitdata <s>` | 是 | 答卷数据，格式：`题号$答案}题号$答案` |
+| `--udsid <n>` | 否 | 自定义来源编号 |
+| `--sojumpparm <s>` | 否 | 自定义链接参数 |
+| `--submittime <s>` | 否 | 提交时间（日期时间字符串，默认当前） |
+
+## wjx response modify
+
+修改答卷。当前仅支持修改考试主观题分数。
+
+```bash
+wjx response modify --vid 12345 --jid 67890 --answers '{"10000":"85","20000":"90"}'
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--jid <n>` | 是 | 答卷编号 |
+| `--answers <json>` | 是 | 分数 JSON：`{"题号":"分数"}`。**重要**：题号是内部编号（q_index × 10000），如第1题=10000，第2题=20000 |
+
+## wjx response clear
+
+清空答卷数据（**不可逆！**）。
+
+```bash
+wjx response clear --username admin --vid 12345 --reset_to_zero
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--username <s>` | 是 | 用户名 |
+| `--vid <n>` | 是 | 问卷编号 |
+| `--reset_to_zero` | 否 | 将答卷序号重置为 0 |
+
+## wjx response count
+
+获取答卷总数。
+
+```bash
+wjx response count --vid 12345
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+
+输出格式：`{ "result": true, "data": { "vid": N, "total_count": N, "join_times": N } }`
+
+## 其他 Response 命令
+
+| 命令 | 说明 |
+|------|------|
+| `wjx response realtime --vid N` | 实时队列查询（需白名单），可选 `--count N` |
+| `wjx response winners --vid N` | 中奖者信息，可选 `--atype N`(0=其他/1=红包/-1=不限) `--awardstatus N`(0=未发/1=已发) `--page_index N` `--page_size N` |
+| `wjx response 360-report --vid N` | 360度报告下载（异步：首次返回 taskid，再次调用 `--taskid <id>` 轮询） |

package/bundled/wjx-cli-use/references/survey-commands.md

@@ -0,0 +1,194 @@
+# Survey Commands Reference
+
+> **全参数访问**: CLI 的显式 flags 是常用参数的子集。要使用 SDK 支持的全部参数，可通过 `--stdin` 传入 JSON：
+> ```bash
+> echo '{"vid":12345,"get_questions":true,"get_items":true,"format":"dsl"}' | wjx survey get --stdin
+> ```
+
+## wjx survey create
+
+创建新问卷。
+
+```bash
+wjx survey create --title "标题" --type 1 --description "描述" --questions '<JSON>'
+wjx survey create --title "标题" --source_vid 12345   # 复制已有问卷
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--title <s>` | 是 | 问卷标题 |
+| `--type <n>` | 新建时是 | 1=调查, 2=测评, 3=投票, 6=考试, 7=表单 |
+| `--description <s>` | 新建时是 | 问卷描述 |
+| `--questions <json>` | 新建时是 | 题目 JSON 数组（格式见下方） |
+| `--source_vid <s>` | 复制时是 | 源问卷编号（跳过 type/description/questions） |
+| `--publish` | 否 | 创建后立即发布 |
+
+**--stdin 可用的额外参数**: `creater`(创建者子账号), `compress_img`(压缩图片), `is_string`(原始格式)
+
+### 题目 JSON 格式
+
+```json
+[{
+  "q_index": 1,
+  "q_type": 3,
+  "q_subtype": 3,
+  "q_title": "题目文本",
+  "is_requir": true,
+  "items": [
+    {"q_index": 1, "item_index": 1, "item_title": "选项A"},
+    {"q_index": 1, "item_index": 2, "item_title": "选项B"}
+  ]
+}]
+```
+
+**重要规则**：
+- `q_subtype` 每题必填
+- `q_title` 中不要包含题型标签（如[单选题]），题型由 q_type/q_subtype 决定
+- 考试问卷设 `--type 6`，题目使用相同的 q_type 编码
+- 多项填空（q_type=6）的 q_title 必须包含 `{_}` 占位符
+
+完整 q_type/q_subtype 编码见 [question-types.md](question-types.md)。
+
+## wjx survey create-by-text
+
+用 DSL 文本创建问卷（**推荐 AI Agent 使用**）。
+
+```bash
+wjx survey create-by-text --text "标题\n\n1. 题目[单选题]\n选项A\n选项B"
+wjx survey create-by-text --file survey.txt
+cat survey.txt | wjx survey create-by-text --stdin
+wjx survey create-by-text --text "..." --dry-run   # 预览解析结果
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--text <s>` | 三选一 | DSL 文本内容 |
+| `--file <path>` | 三选一 | 从文件读取 DSL |
+| `--stdin` | 三选一 | 从 stdin 读取 |
+| `--type <n>` | 否 | 问卷类型（默认 1=调查，考试用 6） |
+| `--publish` | 否 | 创建后发布 |
+| `--creater <s>` | 否 | 创建者子账号 |
+| `--dry-run` | 否 | 预览解析结果，不实际创建 |
+
+DSL 语法详见 [dsl-syntax.md](dsl-syntax.md)。
+
+## wjx survey list
+
+查询问卷列表。
+
+```bash
+wjx survey list
+wjx survey list --name_like "满意度" --status 1
+```
+
+| Flag | 说明 |
+|------|------|
+| `--page <n>` | 页码 |
+| `--page_size <n>` | 每页数量 |
+| `--status <n>` | 状态筛选：0=未发布, 1=已发布, 2=已暂停, 3=已删除, 5=被审核 |
+| `--atype <n>` | 类型筛选：1=调查, 2=测评, 3=投票, 6=考试, 7=表单 |
+| `--name_like <s>` | 名称模糊搜索（最多 10 字符） |
+
+**--stdin 可用的额外参数**: `sort`(0-5 排序), `creater`(子账号筛选), `folder`(文件夹), `is_xingbiao`(星标), `query_all`(全部问卷), `verify_status`(审核状态), `time_type`(0=创建/1=开始/2=结束), `begin_time`/`end_time`(毫秒时间戳)
+
+## wjx survey get
+
+获取问卷详情。
+
+```bash
+wjx survey get --vid 12345
+# 获取 DSL 文本格式（通过 --stdin）
+echo '{"vid":12345,"format":"dsl"}' | wjx survey get --stdin
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+
+**--stdin 可用的额外参数**: `format`("json"/"dsl"/"both"), `get_questions`(获取题目), `get_items`(获取选项), `get_exts`(获取问答选项), `get_setting`(获取题目设置), `get_page_cut`(获取分页信息), `get_tags`(获取标签), `showtitle`(返回标题)
+
+## wjx survey export-text
+
+导出问卷为人类可读的 DSL 文本。
+
+```bash
+wjx survey export-text --vid 12345
+wjx survey export-text --vid 12345 --raw   # 纯文本输出（不包裹 JSON）
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--raw` | 否 | 输出纯文本而非 JSON |
+
+## wjx survey status
+
+修改问卷发布状态。
+
+```bash
+wjx survey status --vid 12345 --state 1   # 发布
+wjx survey status --vid 12345 --state 2   # 暂停
+wjx survey status --vid 12345 --state 3   # 删除
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--state <n>` | 是 | 1=发布, 2=暂停, 3=删除 |
+
+## wjx survey settings / update-settings
+
+```bash
+wjx survey settings --vid 12345
+wjx survey update-settings --vid 12345 --time_setting '{"exam_min_seconds":60,"exam_max_seconds":3600}'
+```
+
+获取设置只需 `--vid`。更新设置的 flags：
+
+| Flag | 说明 |
+|------|------|
+| `--vid <n>` | 问卷编号（必填） |
+| `--api_setting <json>` | API 限制：`{"max_times":100,"pass_score":60,"pass_no_allow":true}` |
+| `--after_submit_setting <json>` | 提交后跳转：`{"type":1,"url":"https://..."}` (type: 0=感谢信息, 1=跳转) |
+| `--msg_setting <json>` | 数据推送：`{"push_url":"https://...","quick_post":true,"retry":true}` |
+| `--sojumpparm_setting <json>` | 自定义参数：`{"params":[{"name":"source","type":0}]}` |
+| `--time_setting <json>` | 时间设置：`{"start_time":"2026-04-01 00:00","exam_min_seconds":60}` |
+
+## wjx survey delete
+
+删除问卷（**不可逆**）。
+
+```bash
+wjx survey delete --vid 12345 --username admin
+wjx survey delete --vid 12345 --username admin --completely   # 彻底删除，不进回收站
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--vid <n>` | 是 | 问卷编号 |
+| `--username <s>` | 是 | 用户名 |
+| `--completely` | 否 | 彻底删除（不进回收站） |
+
+## wjx survey url
+
+生成问卷创建/编辑链接（无需 API 签名）。
+
+```bash
+wjx survey url --mode create --name "新问卷"
+wjx survey url --mode edit --activity 12345
+```
+
+| Flag | 必填 | 说明 |
+|------|------|------|
+| `--mode <s>` | 否 | "create"（默认）或 "edit" |
+| `--name <s>` | 否 | 问卷名称（create 模式） |
+| `--activity <n>` | edit 模式是 | 问卷编号（edit 模式） |
+
+## 其他 Survey 命令
+
+| 命令 | 用法 |
+|------|------|
+| `wjx survey tags --username user` | 获取题目标签列表 |
+| `wjx survey tag-details --tag_id 123` | 获取标签下的题目详情 |
+| `wjx survey clear-bin --username user` | 清空回收站（可选 `--vid N` 指定问卷） |
+| `wjx survey upload --file_name img.png --file <base64>` | 上传文件（png/jpg/gif/bmp/webp，~4MB） |