sino-bc-cli 1.8.10 → 1.8.12

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.
Files changed (72) hide show
  1. package/README.md +124 -97
  2. package/dist/SKILL.md +73 -24
  3. package/dist/affordance/auth.md +27 -0
  4. package/dist/affordance/biz-line.md +11 -11
  5. package/dist/affordance/dashboard.md +73 -0
  6. package/dist/affordance/delivery.md +81 -0
  7. package/dist/affordance/document.md +69 -0
  8. package/dist/affordance/file.md +43 -0
  9. package/dist/affordance/im.md +66 -0
  10. package/dist/affordance/organization.md +45 -0
  11. package/dist/affordance/project-analysis.md +75 -0
  12. package/dist/affordance/project-stage.md +40 -0
  13. package/dist/affordance/project.md +199 -0
  14. package/dist/affordance/sso.md +1 -1
  15. package/dist/affordance/task.md +109 -0
  16. package/dist/affordance/tenant.md +15 -0
  17. package/dist/affordance/user.md +33 -0
  18. package/dist/api-doc/README.md +51 -0
  19. package/dist/api-doc/custom/cli-oauth.md +19 -0
  20. package/dist/api-doc/oapi/auth.md +57 -0
  21. package/dist/api-doc/oapi/biz-line-query.md +9 -1
  22. package/dist/api-doc/oapi/biz-line-strategy.md +500 -312
  23. package/dist/api-doc/oapi/dashboard.md +202 -0
  24. package/dist/api-doc/oapi/delivery.md +253 -0
  25. package/dist/api-doc/oapi/document.md +192 -0
  26. package/dist/api-doc/oapi/file.md +92 -0
  27. package/dist/api-doc/oapi/im.md +195 -0
  28. package/dist/api-doc/oapi/organization.md +86 -0
  29. package/dist/api-doc/oapi/project-analysis.md +252 -0
  30. package/dist/api-doc/oapi/project-stage.md +88 -0
  31. package/dist/api-doc/oapi/project.md +597 -0
  32. package/dist/api-doc/oapi/sso.md +5 -1
  33. package/dist/api-doc/oapi/task.md +361 -0
  34. package/dist/api-doc/oapi/tenant.md +17 -0
  35. package/dist/api-doc/oapi/user.md +73 -0
  36. package/dist/generated/api-catalog.json +23976 -143
  37. package/dist/index.js +1 -1
  38. package/dist/skills/default/sino-bc-shared/SKILL.md +18 -7
  39. package/dist/skills/default/sino-bc-shared/references/config-and-env.md +10 -7
  40. package/dist/skills/default/sino-bc-shared/references/output-contract.md +52 -7
  41. package/dist/skills/default/sino-bc-shared/references/write-approval.md +4 -4
  42. package/dist/skills/oapi/sino-bc-auth/SKILL.md +34 -0
  43. package/dist/skills/oapi/sino-bc-biz-line/SKILL.md +45 -40
  44. package/dist/skills/oapi/sino-bc-biz-line/references/common-mistakes.md +10 -0
  45. package/dist/skills/{custom → oapi}/sino-bc-biz-line/references/enums.md +7 -1
  46. package/dist/skills/oapi/sino-bc-dashboard/SKILL.md +48 -0
  47. package/dist/skills/oapi/sino-bc-delivery/SKILL.md +53 -0
  48. package/dist/skills/oapi/sino-bc-document/SKILL.md +51 -0
  49. package/dist/skills/oapi/sino-bc-file/SKILL.md +46 -0
  50. package/dist/skills/oapi/sino-bc-im/SKILL.md +49 -0
  51. package/dist/skills/oapi/sino-bc-organization/SKILL.md +44 -0
  52. package/dist/skills/oapi/sino-bc-project/SKILL.md +69 -0
  53. package/dist/skills/oapi/sino-bc-project-analysis/SKILL.md +48 -0
  54. package/dist/skills/oapi/sino-bc-project-analysis/references/analysis-workflow.md +17 -0
  55. package/dist/skills/oapi/sino-bc-project-analysis/references/filters-and-metrics.md +32 -0
  56. package/dist/skills/oapi/sino-bc-project-stage/SKILL.md +47 -0
  57. package/dist/skills/oapi/sino-bc-sso/SKILL.md +15 -17
  58. package/dist/skills/oapi/sino-bc-task/SKILL.md +57 -0
  59. package/dist/skills/oapi/sino-bc-task/references/state-machine.md +18 -0
  60. package/dist/skills/oapi/sino-bc-tenant/SKILL.md +32 -0
  61. package/dist/skills/oapi/sino-bc-user/SKILL.md +48 -0
  62. package/package.json +4 -5
  63. package/dist/api-doc/custom/README.md +0 -92
  64. package/dist/skills/custom/biz-line-strategy-generate/SKILL.md +0 -58
  65. package/dist/skills/custom/biz-line-strategy-generate/references/api-flow.md +0 -71
  66. package/dist/skills/custom/biz-line-strategy-generate/references/four-strategies.md +0 -57
  67. package/dist/skills/custom/biz-line-strategy-generate/references/metrics.md +0 -97
  68. package/dist/skills/custom/biz-line-strategy-generate/references/output-excel.md +0 -62
  69. package/dist/skills/custom/biz-line-strategy-generate/scripts/build_report.py +0 -260
  70. package/dist/skills/custom/sino-bc-biz-line/references/common-mistakes.md +0 -8
  71. package/dist/skills/oapi/sino-bc-biz-line/references/long-tail-api.md +0 -18
  72. package/dist/skills/oapi/sino-bc-sso/references/long-tail-api.md +0 -9
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## +list
6
6
 
7
- - **WHEN**:查询业务线分页列表
7
+ - **WHEN**:查询业务线列表;不传条件即查全部
8
8
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
9
  - **示例**:`sino-bc-cli biz-line +list --data '{...}'`
10
10
 
@@ -16,19 +16,19 @@
16
16
 
17
17
  ## +save
18
18
 
19
- - **WHEN**:新建业务线 (写操作需 --yes)
19
+ - **WHEN**:新建业务线
20
20
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
21
21
  - **示例**:`sino-bc-cli biz-line +save --data '{...}'`
22
22
 
23
23
  ## +update
24
24
 
25
- - **WHEN**:更新业务线 (写操作需 --yes)
25
+ - **WHEN**:编辑业务线
26
26
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
27
27
  - **示例**:`sino-bc-cli biz-line +update --data '{...}'`
28
28
 
29
29
  ## +status
30
30
 
31
- - **WHEN**:更新业务线状态 (写操作需 --yes)
31
+ - **WHEN**:切换业务线状态:1 进行中 / 2 已完成 / 3 已暂停
32
32
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
33
33
  - **示例**:`sino-bc-cli biz-line +status --data '{...}'`
34
34
 
@@ -40,7 +40,7 @@
40
40
 
41
41
  ## +strategies
42
42
 
43
- - **WHEN**:查询投放策略分页列表
43
+ - **WHEN**:查询业务线的周策略与表现;支持按名称解析业务线
44
44
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
45
45
  - **示例**:`sino-bc-cli biz-line +strategies --data '{...}'`
46
46
 
@@ -52,31 +52,31 @@
52
52
 
53
53
  ## +strategy-save
54
54
 
55
- - **WHEN**:新建投放策略 (写操作需 --yes)
55
+ - **WHEN**:新建业务线周策略
56
56
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
57
57
  - **示例**:`sino-bc-cli biz-line +strategy-save --data '{...}'`
58
58
 
59
59
  ## +strategy-update
60
60
 
61
- - **WHEN**:更新投放策略 (写操作需 --yes)
61
+ - **WHEN**:编辑周策略;version 为乐观锁,冲突时可传 overwrite
62
62
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
63
63
  - **示例**:`sino-bc-cli biz-line +strategy-update --data '{...}'`
64
64
 
65
65
  ## +strategy-delete
66
66
 
67
- - **WHEN**:删除投放策略 (写操作需 --yes)
67
+ - **WHEN**:删除周策略 (写操作需 --yes)
68
68
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
69
69
  - **示例**:`sino-bc-cli biz-line +strategy-delete --data '{...}'`
70
70
 
71
71
  ## +channels
72
72
 
73
- - **WHEN**:查询投放渠道列表
73
+ - **WHEN**:查询投放渠道列表(code 即业务线里的 mediaChannelId)
74
74
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
75
75
  - **示例**:`sino-bc-cli biz-line +channels`
76
76
 
77
77
  ## +categories
78
78
 
79
- - **WHEN**:查询投放品类字典
79
+ - **WHEN**:查询投放行业与品类字典树(一级行业,二级品类)
80
80
  - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
81
81
  - **示例**:`sino-bc-cli biz-line +categories`
82
82
 
@@ -130,6 +130,6 @@
130
130
 
131
131
  ## api
132
132
 
133
- - **WHEN**:没有 `+` 的接口按 name 点名调用。
133
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
134
134
  - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
135
135
  - **示例**:`sino-bc-cli biz-line api <name> --data '{...}'`
@@ -0,0 +1,73 @@
1
+ # dashboard 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +budget-by-marketing-goal
6
+
7
+ - **WHEN**:营销目标预算分布
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli dashboard +budget-by-marketing-goal --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+
12
+ ## +budget-by-media
13
+
14
+ - **WHEN**:媒体预算占比
15
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
16
+ - **示例**:`sino-bc-cli dashboard +budget-by-media --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
17
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
18
+
19
+ ## +budget-by-project-type
20
+
21
+ - **WHEN**:项目类型预算分布
22
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
23
+ - **示例**:`sino-bc-cli dashboard +budget-by-project-type --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
24
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
25
+
26
+ ## +budget-by-region
27
+
28
+ - **WHEN**:区域预算占比
29
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
30
+ - **示例**:`sino-bc-cli dashboard +budget-by-region --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
31
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
32
+
33
+ ## +budget-rank
34
+
35
+ - **WHEN**:预算排行榜
36
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
37
+ - **示例**:`sino-bc-cli dashboard +budget-rank --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
38
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
39
+
40
+ ## +budget-source-ratio
41
+
42
+ - **WHEN**:预算来源占比
43
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
44
+ - **示例**:`sino-bc-cli dashboard +budget-source-ratio --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
45
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
46
+
47
+ ## +key-project-timeline
48
+
49
+ - **WHEN**:关键项目时间轴
50
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
51
+ - **示例**:`sino-bc-cli dashboard +key-project-timeline --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
52
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
53
+
54
+ ## +metrics
55
+
56
+ - **WHEN**:核心卡片指标
57
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
58
+ - **示例**:`sino-bc-cli dashboard +metrics --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
59
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
60
+
61
+ ## +project-distribution
62
+
63
+ - **WHEN**:项目分布
64
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
65
+ - **示例**:`sino-bc-cli dashboard +project-distribution --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
66
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
67
+
68
+ ## api
69
+
70
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
71
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
72
+ - **示例**:`sino-bc-cli dashboard api <name> --data '{...}'`
73
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
@@ -0,0 +1,81 @@
1
+ # delivery 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +campaign-page
6
+
7
+ - **WHEN**:分页查询项目自动归集广告系列
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli delivery +campaign-page --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+
12
+ ## +campaign-get
13
+
14
+ - **WHEN**:查询广告系列设置
15
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
16
+ - **示例**:`sino-bc-cli delivery +campaign-get --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
17
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
18
+
19
+ ## +campaign-save
20
+
21
+ - **WHEN**:保存广告系列设置
22
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
23
+ - **示例**:`sino-bc-cli delivery +campaign-save --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
24
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
25
+
26
+ ## +core-metrics
27
+
28
+ - **WHEN**:核心指标卡
29
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
30
+ - **示例**:`sino-bc-cli delivery +core-metrics --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
31
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
32
+
33
+ ## +detail-choose-list
34
+
35
+ - **WHEN**:查询项目维度筛选列表
36
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
37
+ - **示例**:`sino-bc-cli delivery +detail-choose-list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
38
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
39
+
40
+ ## +detail-list
41
+
42
+ - **WHEN**:查询项目成效列表
43
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
44
+ - **示例**:`sino-bc-cli delivery +detail-list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
45
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
46
+
47
+ ## +dimension-module
48
+
49
+ - **WHEN**:维度分布
50
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
51
+ - **示例**:`sino-bc-cli delivery +dimension-module --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
52
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
53
+
54
+ ## +kpi-module
55
+
56
+ - **WHEN**:KPI 进度与走势
57
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
58
+ - **示例**:`sino-bc-cli delivery +kpi-module --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
59
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
60
+
61
+ ## +spend-module
62
+
63
+ - **WHEN**:消耗分析
64
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
65
+ - **示例**:`sino-bc-cli delivery +spend-module --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
66
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
67
+
68
+ ## +stage-tabs
69
+
70
+ - **WHEN**:投放阶段 Tab 下拉(含起止时间)
71
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
72
+ - **示例**:`sino-bc-cli delivery +stage-tabs --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
73
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
74
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
75
+
76
+ ## api
77
+
78
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
79
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
80
+ - **示例**:`sino-bc-cli delivery api <name> --data '{...}'`
81
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
@@ -0,0 +1,69 @@
1
+ # document 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +project-delete
6
+
7
+ - **WHEN**:删除项目文档
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli document +project-delete --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+
12
+ ## +linked-tasks
13
+
14
+ - **WHEN**:查询项目文档已关联任务列表(同项目同 storage_key 的 TASK 文档行)
15
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
16
+ - **示例**:`sino-bc-cli document +linked-tasks --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
17
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
18
+
19
+ ## +project-list
20
+
21
+ - **WHEN**:查询项目文档
22
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
23
+ - **示例**:`sino-bc-cli document +project-list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
24
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
25
+
26
+ ## +update-stage
27
+
28
+ - **WHEN**:修改项目文档所属阶段
29
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
30
+ - **示例**:`sino-bc-cli document +update-stage --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
31
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
32
+
33
+ ## +project-upload
34
+
35
+ - **WHEN**:上传项目文档(multipart/form-data:projectId项目ID,file 为文件 part)
36
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
37
+ - **示例**:`sino-bc-cli document +project-upload --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
38
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
39
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
40
+ - **上传**:`--data` 的文件字段填写本地文件路径;可先 `--dry-run` 预览。
41
+
42
+ ## +detail
43
+
44
+ - **WHEN**:协同文档详情
45
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
46
+ - **示例**:`sino-bc-cli document +detail --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
47
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
48
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
49
+
50
+ ## +list
51
+
52
+ - **WHEN**:协同文档列表(全量)
53
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
54
+ - **示例**:`sino-bc-cli document +list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
55
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
56
+
57
+ ## +page
58
+
59
+ - **WHEN**:协同文档列表(分页)
60
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
61
+ - **示例**:`sino-bc-cli document +page --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
62
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
63
+
64
+ ## api
65
+
66
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
67
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
68
+ - **示例**:`sino-bc-cli document api <name> --data '{...}'`
69
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
@@ -0,0 +1,43 @@
1
+ # file 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +upload-info-by-record
6
+
7
+ - **WHEN**:根据上传记录ID获取上传文件信息
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli file +upload-info-by-record --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
12
+
13
+ ## +upload-info
14
+
15
+ - **WHEN**:获取上传文件信息
16
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
17
+ - **示例**:`sino-bc-cli file +upload-info --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
18
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
19
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
20
+
21
+ ## +upload
22
+
23
+ - **WHEN**:文件上传
24
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
25
+ - **示例**:`sino-bc-cli file +upload --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
26
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
27
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
28
+ - **上传**:`--data` 的文件字段填写本地文件路径;可先 `--dry-run` 预览。
29
+
30
+ ## +url
31
+
32
+ - **WHEN**:获取上传文件链接
33
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
34
+ - **示例**:`sino-bc-cli file +url --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
35
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
36
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
37
+
38
+ ## api
39
+
40
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
41
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
42
+ - **示例**:`sino-bc-cli file api <name> --data '{...}'`
43
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
@@ -0,0 +1,66 @@
1
+ # im 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +members
6
+
7
+ - **WHEN**:查询会话成员
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli im +members --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+
12
+ ## +list
13
+
14
+ - **WHEN**:查询任务或项目日志关联的飞书聊天记录
15
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
16
+ - **示例**:`sino-bc-cli im +list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
17
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
18
+
19
+ ## +cursor
20
+
21
+ - **WHEN**:锚点翻页查询群消息
22
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
23
+ - **示例**:`sino-bc-cli im +cursor --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
24
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
25
+
26
+ ## +detail
27
+
28
+ - **WHEN**:按 chatId + messageId 查询消息明细
29
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
30
+ - **示例**:`sino-bc-cli im +detail --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
31
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
32
+
33
+ ## +page
34
+
35
+ - **WHEN**:分页查询群消息
36
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
37
+ - **示例**:`sino-bc-cli im +page --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
38
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
39
+
40
+ ## +replies
41
+
42
+ - **WHEN**:按引用链根查询根消息及全部回复
43
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
44
+ - **示例**:`sino-bc-cli im +replies --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
45
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
46
+
47
+ ## +scope
48
+
49
+ - **WHEN**:查询消息归属(主群或话题)
50
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
51
+ - **示例**:`sino-bc-cli im +scope --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
52
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
53
+
54
+ ## +send
55
+
56
+ - **WHEN**:应用机器人发送消息(卡片)
57
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
58
+ - **示例**:`sino-bc-cli im +send --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
59
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
60
+
61
+ ## api
62
+
63
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
64
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
65
+ - **示例**:`sino-bc-cli im api <name> --data '{...}'`
66
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
@@ -0,0 +1,45 @@
1
+ # organization 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +list
6
+
7
+ - **WHEN**:获取用户可以查看的签约主体列表
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli organization +list --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+
12
+ ## +tree
13
+
14
+ - **WHEN**:人员架构树
15
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
16
+ - **示例**:`sino-bc-cli organization +tree --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
17
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
18
+
19
+ ## +team-members
20
+
21
+ - **WHEN**:团队成员列表
22
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
23
+ - **示例**:`sino-bc-cli organization +team-members --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
24
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
25
+
26
+ ## +info
27
+
28
+ - **WHEN**:获取当前用户信息
29
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
30
+ - **示例**:`sino-bc-cli organization +info --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
31
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
32
+
33
+ ## +listBySourceType
34
+
35
+ - **WHEN**:根据用户来源类型获取用户列表(包含SSO用户则只返回前10条)
36
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
37
+ - **示例**:`sino-bc-cli organization +listBySourceType --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
38
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
39
+
40
+ ## api
41
+
42
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
43
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
44
+ - **示例**:`sino-bc-cli organization api <name> --data '{...}'`
45
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
@@ -0,0 +1,75 @@
1
+ # project-analysis 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +export-member-hre
6
+
7
+ - **WHEN**:导出优化师人效列表
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli project-analysis +export-member-hre --data '{...}'`
10
+
11
+ ## +export-member-timesheets
12
+
13
+ - **WHEN**:导出优化师工时列表
14
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
15
+ - **示例**:`sino-bc-cli project-analysis +export-member-timesheets --data '{...}'`
16
+
17
+ ## +export-projects
18
+
19
+ - **WHEN**:导出项目数据列表
20
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
21
+ - **示例**:`sino-bc-cli project-analysis +export-projects --data '{...}'`
22
+
23
+ ## +member-hre
24
+
25
+ - **WHEN**:查询优化师人效列表
26
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
27
+ - **示例**:`sino-bc-cli project-analysis +member-hre --data '{...}'`
28
+
29
+ ## +member-spend
30
+
31
+ - **WHEN**:查询优化师消耗趋势
32
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
33
+ - **示例**:`sino-bc-cli project-analysis +member-spend --data '{...}'`
34
+
35
+ ## +member-timesheet-trend
36
+
37
+ - **WHEN**:查询优化师工时趋势
38
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
39
+ - **示例**:`sino-bc-cli project-analysis +member-timesheet-trend --data '{...}'`
40
+
41
+ ## +member-timesheets
42
+
43
+ - **WHEN**:查询优化师工时列表
44
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
45
+ - **示例**:`sino-bc-cli project-analysis +member-timesheets --data '{...}'`
46
+
47
+ ## +projects
48
+
49
+ - **WHEN**:分页查询优化项目月度数据;默认第 1 页、每页 10 条
50
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
51
+ - **示例**:`sino-bc-cli project-analysis +projects --data '{...}'`
52
+
53
+ ## +spend-per-hour
54
+
55
+ - **WHEN**:查询单位工时消耗趋势
56
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
57
+ - **示例**:`sino-bc-cli project-analysis +spend-per-hour --data '{...}'`
58
+
59
+ ## +spend-timesheet
60
+
61
+ - **WHEN**:查询消耗与工时趋势
62
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
63
+ - **示例**:`sino-bc-cli project-analysis +spend-timesheet --data '{...}'`
64
+
65
+ ## +summary
66
+
67
+ - **WHEN**:查询优化项目分析汇总;支持单月、月份范围和多选筛选
68
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
69
+ - **示例**:`sino-bc-cli project-analysis +summary --data '{...}'`
70
+
71
+ ## api
72
+
73
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
74
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
75
+ - **示例**:`sino-bc-cli project-analysis api <name> --data '{...}'`
@@ -0,0 +1,40 @@
1
+ # project-stage 命令何时用
2
+
3
+ 字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
4
+
5
+ ## +list-with-task-count
6
+
7
+ - **WHEN**:查询项目阶段列表(含可见任务数)
8
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
9
+ - **示例**:`sino-bc-cli project-stage +list-with-task-count --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
10
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
11
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
12
+
13
+ ## +listByProjectId
14
+
15
+ - **WHEN**:查询项目阶段列表
16
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
17
+ - **示例**:`sino-bc-cli project-stage +listByProjectId --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
18
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
19
+ - **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
20
+
21
+ ## +save
22
+
23
+ - **WHEN**:批量保存项目阶段
24
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
25
+ - **示例**:`sino-bc-cli project-stage +save --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
26
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
27
+
28
+ ## +stage-name-list
29
+
30
+ - **WHEN**:项目阶段名称列表
31
+ - **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
32
+ - **示例**:`sino-bc-cli project-stage +stage-name-list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
33
+ - **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
34
+
35
+ ## api
36
+
37
+ - **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
38
+ - **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
39
+ - **示例**:`sino-bc-cli project-stage api <name> --data '{...}'`
40
+ - **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。