@guandata/guancli 1.0.38 → 1.0.39

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,11 +1,13 @@
1
1
  ---
2
2
  name: guancli
3
- description: 当用户要分析观远 BI / Guandata 的 ETL、数据集、页面/仪表板、卡片、血缘、节点 SQL、资源树、目录、表单填报数据、指标 metric、公共维度 public dimension、指标树归因 metric_attribution、指标泛化查询参数,或给出 ETL ID、dsId、page ID、card ID、metric ID、metric tree ID、公共维度 ID 想看现有内容/查询数据时,主动使用这个 skill。用户要创建、新建、编辑、删除指标或公共维度,或创建指标主题/指标目录,尤其是“创建原子指标”“创建复合指标”“创建衍生指标”“新增 metric”“基于数据集建指标”“用两个指标算一个指标”“做同比/环比/最近N天/累计/期末值指标”“新建指标主题”“新建指标目录”“新建公共维度”“把几个数据集字段关联成公共维度”时,也要使用这个 skill 并读取对应写操作指引。用户提到“创建超级应用”“创建 SuperApp”“新建 SuperApp 项目”“SuperApp 模板项目”时,也要使用这个 skill,并引导使用 `guancli app create`。即使用户只说"看一下这个 page""贴一下这个 ETL 的 SQL""搜个叫 X 的数据集""这个数据集长啥样""页面卡片用了哪些 ds""帮我查这个指标""生成指标泛化查询命令""帮我创建一个原子指标""帮我创建一个复合指标""帮我创建一个同比指标""帮我创建一个指标主题""帮我创建一个指标目录""帮我创建一个公共维度""帮我创建一个超级应用",也要触发。它直接调用 BI HTTP API 拉数据并整理成 AI 友好的中文结论,定位是 BI 查询分析 + 表单填报 CRUD + 指标/公共维度写操作引导 + SuperApp 模板项目创建。修改 ETL 走 guanetl;新建/改 Card/Page 走 guanvis;数据源/数据集 CRUD/增量/调度走 guands;页面 PNG 视觉验证走 guanvis screenshot;管理员级 SVC SQL / 动态码走 guanadmin。若用户希望直接分析 BI 项目而不是手工点页面,或希望直接通过 ChatBI 进行主题问数/洞察分析,也应优先使用这个 skill。
3
+ description: 当用户要分析观远 BI / Guandata 的 ETL、数据集、页面/仪表板、卡片、血缘、节点 SQL、资源树、目录、表单填报数据、指标 metric 查询、指标树归因 metric_attribution、指标泛化查询参数,或给出 ETL ID、dsId、page ID、card ID、metric ID、metric tree ID 想看现有内容/查询数据时,主动使用这个 skill。用户提到“创建超级应用”“创建 SuperApp”“新建 SuperApp 项目”“SuperApp 模板项目”时,也要使用这个 skill,并引导使用 `guancli app create`。即使用户只说"看一下这个 page""贴一下这个 ETL 的 SQL""搜个叫 X 的数据集""这个数据集长啥样""页面卡片用了哪些 ds""帮我查这个指标""生成指标泛化查询命令""帮我创建一个超级应用",也要触发。它直接调用 BI HTTP API 拉数据并整理成 AI 友好的中文结论,定位是 BI 查询分析 + 表单填报 CRUD + 指标查询分析 + SuperApp 模板项目创建。创建/编辑/删除指标、指标主题、指标目录或公共维度走 guanmetric;修改 ETL 走 guanetl;新建/改 Card/Page 走 guanvis;数据源/数据集 CRUD/增量/调度走 guands;页面 PNG 视觉验证走 guanvis screenshot;管理员级 SVC SQL / 动态码走 guanadmin。若用户希望直接分析 BI 项目而不是手工点页面,或希望直接通过 ChatBI 进行主题问数/洞察分析,也应优先使用这个 skill。
4
4
  compatibility: Requires Node.js 14+. Install via npm install -g @guandata/guancli.
5
5
  ---
6
6
 
7
7
  # guancli
8
8
 
9
+ guancli 是 BI 资源的查询分析入口,并支持 Form 表单填报 CRUD、指标查询分析和 SuperApp 模板项目创建。
10
+
9
11
  ## 何时优先使用
10
12
 
11
13
  - 用户希望分析观远 BI 项目的 ETL 逻辑、数据集结构、页面/仪表板内容。
@@ -16,556 +18,85 @@ compatibility: Requires Node.js 14+. Install via npm install -g @guandata/guancl
16
18
  - 用户要直接用 ChatBI 主题做 L1 问数或 L2 洞察,而不是打开网页手工操作。
17
19
  - 用户要搜索指标、获取指标详情、查询指标数据、查看指标目录、执行指标树归因,或让你生成/解释指标泛化查询命令。
18
20
  - 用户给出数据集 ID,想查看该数据集创建或影响到的所有指标,包括直接原子指标以及下游复合指标、衍生指标。
19
- - 用户要创建、新建、编辑或删除指标;当前指标写操作指引先覆盖原子指标、复合指标、衍生指标的创建和编辑前校验。
20
- - 用户要创建指标主题或指标目录。
21
- - 用户要查询、新建、编辑、转移责任人或删除指标公共维度。
22
21
  - 用户要创建超级应用 / SuperApp / SuperApp 模板项目。
23
22
 
24
23
  如果用户只想生成页面 PNG 截图成品,不要用本 skill,改用 `guanvis screenshot`。
25
24
 
26
- ## 数据获取方式
27
-
28
- 通过保存的认证信息直接调用 BI HTTP API。
29
-
30
- ChatBI 同样复用 `guancli/config.json` 中当前 profile 的认证信息。
31
-
32
- ## 首次配置(认证)
33
-
34
- ### 方式一:用户名密码登录(推荐)
35
-
36
- ```bash
37
- guancli auth login
38
- ```
39
-
40
- 交互式输入:
41
- 1. 环境名称(默认 `default`,可自定义如 `staging`、`prod`)
42
- 2. BI 系统 URL(如 `https://bi.example.com`)
43
- 3. 选择登录方式:`1` 用户名密码
44
- 4. Domain(如 `demo`)
45
- 5. 用户名(邮箱)
46
- 6. 密码
47
-
48
- 登录成功后 Token 自动保存在系统标准配置目录下的 `guancli/config.json`。密码方式支持 Token 过期后自动刷新。
49
-
50
- ### 方式二:直接输入 uIdToken
51
-
52
- ```bash
53
- guancli auth login
54
- ```
55
-
56
- 选择登录方式 `2`,直接粘贴已有的 uIdToken。适用于已从 Web 界面或其他途径获取 uIdToken 的场景。
57
-
58
- ### 方式三:Personal Access Token
59
-
60
- ```bash
61
- guancli auth login --url https://bi.example.com --pat <pat>
62
- ```
63
-
64
- 交互式登录时选择登录方式 `3`,直接粘贴 Personal Access Token。`--personal-token` 仍可作为长参数使用。PAT 请求会自动携带 `X-Personal-Token`,`X-Guandata-Client` 沿用请求来源(默认 `guancli`;高层 skill 通过 `fetch` 调用时保留其自身来源),`auth status` 会通过 `/pat/introspect` 做自检。
65
-
66
- `chatbi` 子命令仍要求 uIdToken 登录;管理员动态码、管理员登录、SVC 查询等管理员能力由 `guanadmin` 提供,不使用 PAT。
67
-
68
- ### 多环境管理
69
-
70
- ```bash
71
- guancli auth login --profile staging # 添加 staging 环境
72
- guancli auth login --profile prod --default # 添加 prod 并设为默认
73
- guancli auth list # 列出所有环境
74
- guancli auth status # 查看当前认证状态
75
- guancli auth use staging # 切换默认环境为 staging
76
- guancli auth remove staging # 删除 staging 环境
77
- ```
78
-
79
- 使用特定环境(不切换默认):
80
-
81
- ```bash
82
- guancli --profile staging etl tree
83
- guancli --profile staging chatbi list-theme
84
- ```
85
-
86
- ### ChatBI 配置
87
-
88
- ChatBI 统一复用当前 profile 的 `base_url` 和 `uIdToken`。
89
-
90
- - 不需要单独配置 ChatBI URL
91
- - 不需要第二套 token / cookie
92
- - `guancli` 会在内部自动推导并探测可用的 ChatBI Public API 地址,默认优先尝试同域名下的 `/api/chat/public-api`
93
-
94
25
  ## 能力边界
95
26
 
96
- guancli 是 BI 资源的**查询分析入口**,并支持少量明确边界的写操作(Form 表单填报 CRUD、指标写操作引导)和 SuperApp 模板项目创建。其他写入类任务由专用 skill 负责:
27
+ guancli 是 BI 资源的**查询分析入口**,并支持 Form 表单填报 CRUD 和 SuperApp 模板项目创建。其他写入类任务由专用 skill 负责:
97
28
 
98
29
  | 任务 | 应使用的工具 |
99
- |------|-------------|
30
+ |---|---|
100
31
  | ETL 新建 / 编辑 / 保存 / 执行 | `guanetl` |
101
32
  | 数据源 / 数据集 CRUD / 增量 / 调度 | `guands` |
102
33
  | 看板 / 卡片构建 / 页面发布 / 截图 | `guanvis` |
34
+ | 指标创建 / 编辑 / 删除、指标主题 / 目录创建、公共维度管理、指标 Excel 标准化 | `guanmetric` |
103
35
 
104
36
  > guancli 能显示 ETL 的节点定义和 SQL,但 ETL 的新建、修改、保存、执行闭环应通过 `guanetl` 完成。
105
37
 
106
- ## SuperApp 项目创建
107
-
108
- 当用户提到创建超级应用、创建 SuperApp、新建 SuperApp 项目或基于 SuperApp 模板初始化项目时,使用 `guancli app create`。
109
-
110
- ```bash
111
- guancli app create --name <project_name> --path <parent_dir>
112
- ```
113
-
114
- 关键规则:
115
-
116
- - `--name` 是项目名称,`--path` 是项目所在的父目录;信息不全时先确认项目名称和目标目录。
117
- - 该命令会下载 SuperApp 模板并创建项目目录,随后尝试复制 `.env.template`、更新 `package.json` 名称、初始化 git,并根据模板情况执行 `setup.sh` 或 `npm install` + 启动本地 dev server。
118
- - 如果用户只是要创建本地 SuperApp 模板项目,不需要先做 BI 资源查询;直接给出或执行 `guancli app create`。
119
-
120
38
  ## 先做判断
121
39
 
122
- 1. 先用 `auth status` 确认认证是否有效。
40
+ 1. 先用 `auth status` 确认认证是否有效;首次配置、PAT、profile 和配置文件细节见 `references/auth-and-config.md`。
123
41
  2. 如果 Token 过期,密码登录方式会自动刷新;Token 方式需重新登录。
124
- 3. 先判断资源类型:ETL 用 `etl`,数据集用 `ds`,页面/仪表板用 `page`,表单填报用 `form`。
125
- 4. 信息不全时先 `tree` 或 `search`,拿到 ID 后再 `get`。
126
- 5. `tree` 和 `search` 语义不同:目录名能出现在 `ds tree`,不代表同词一定能命中 `ds search`。
42
+ 3. 先判断资源类型:ETL 用 `etl`,数据集用 `ds`,页面/仪表板用 `page`,卡片用 `card`,表单填报用 `form`。
43
+ 4. 信息不全时先 `tree` 或 `search`,拿到 ID 后再 `get`;目录名能出现在 `ds tree`,不代表同词一定能命中 `ds search`。
44
+ 5. 用户给的是业务目录名而不是数据集名时,先 `ds tree` 定位目录,再在目录内按真实表名搜索,或从已有 `page/card` 反查 `dsId`。
127
45
 
128
- ## 指标命令参考
46
+ ## 按需读取资料
129
47
 
130
- 当任务涉及指标、指标树归因、`metric query`、泛化查询、同比/环比、XTD、最近 N 周期、占比、Top N 排名或 `adv-calc-json` 时,先按需读取引用文件,避免把全部命令塞进主 skill:
48
+ | 场景 | 先读 |
49
+ |---|---|
50
+ | 首次登录、PAT、profile、Token、配置文件 | `references/auth-and-config.md` |
51
+ | ETL / 数据集 / 页面搜索、get、血缘、输出说明、故障排查 | `references/resource-query.md` |
52
+ | 数据集 preview、card preview、筛选、日期粒度、排序、动态参数、动态维度、输出格式 | `references/preview-and-output.md` |
53
+ | Form CRUD、子表、ChatBI 主题问数/洞察 | `references/form-chatbi.md` |
54
+ | 指标与指标树全量命令 | `references/metric-commands.md` |
55
+ | 指标泛化查询参数与示例 | `references/metric-generic-query.md` |
131
56
 
132
- - 指标与指标树全量命令:`references/metric-commands.md`
133
- - 指标泛化查询参数与示例:`references/metric-generic-query.md`
134
- - 指标新建 / 编辑 / 删除入口:`references/metric-mutation.md`
135
- - 指标通用写入配置:`references/metric-common-fields.md`
136
- - 指标表达式 / 计算公式支持范围:`references/metric-expression-rules.md`
137
- - 原子指标写入细节:`references/metric-atomic-mutation.md`
138
- - 复合指标写入细节:`references/metric-composite-mutation.md`
139
- - 衍生指标写入细节:`references/metric-derived-mutation.md`
140
- - 指标删除细节:`references/metric-delete-mutation.md`
141
- - 公共维度查询与写入:`references/metric-public-dimension.md`
142
-
143
- 关键规则:
144
-
145
- - 普通指标数据查询用 `guancli metric query <metric_id>`,可加 `--dim`、`--filter`、排序、列筛选、输出格式等。
146
- - 创建指标主题用 `guancli metric project-create <name>`;创建后后端会同步创建主题根目录。默认图标与 Web 新建主题一致,可用 `--icon`、`--icon-color` 覆盖;真实提交前可加 `--dry-run` 查看请求体。
147
- - 创建指标目录用 `guancli metric dir-create <name> --project-id <metric_topic_id>`,也可用 `--project-name <name>` 按主题名称解析;默认创建在该主题根目录下。创建子目录优先传 `--parent-dir-id <dir_id>`,也可用 `--parent-dir-name <name>` 按父目录名称解析;真实提交前可加 `--dry-run` 查看请求体。信息不全时先用 `guancli metric project` 和 `guancli metric tree` 定位主题 ID、目录 ID。若用户只给主题名称且当前环境下有重复主题名,必须让用户从候选主题 ID 中指定一个;若用户只给父目录名称且同一主题下有重复目录名,必须让用户从候选目录 ID 中指定一个,不要自行猜测。
148
- - 按数据集反查指标用 `guancli metric by-dataset <ds_id>`;新版 BI 会走后端批量接口直接返回直接指标和下游指标,旧版 BI 会兼容回退为先定位使用该数据集的原子指标、再沿指标下游血缘展开复合指标和衍生指标。适合回答“这个数据集关联了哪些指标 / 改这个数据集会影响哪些指标”。如果已知指标主题,可加 `-d <metric_topic_id>` 缩小范围;需要结构化结果时用 `-f json`。
149
- - 只要传入 `--compare`、`--compare-value`、`--xtd`、`--last`、`--recent`、`--recent-base`、`--percentage`、`--percentage-dim`、`--rank-top`、`--rank-order`、`--rank-dim`、`--adv-calc-json` 任一参数,就进入指标泛化查询模式。
150
- - 泛化查询要求 BI 版本 `>= 8.2.1`;如需确认环境版本,先执行 `guancli server-version --profile <profile>`。
151
- - 当用户要创建或编辑原子指标、复合指标、衍生指标时,先读取 `references/metric-mutation.md` 判断类型,再读取 `references/metric-common-fields.md`,最后只读取对应类型文件:原子指标读 `references/metric-atomic-mutation.md`,复合指标读 `references/metric-composite-mutation.md`,衍生指标读 `references/metric-derived-mutation.md`。如果涉及原子指标表达式 `formulaField.fdFormula`、复合指标 `formula` 或组合衍生 `deriveSetting.formula`,必须同时读取 `references/metric-expression-rules.md`,按当前前后端支持的表达式形态生成。默认使用当前已登录环境,不询问 profile;按必填项、数据格式 `format` 和启用的指标业务属性配置逐步查询/确认,生成 JSON 文件并先做 dry-run/人工摘要。用户确认后仍需按 Web 同款保存前校验执行:原子指标上线前跑 save-precheck,编辑态跑 validate-update-impact;复合指标和衍生指标编辑态跑 validate-update-impact。校验通过或二次确认后才真实提交。
152
- - 当用户要删除指标时,读取 `references/metric-delete-mutation.md`。删除必须先跑 `validate-delete-impact`;如果存在下游指标或卡片,按 Web 行为阻断删除并展示影响资源;只有无影响且用户明确确认后,才执行真实删除。
153
- - 当用户要查询、新建、编辑或删除公共维度时,读取 `references/metric-public-dimension.md`。公共维度写入字段为 `name`、`businessOwner`、`relatedFields[{dsId,fdId}]`;关联字段必须同类型。删除前先跑 depend-check,若已有指标使用,需要提示会影响指标计算准确性,用户明确确认后才删除。
154
-
155
- ## 标准分析流程
156
-
157
- ### 1. 拉取目录树
57
+ ## 常用查询入口
158
58
 
159
59
  ```bash
160
60
  guancli etl tree
161
61
  guancli ds tree
162
62
  guancli page tree
63
+ guancli etl search 关键词
64
+ guancli ds search 关键词
65
+ guancli page search 关键词
66
+ guancli etl get <resource_id>
67
+ guancli ds get <resource_id>
68
+ guancli ds get <resource_id> --brief
69
+ guancli ds get <resource_id> --assoc
70
+ guancli page get <resource_id>
71
+ guancli ds preview <ds_id> --limit 20
72
+ guancli card get <cd_id>
73
+ guancli card preview <cd_id> --value-format raw -f csv
163
74
  ```
164
75
 
165
- ### 2. 搜索资源
166
-
167
- ```bash
168
- guancli etl search # 搜索所有 ETL
169
- guancli etl search 关键词 # 按关键词搜索
170
- guancli etl search 关键词 -d <dir_id> # 在指定目录中搜索
171
- guancli ds search 关键词 # 搜索数据集
172
- guancli ds search --limit 500 --offset 500 # 分页扫描数据集
173
- guancli ds search --id <dsId> # 按数据集 ID 精确查找并返回单个数据集详情
174
- guancli ds search 关键词 --id <dsId> # 按名称 + ID 组合查找
175
- guancli page search 关键词 # 搜索页面
176
- ```
177
-
178
- `ds search` 默认返回前 500 条,环境数据集较多时用 `--limit` 和 `--offset` 分页扫描;`ds search --id` 会直接按数据集 ID 获取单个数据集详情,`--limit` 和 `--offset` 在 `--id` 模式下忽略。
179
-
180
- ### 3. 获取详情(含血缘)
181
-
182
- ```bash
183
- guancli etl get <resource_id> # ETL 详情(含节点、SQL、血缘)
184
- guancli ds get <resource_id> # 数据集详情(含字段结构、血缘)
185
- guancli ds get <resource_id> --brief # 数据集轻量输出(省略 Malloy、血缘、公式详情,节省 token)
186
- guancli ds get <resource_id> --assoc # 附加显示关联关系摘要(ETL、融合等)
187
- guancli page get <resource_id> # 页面详情(含卡片列表、血缘)
188
- ```
189
-
190
- **`--brief` 模式**:省略 Malloy 数据源定义、血缘关系、计算字段公式等高 token 内容,只保留基本信息和字段名/类型列表。适合 AI 在上下文受限时快速了解数据集结构。所有 `get` 子命令均支持此选项。
191
-
192
- **`--assoc` 模式**(仅 `ds get`):在详情末尾追加数据集关联关系摘要,显示关联的 ETL、数据融合等资源。
193
-
194
- ### 4. 预览数据集数据
195
-
196
- ```bash
197
- guancli ds preview <ds_id> # 预览数据集数据 (表格格式)
198
- guancli ds preview <ds_id> --limit 20 # 限制预览行数
199
- guancli ds preview <ds_id> --raw # 输出原始 JSON
200
- guancli ds execute-sql -inputs <ds_id> -sql 'SELECT * FROM `数据集名称` LIMIT 20' # 用 SQL 查询数据集(需目标 BI 满足 8.2.0-hf12+,并在 BI 管理后台 - 域设置打开高级 SQL 查询开关)
201
- # SQL 中请使用数据集名称作为临时表名;名称包含中文、空格或特殊字符时,请使用反引号包裹。可先执行 `ds get <ds_id> --brief` 查看数据集名称和字段列表。
202
- `execute-sql` 的旧版 public-api fallback 不支持 disable-cache;`--limit` 在非 raw 输出渲染前本地截断,`--raw` 保持后端原始响应。
203
- ```
204
-
205
- 数据集 ID (dsId) 可通过 `ds tree` 或 `ds search` 获取。
206
-
207
- 如果用户给的是业务目录名而不是数据集名,优先先 `ds tree` 定位目录,再在目录内按真实表名搜索,或从已有 `page/card` 反查 `dsId`。
208
-
209
- #### 带筛选条件预览
210
-
211
- 通过 `--filter` 参数传入筛选条件,每个 `--filter` 值的格式为 `"列名 操作符 [值]"`。
212
- 列名中包含空格时无需特殊处理,解析器会智能定位操作符。
213
-
214
- ```bash
215
- guancli ds preview <ds_id> --filter "name EQ 张三"
216
- guancli ds preview <ds_id> --filter "age GT 18" --filter "city IN 北京,上海,广州"
217
- guancli ds preview <ds_id> --filter "score BT 60,100"
218
- guancli ds preview <ds_id> --filter "status IS_NULL"
219
- guancli ds preview <ds_id> --filter "销售 金额 GT 100" --combine-type OR
220
- ```
221
-
222
- 支持的操作符:
223
- - 比较:`EQ`(等于)、`NE`(不等于)、`LT`(小于)、`LE`(小于等于)、`GT`(大于)、`GE`(大于等于)
224
- - 区间:`BT`(between,两个值逗号分隔)
225
- - 集合:`IN`(多值逗号分隔)
226
- - 空值:`IS_NULL`、`NOT_NULL`
227
- - 字符串:`CONTAINS`、`NOT_CONTAINS`、`STARTSWITH`、`NOT_STARTSWITH`、`ENDSWITH`、`NOT_ENDSWITH`
228
-
229
- `--combine-type` 控制多条件组合方式,默认 `AND`,可设为 `OR`。
230
- 字段类型会自动从数据集 schema 推断,无需手动指定。
231
-
232
- #### 日期粒度筛选(SUB_DATE)
233
-
234
- 对 DATE/TIMESTAMP 字段,可用 `toYear`/`toQuarter`/`toMonth`/`toWeek`/`toDate` 修饰符按粒度筛选。
235
- 语法:`"列名 toGranularity OPERATOR value"`,值使用标准格式,CLI 自动转换为 BI API 格式。
236
-
237
- ```bash
238
- guancli card preview <cd_id> --filter "日期字段 toQuarter IN 2026-Q1"
239
- guancli card preview <cd_id> --filter "日期字段 toQuarter IN 2026-Q1,2026-Q2"
240
- guancli card preview <cd_id> --filter "日期字段 toYear EQ 2026"
241
- guancli card preview <cd_id> --filter "日期字段 toMonth EQ 2026-01"
242
- guancli card preview <cd_id> --filter "日期字段 toWeek EQ 2026-W01"
243
- guancli card preview <cd_id> --filter "日期字段 toDate EQ 2026-01-15"
244
- ```
245
-
246
- 值格式规范:
247
-
248
- | 粒度 | 修饰符 | 值格式 | 示例 |
249
- |------|--------|--------|------|
250
- | 年 | `toYear` | `YYYY` | `2026` |
251
- | 季度 | `toQuarter` | `YYYY-QN` | `2026-Q1` |
252
- | 月 | `toMonth` | `YYYY-MM` | `2026-01` |
253
- | 周 | `toWeek` | `YYYY-WNN` 或 `YYYY WNN` | `2026-W01` |
254
- | 日期 | `toDate` | `YYYY-MM-DD` | `2026-01-15` |
255
-
256
- 可配合 `--filter "维度字段 EQ 值"` 同时使用多个筛选条件。
257
-
258
- #### 排序和列筛选
259
-
260
- 所有 preview 命令(ds/card)都支持排序和列筛选:
261
-
262
- ```bash
263
- guancli ds preview <ds_id> --sort-asc name # 按 name 升序 (API 层面排序)
264
- guancli ds preview <ds_id> --sort-desc id # 按 id 降序 (API 层面排序)
265
- guancli ds preview <ds_id> --columns "id,name,status" # 只显示指定列
266
- guancli ds preview <ds_id> --filter "status EQ FAILED" --sort-desc id --columns "id,task_name"
267
- ```
268
-
269
- - `--sort-asc` / `--sort-desc`: 互斥,只能指定一个列。ds preview 的排序通过 API 在数据库层面执行;card preview 的排序在 Go 端对本次取数范围执行,排序取数下限为 10000 行,若卡片总行数超过本次取数范围,不承诺全量 Top N。
270
- - `--columns`: 逗号分隔的列名列表,只显示指定列(Go 端执行)。
271
-
272
- ### 5. 获取卡片数据
273
-
274
- ```bash
275
- guancli card get <cd_id> # 获取卡片元信息
276
- guancli card preview <cd_id> # 预览卡片数据 (图表默认最多 10000 行;选择器未排序时保留服务端默认)
277
- guancli card preview <cd_id> --limit 20 # 限制预览行数
278
- guancli card preview <cd_id> -f csv # 导出 CSV 到 stdout
279
- guancli card preview <cd_id> -f csv -o card.csv # 导出 CSV 到文件
280
- guancli card preview <cd_id> -f excel -o card.xls # 导出 Excel 可打开文件
281
- guancli card preview <cd_id> --value-format raw -f csv # 保留原始数值,适合 AI 后续计算
282
- ```
283
-
284
- 卡片 ID (cdId) 可通过 `page get` 命令查看页面详情获取。
285
- 图表卡片内部会按 BI 预览接口的分页能力自动取数;选择器/树状选择器仍使用服务端单次返回。图表卡片数值默认使用 `--value-format formatted`,按卡片返回的数值格式输出(小数位、千分位、货币、百分比、单位等);需要保留原始数值用于 AI 后续计算时,使用 `--value-format raw`。无卡片格式时 `--precision` 作为兜底最大精度,默认 6 位。任意卡片预览结果在未指定 `-o/--output` 且超过 1000 行时,默认写入 `card_<cdId>_<timestamp>.<ext>` 文件,避免把大结果直接塞入上下文。该能力不对接 BI 导出任务接口。
286
-
287
- 复杂报表 Pro 卡片会自动切换为 xlsx 下载模式,只支持写入文件,不支持 `--raw`、`-f/--format`、`--limit`、排序、列筛选、精度、数值输出格式、动态参数和动态维度。未指定 `-o/--output` 时默认写入 `complex_report_pro_<cdId>_<timestamp>.xlsx`。
288
-
289
- #### 带筛选条件预览卡片
290
-
291
- 卡片 preview 同样支持 `--filter` 参数,语法与数据集 preview 一致(含日期粒度筛选)。
292
- 筛选条件会通过 API 传递给后端,适用于 CHART、SELECTOR、TREE_SELECTOR 三种卡片类型。复杂报表 Pro 首版也使用 `--filter`,CLI 会基于页面普通选择器的 `asFilter.columnMappings` 自动映射为子卡 `childFilters`;映射不唯一、树/组合筛选器、动态参数 target 等复杂情况会直接报错。
293
-
294
- ```bash
295
- guancli card preview <cd_id> --filter "name EQ 张三"
296
- guancli card preview <cd_id> --filter "age GT 18" --filter "city IN 北京,上海"
297
- guancli card preview <cd_id> --filter "利润中心 EQ 华南" --filter "季度(日期) toQuarter IN 2026-Q1"
298
- guancli card preview <complex_report_pro_cd_id> --filter "周 toWeek EQ 2026-W01" -o report.xlsx
299
- ```
300
-
301
- 字段类型会自动从卡片关联的数据集 schema 推断。日期粒度筛选需配合 `card get` 查看字段配置中的筛选器字段名和粒度。
302
-
303
- #### 带动态参数预览图表卡片
304
-
305
- 图表卡片 preview 支持通过 `--dynamic-param` 覆盖 BI 全局动态参数,格式为 `参数名=值` 或 `dpId=值`,可多次指定。
306
- CLI 会查询 `/api/dynamic-parameter/query` 补全参数元数据,并把完整 `dynamicParams` 传给 `/api/card/{cdId}/data`。
307
- 该能力仅支持 CHART 图表卡片;数据集 preview 当前后端接口不消费动态参数,暂不支持。
308
- 多选参数值沿用 BI 前端约定,使用英文逗号拼接成一个字符串传入。
309
-
310
- ```bash
311
- guancli card preview <cd_id> --dynamic-param "结束时间={{{today}}}"
312
- guancli card preview <cd_id> --dynamic-param "11=999" --raw
313
- guancli card preview <cd_id> --dynamic-param "品类=鞋,服,包"
314
- guancli card preview <cd_id> --dynamic-param "DATE_RANGE_PARAM_LEFT=2026-05-01" --dynamic-param "DATE_RANGE_PARAM_RIGHT={{{today}}}"
315
- ```
316
-
317
- #### 带动态维度预览图表卡片
318
-
319
- 图表卡片 preview 支持通过 `--dynamic-field` 覆盖当前卡片自身的动态维度选择;参数名沿用历史/API 命名,语义上表示动态维度。
320
- 格式为 `动态维度名=字段名`、`dzId=fdId`、`dzId=key`,也兼容旧写法 `dzId:key`。
321
- 动态维度名、dzId、字段名、fdId、key 先用 `card get <cd_id>` 查看;如果动态维度没有配置名称,只能使用 dzId。
322
- 单选动态维度只能指定一个字段;`multiSelect: true` 的动态维度可用英文逗号传多个字段,或重复指定同一个动态维度,CLI 会合并去重。
323
- 字段名本身包含英文逗号时,CLI 会优先按完整字段名匹配;也可用 CSV 引号写法,例如 `"维度=\"门店,二店\""`。
324
- 该能力仅支持当前卡片自身的动态维度,不支持带 `sourceDzIds` 的来源动态维度;参数只影响本次运行态取数,不修改卡片配置。
325
-
326
- ```bash
327
- guancli card get <cd_id> # 查看动态维度配置、dzId、可选字段、fdId、key
328
- guancli card preview <cd_id> --dynamic-field "维度=区域"
329
- guancli card preview <cd_id> --dynamic-field "维度=区域,门店" --dynamic-field "数值=销售额,利润"
330
- guancli card preview <cd_id> --dynamic-field "维度=区域" --dynamic-field "维度=门店"
331
- guancli card preview <cd_id> --dynamic-field "dz_region=province_fd,city_fd"
332
- guancli card preview <cd_id> --dynamic-field "dz_region=province_key,city_key"
333
- guancli card preview <cd_id> --dynamic-field "dz_region:city_key"
334
- ```
335
-
336
- ### 6. 表单填报操作 (Form CRUD)
337
-
338
- 类似 Airtable 风格的表单数据 CRUD,用户始终用**字段名**操作,CLI 内部自动映射到 fdId。
339
-
340
- #### 列出表单
341
-
342
- ```bash
343
- guancli form list # 列出所有表单
344
- guancli form list 关键词 # 搜索表单
345
- guancli form list --tree # 目录树形式展示
346
- ```
347
-
348
- #### 查看表单结构
349
-
350
- ```bash
351
- guancli form schema <fmId> # 查看字段结构(LLM 消费核心)
352
- guancli form schema <fmId> -f json # JSON 格式
353
- ```
354
-
355
- #### 查询数据
356
-
357
- ```bash
358
- guancli form query <fmId> # 查询数据(默认 50 行)
359
- guancli form query <fmId> --limit 100 # 指定行数
360
- guancli form query <fmId> --filter "姓名 EQ 张三" # 筛选
361
- guancli form query <fmId> --sort-asc 值 # 按值升序
362
- guancli form query <fmId> --columns "姓名,值" # 只显示指定列
363
- guancli form query <fmId> -f json # JSON 格式(rowId 完整)
364
- guancli form query <fmId> -f expanded # PG 风格竖排
365
- ```
366
-
367
- 筛选操作符:`EQ`(等于)、`CONTAINS`(包含)、`STARTSWITH`、`ENDSWITH`、`IS_NULL`、`NOT_NULL`。
368
-
369
- **重要**:`rowId` 在 auto 表格格式中可能被截断,使用 `-f json` 或 `-f expanded` 获取完整 rowId。
370
-
371
- #### 插入数据
372
-
373
- ```bash
374
- guancli form add <fmId> --data '{"字段名": "值", "数字字段": 42}'
375
- guancli form add <fmId> --set "字段名=值" --set "数字字段=42"
376
- echo '[{"字段名":"a"},{"字段名":"b"}]' | guancli form add <fmId> --stdin
377
- ```
378
-
379
- #### 更新数据
380
-
381
- ```bash
382
- guancli form update <fmId> <rowId> --data '{"字段名": "新值"}'
383
- guancli form update <fmId> <rowId> --set "字段名=新值"
384
- ```
385
-
386
- `rowId` 通过 `form query` 获取。
387
-
388
- #### 删除数据
389
-
390
- ```bash
391
- guancli form delete <fmId> <rowId> # 删除单行
392
- guancli form delete <fmId> <rowId1> <rowId2> # 删除多行
393
- guancli form delete <fmId> --all --yes # 删除全部(需确认)
394
- ```
395
-
396
- #### 子表操作
397
-
398
- 主表中 `TABLE` / `MATRIX_TABLE` 类型字段对应子表。子表有独立的 `subFmId`,可以用 `schema` 查看其字段结构。
399
-
400
- ```bash
401
- # 1. 查看主表 schema,找到 TABLE 字段的 subFmId
402
- guancli form schema <mainFmId>
403
- # 输出中 TABLE 字段的备注列显示 "子表 subFmId=..."
404
-
405
- # 2. 查看子表字段结构
406
- guancli form schema <subFmId>
76
+ 详细筛选、输出、动态参数和复杂报表 Pro 行为见 `references/preview-and-output.md`。
407
77
 
408
- # 3. 查询子表数据(返回结果包含主表字段,rowId 为主表行 ID,subId 为子行 ID)
409
- guancli form query <subFmId>
78
+ ## 指标关键规则
410
79
 
411
- # 4. 向子表插入行(需指定主表行的 rowId)
412
- guancli form add <subFmId> --parent-row <主表rowId> --set "字段名=值"
413
-
414
- # 5. 更新子表行(使用 subId 作为 rowId)
415
- guancli form update <subFmId> <subId> --set "字段名=新值"
416
-
417
- # 6. 删除子表行
418
- guancli form delete <subFmId> <subId>
419
- ```
420
-
421
- **子表 ID 映射规则**(AI 调用时注意区分):
422
-
423
- | 操作 | fmId 参数 | 行 ID 参数 | 额外参数 |
424
- |------|-----------|-----------|---------|
425
- | schema | subFmId | - | - |
426
- | query | subFmId | - | 返回 rowId(主表行) + subId(子行) |
427
- | add | subFmId | - | `--parent-row <主表rowId>` |
428
- | update | subFmId | **subId** (作为 rowId 位置参数) | - |
429
- | delete | subFmId | **subId** (作为 rowId 位置参数) | - |
430
-
431
- **注意**:
432
- - 子表 add 内部通过主表 update API 间接完成(后端限制),CLI 自动保留已有子行
433
- - add 需全量读取子表以保留已有行,子表总行数上限 10000;非并发安全
434
- - `--stdin` 批量插入部分失败时 CLI 返回非零退出码,summary 中显示成功/失败计数
435
-
436
- #### 典型工作流
437
-
438
- ```bash
439
- # 1. 找到表单
440
- guancli form list 测试
441
-
442
- # 2. 查看结构
443
- guancli form schema <fmId>
444
-
445
- # 3. 插入数据
446
- guancli form add <fmId> --data '{"测试1": "hello", "值": 42}'
447
-
448
- # 4. 查询并获取 rowId
449
- guancli form query <fmId> -f json
450
-
451
- # 5. 更新
452
- guancli form update <fmId> <rowId> --set "值=99"
453
-
454
- # 6. 删除
455
- guancli form delete <fmId> <rowId>
456
- ```
457
-
458
- ### 7. ChatBI 主题问数 / 洞察
459
-
460
- 先列主题,再执行问数或洞察;如果用户没有指定主题,不要猜。
461
-
462
- ```bash
463
- guancli chatbi list-theme
464
- guancli chatbi list-theme --insight
465
- guancli chatbi query --theme-name "经营主题" --message "最近30天营业收入是多少?"
466
- guancli chatbi query --theme-id "<theme_id>" --message "最近30天营业收入是多少?"
467
- guancli chatbi insight --theme-name "经营主题" --message "分析最近30天营业收入变化原因"
468
- guancli chatbi insight --theme-id "<theme_id>" --message "分析最近30天营业收入变化原因" --agent-mode single_agent
469
- ```
470
-
471
- 规则:
472
-
473
- - `list-theme` 输出 markdown 表格
474
- - `list-theme --insight` 可列出仅用于洞察的主题
475
- - `query` 输出 L1 markdown,包含解释和结果表格
476
- - `insight` 输出 L2 markdown;如返回 `GuanViz.json`,CLI 会自动降级成 markdown 表格
477
- - ChatBI 命令复用当前 profile 的 `uIdToken`
478
- - 默认超时 300 秒、轮询间隔 2 秒;必要时可传 `--timeout-ms` / `--poll-interval-ms`
479
-
480
- ### 8. 输出格式控制
481
-
482
- `--format` / `-f` 控制 preview 命令的输出格式:
80
+ - 普通指标数据查询用 `guancli metric query <metric_id>`,可加 `--dim`、`--filter`、排序、列筛选、输出格式等。
81
+ - 按数据集反查指标用 `guancli metric by-dataset <ds_id>`;如果已知指标主题,可加 `-d <metric_topic_id>` 缩小范围;需要结构化结果时用 `-f json`。
82
+ - 只要传入 `--compare`、`--compare-value`、`--xtd`、`--last`、`--recent`、`--recent-base`、`--percentage`、`--percentage-dim`、`--rank-top`、`--rank-order`、`--rank-dim`、`--adv-calc-json` 任一参数,就进入指标泛化查询模式。泛化查询要求 BI 版本 `>= 8.2.1`;如需确认环境版本,先执行 `guancli server-version --profile <profile>`。
83
+ - 当用户要创建、编辑、删除指标,创建指标主题/目录,批量标准化指标 Excel,或管理公共维度时,切换到 `guanmetric`。
483
84
 
484
- ```bash
485
- guancli ds preview <ds_id> # auto: 对齐表格,列>10 或行>20 时自动截断
486
- guancli ds preview <ds_id> -f csv # CSV 格式
487
- guancli ds preview <ds_id> -f excel # Excel 2003 XML 格式
488
- guancli ds preview <ds_id> -f expanded # PG 风格竖排
489
- guancli ds preview <ds_id> -f table # 对齐表格
490
- guancli ds preview <ds_id> -f json # JSON 行记录数组
491
- guancli ds preview <ds_id> -f json | jq '.[0]' # 配合 jq
492
- ```
85
+ ## SuperApp 项目创建
493
86
 
494
- `--raw` 输出 API 原始 JSON(不经过解析):
87
+ 当用户提到创建超级应用、创建 SuperApp、新建 SuperApp 项目或基于 SuperApp 模板初始化项目时,使用:
495
88
 
496
89
  ```bash
497
- guancli --raw etl tree
498
- guancli --raw etl get <id>
90
+ guancli app create --name <project_name> --path <parent_dir>
499
91
  ```
500
92
 
501
- ## Token 管理
502
-
503
- - 密码登录方式:Token 过期后自动调用 sign-in API 刷新。
504
- - 每次 API 响应中如果包含新 Token,且距上次签发超过可配置间隔(默认 10 分钟),会自动更新缓存。
505
- - Token 的签发时间和过期时间记录在配置文件中。
506
- - 可通过修改 `config.json` 中的 `token_refresh_interval_seconds` 调整刷新间隔。
507
-
508
- ## 输出说明
509
-
510
- - **目录树**:树形结构(├── └──),包含名称和 ID
511
- - **搜索结果**:表格式列表,包含名称、ID、状态、路径、调度信息、时间
512
- - **ETL 详情**:流程摘要 + 节点详细信息(含 Sources/UsedBy 引用)+ 等价 SQL + 血缘关系
513
- - **数据集详情**:基本信息 + 字段结构(维度/度量/计算字段分类)+ Malloy source 定义 + 血缘关系
514
- - **页面详情**:页面信息 + 卡片列表(含筛选器配置、交互联动、Malloy 查询)+ 血缘关系
515
- - **数据集预览**:表格格式预览(列名 + 数据行),显示数据集基本信息和行列统计
516
- - **卡片数据**:表格格式预览(维度 + 度量),自动检测卡片类型(图表/筛选器/树状筛选器)
517
- - **表单列表**:表格式列表,包含 fmId、名称、类型、创建者、更新时间
518
- - **表单结构**:字段定义表格,包含 fdId、名称、类型、必填/可编辑、选项(LLM 消费核心);TABLE 类型字段显示 subFmId
519
- - **表单数据**:表格格式,首列为 rowId(用于 update/delete),后续为字段列;子表查询结果额外包含 `subId` 列(子行主键,update/delete 时用作 rowId 参数)
520
- - **表单写操作**(add/update/delete):默认输出 `✓ ...` 文本;`-f json` 时输出结构化 JSON:`{"ok":true,"action":"add","rowId":"...","count":N,"total":N,"failed":N}`。批量插入部分失败时 `ok=false` 且 exit code 非零
521
- - **ChatBI 主题列表**:markdown 表格,包含 `theme_id`、`theme_name`
522
- - **ChatBI 问数/洞察**:markdown 文本;图表块会被自动转成表格,便于继续总结
93
+ - `--name` 是项目名称,`--path` 是项目所在的父目录;信息不全时先确认项目名称和目标目录。
94
+ - 该命令会下载 SuperApp 模板并创建项目目录,随后尝试复制 `.env.template`、更新 `package.json` 名称、初始化 git,并根据模板情况执行 `setup.sh` 或 `npm install` + 启动本地 dev server。
95
+ - 如果用户只是要创建本地 SuperApp 模板项目,不需要先做 BI 资源查询;直接给出或执行 `guancli app create`。
523
96
 
524
97
  ## 回答风格要求
525
98
 
526
- - 用中文输出,优先给"可执行结论"。
99
+ - 用中文输出,优先给“可执行结论”。
527
100
  - 不只贴原始命令结果,必须做逻辑归纳(按链路/主题)。
528
101
  - 涉及时间相关信息时给出明确日期。
529
102
  - 如果用户给的是模糊对象名,先说明你是如何定位到具体资源 ID 的。
530
-
531
- ## 故障排查
532
-
533
- ### ETL preview 返回 0 行
534
-
535
- 0 行是合法结果,不一定是错误。排查顺序:
536
- 1. 确认输入数据集有数据:`guancli ds preview <dsId> --limit 5`
537
- 2. 如果节点有 FILTER_ROWS 或 WHERE 条件,临时简化后再 preview
538
-
539
- ### Token 过期 / API 401
540
-
541
- 密码登录方式会自动刷新。如果仍然失败,重新登录:
542
-
543
- ```bash
544
- guancli auth login
545
- ```
546
-
547
- ## 配置文件位置
548
-
549
- - macOS: `~/Library/Application Support/guancli/config.json`
550
- - Linux: `~/.config/guancli/config.json`
551
- - Windows: `%AppData%\\guancli\\config.json`
552
-
553
- ```json
554
- {
555
- "profiles": {
556
- "default": {
557
- "name": "default",
558
- "base_url": "https://bi.example.com",
559
- "domain": "demo",
560
- "login_id": "user@example.com",
561
- "password": "yourpassword",
562
- "auth_method": "password",
563
- "token": "...",
564
- "issued_at": 1711234567,
565
- "expires_at": 0,
566
- "is_default": true
567
- }
568
- },
569
- "token_refresh_interval_seconds": 600
570
- }
571
- ```