wjx-cli 0.1.17 → 0.1.18
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/bundled/wjx-cli-use/SKILL.md +42 -36
- package/package.json +1 -1
|
@@ -48,6 +48,15 @@ wjx-cli 是问卷星 OpenAPI 的命令行工具。命令格式:`wjx <模块> <
|
|
|
48
48
|
2. 继续创建问卷中其他可支持的题目
|
|
49
49
|
3. **不要**反复调用创建命令尝试不同方式,**不要**为不同题型分别创建多个问卷
|
|
50
50
|
|
|
51
|
+
### 规则 4:面向用户说自然语言,不说 CLI 命令
|
|
52
|
+
|
|
53
|
+
用户不需要知道 `wjx` 命令的存在。CLI 是你(AI)在后台执行的工具,**不要**在回复中展示 CLI 命令或命令行用法。
|
|
54
|
+
|
|
55
|
+
- 正确:「问卷已创建,这是填写链接:https://...」
|
|
56
|
+
- 错误:「你可以运行 `wjx survey list` 查看问卷列表」
|
|
57
|
+
|
|
58
|
+
唯一例外:用户明确问"怎么用命令行"或要求看具体命令时,可以展示。
|
|
59
|
+
|
|
51
60
|
## 快速路由
|
|
52
61
|
|
|
53
62
|
| 用户意图 | 命令 |
|
|
@@ -66,24 +75,30 @@ wjx-cli 是问卷星 OpenAPI 的命令行工具。命令格式:`wjx <模块> <
|
|
|
66
75
|
|
|
67
76
|
首次使用时按以下步骤执行。AI 应直接执行命令,不要求用户去终端操作。
|
|
68
77
|
|
|
69
|
-
### 步骤 1:检查并安装 wjx-cli
|
|
78
|
+
### 步骤 1:检查并安装 Node.js 和 wjx-cli
|
|
70
79
|
|
|
71
80
|
```bash
|
|
72
|
-
|
|
81
|
+
node --version
|
|
73
82
|
```
|
|
74
83
|
|
|
75
|
-
|
|
84
|
+
如果 Node.js 未安装或版本 < 20,需要先安装 Node.js。参见 [Node.js 安装指南](../wjx-cli/docs/install-nodejs.md),根据用户操作系统选择安装方式(优先使用 fnm 或 nvm)。
|
|
85
|
+
|
|
86
|
+
Node.js 就绪后,安装 wjx-cli:
|
|
76
87
|
|
|
77
88
|
```bash
|
|
78
89
|
npm install -g wjx-cli
|
|
90
|
+
wjx --version
|
|
79
91
|
```
|
|
80
92
|
|
|
81
93
|
### 步骤 2:获取并配置 API Key
|
|
82
94
|
|
|
83
|
-
API Key
|
|
95
|
+
API Key 需要用户手动获取(无法自动化)。
|
|
96
|
+
|
|
97
|
+
**确定域名**:默认域名为 `www.wjx.cn`。如果用户使用自定义域名(如 `xxx.sojump.cn`),需替换下方链接中的域名。可先询问用户,或检查已有的 `~/.wjxrc` 配置中的 `base_url`。
|
|
84
98
|
|
|
85
|
-
1.
|
|
86
|
-
`https
|
|
99
|
+
1. 告诉用户打开以下链接,用微信扫码登录(将 `<域名>` 替换为实际域名):
|
|
100
|
+
`https://<域名>/weixinlogin.aspx?redirecturl=%2Fnewwjx%2Fmanage%2Fuserinfo.aspx%3FshowApiKey%3D1`
|
|
101
|
+
默认:`https://www.wjx.cn/weixinlogin.aspx?redirecturl=%2Fnewwjx%2Fmanage%2Fuserinfo.aspx%3FshowApiKey%3D1`
|
|
87
102
|
2. 登录后页面会显示 API Key,让用户复制粘贴给你
|
|
88
103
|
3. 拿到 Key 后,直接执行(非交互模式):
|
|
89
104
|
|
|
@@ -91,6 +106,12 @@ API Key 需要用户手动获取(无法自动化):
|
|
|
91
106
|
wjx init --api-key <用户提供的key>
|
|
92
107
|
```
|
|
93
108
|
|
|
109
|
+
如果用户使用自定义域名,追加 `--base-url`:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
wjx init --api-key <key> --base-url https://<域名>
|
|
113
|
+
```
|
|
114
|
+
|
|
94
115
|
凭据优先级:`--api-key` 参数 > `WJX_API_KEY` 环境变量 > `~/.wjxrc` 配置文件。通讯录操作另需 `WJX_CORP_ID`。
|
|
95
116
|
|
|
96
117
|
### 步骤 3:验证
|
|
@@ -103,10 +124,14 @@ wjx doctor
|
|
|
103
124
|
|
|
104
125
|
所有检查项应为 ok。如果 API 连接失败,根据错误信息排查(参见下方"常见错误与处理")。
|
|
105
126
|
|
|
106
|
-
|
|
127
|
+
### 安装完成后的回复(重要)
|
|
128
|
+
|
|
129
|
+
验证通过后,**必须**向用户展示以下自然语言使用示例。**不要**向用户展示 CLI 命令——CLI 是你(AI)在后台使用的工具,用户只需要用自然语言告诉你需求。
|
|
130
|
+
|
|
131
|
+
请向用户回复:
|
|
107
132
|
|
|
108
133
|
```
|
|
109
|
-
|
|
134
|
+
安装完成!你现在可以直接告诉我你想做什么,比如:
|
|
110
135
|
- 「帮我做一份客户满意度调查,包含 NPS 评分题」
|
|
111
136
|
- 「出一套 JavaScript 基础测验,10 道选择题」
|
|
112
137
|
- 「查看我的问卷列表」
|
|
@@ -116,23 +141,20 @@ wjx doctor
|
|
|
116
141
|
- 「帮我把这批联系人导入到通讯录」
|
|
117
142
|
```
|
|
118
143
|
|
|
119
|
-
##
|
|
144
|
+
## 命令总览
|
|
120
145
|
|
|
121
146
|
| 模块 | 命令 | 说明 |
|
|
122
147
|
|------|------|------|
|
|
123
|
-
| `survey` | list, get, create, create-by-text, delete, status, settings, update-settings,
|
|
124
|
-
| `response` | query, realtime, download, submit, modify, clear, report,
|
|
148
|
+
| `survey` | list, get, create, create-by-text, delete, status, settings, update-settings, upload, export-text, url | 问卷增删改查与配置 |
|
|
149
|
+
| `response` | query, realtime, download, submit, modify, clear, report, count | 答卷数据操作 |
|
|
125
150
|
| `contacts` | query, add, delete | 联系人管理(需 WJX_CORP_ID) |
|
|
126
151
|
| `department` | list, add, modify, delete | 部门管理 |
|
|
127
152
|
| `admin` | add, delete, restore | 管理员管理 |
|
|
128
153
|
| `tag` | list, add, modify, delete | 标签管理 |
|
|
129
|
-
| `user-system` | add-participants, modify-participants, delete-participants, bind, query-binding, query-surveys | 用户系统(已过时) |
|
|
130
154
|
| `account` | list, add, modify, delete, restore | 子账号管理 |
|
|
131
155
|
| `sso` | subaccount-url, user-system-url, partner-url | SSO 链接生成 |
|
|
132
156
|
| `analytics` | decode, nps, csat, anomalies, compare, decode-push | 本地分析(无需 API Key) |
|
|
133
|
-
| `init` / `doctor` / `whoami` | — |
|
|
134
|
-
| `completion` | bash, zsh, fish, install | Shell 自动补全 |
|
|
135
|
-
| `skill` / `update` | — | 技能管理 / 自更新 |
|
|
157
|
+
| `init` / `doctor` / `whoami` | — | 配置 / 诊断 / 验证 |
|
|
136
158
|
|
|
137
159
|
## 核心工作流
|
|
138
160
|
|
|
@@ -152,33 +174,17 @@ wjx survey create-by-text --text "问卷标题
|
|
|
152
174
|
2. 另一个题目[填空题]"
|
|
153
175
|
```
|
|
154
176
|
|
|
155
|
-
问卷类型:`--type 1` 调查(默认),`3` 投票,`6` 考试,`7`
|
|
177
|
+
问卷类型:`--type 1` 调查(默认),`3` 投票,`6` 考试,`7` 表单。
|
|
156
178
|
|
|
157
179
|
**注意**:考试问卷的正确答案和每题分值**无法**通过 API 设置。创建考试后,应提供编辑链接 `wjx survey url --mode edit --activity <vid>`,指引用户在网页端手动配置答案与评分。
|
|
158
180
|
|
|
159
|
-
完整 DSL 语法(含 28 种题型标签)见 [references/dsl-syntax.md](references/dsl-syntax.md)。
|
|
160
|
-
|
|
161
|
-
### 查询与分析答卷
|
|
181
|
+
完整 DSL 语法(含 28 种题型标签)见 [references/dsl-syntax.md](references/dsl-syntax.md)。
|
|
162
182
|
|
|
163
|
-
|
|
164
|
-
wjx response report --vid 12345 # 统计报告(建议第一步)
|
|
165
|
-
wjx response query --vid 12345 # 答卷明细数据
|
|
166
|
-
wjx response download --vid 12345 # 批量导出(CSV/SAV/Word)
|
|
167
|
-
wjx response count --vid 12345 # 答卷总数
|
|
168
|
-
wjx analytics nps --scores "[9,10,7,3,8]" # NPS 分析(本地,无需 API)
|
|
169
|
-
wjx analytics csat --scores "[4,5,3,5,2]" # CSAT 分析(本地)
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
下载格式:`--suffix 0` CSV,`1` SAV,`2` Word。完整参数见 [references/response-commands.md](references/response-commands.md)。
|
|
183
|
+
### 答卷与分析
|
|
173
184
|
|
|
174
|
-
|
|
185
|
+
答卷操作需要先获取 vid(`wjx survey list`),再使用 `wjx response` 子命令。下载格式:`--suffix 0` CSV,`1` SAV,`2` Word。详见 [references/response-commands.md](references/response-commands.md)。
|
|
175
186
|
|
|
176
|
-
|
|
177
|
-
wjx contacts add --users '[{"userid":"u1","name":"Alice","mobile":"13800000001"}]'
|
|
178
|
-
wjx department add --depts '["研发部/后端"]'
|
|
179
|
-
wjx admin add --users '[{"userid":"u1","role":2}]'
|
|
180
|
-
wjx account add --subuser user1 --password pass123 --role 1
|
|
181
|
-
```
|
|
187
|
+
### 通讯录与账号
|
|
182
188
|
|
|
183
189
|
子账号角色:1=系统管理员, 2=问卷管理员, 3=统计查看, 4=完整查看。详见 [references/contacts-commands.md](references/contacts-commands.md)。
|
|
184
190
|
|