@comate/zulu 1.2.1-beta.1 → 1.3.0

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 (169) hide show
  1. package/comate-engine/assets/skills/auto-commit-comate/SKILL.md +260 -0
  2. package/comate-engine/assets/skills/auto-commit-comate/references/data_structures.md +189 -0
  3. package/comate-engine/assets/skills/auto-commit-comate/references/new_version_instruction.md +209 -0
  4. package/comate-engine/assets/skills/auto-commit-comate/references/old_version_instruction.md +208 -0
  5. package/comate-engine/assets/skills/auto-commit-comate/scripts/git_diff_cli.py +196 -0
  6. package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/git_utils.py +20 -10
  7. package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/icafe/client.py +69 -40
  8. package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/icafe/farseer.py +8 -9
  9. package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/icafe/matching.py +65 -9
  10. package/comate-engine/assets/skills/auto-commit-comate/scripts/match_card_cli.py +37 -0
  11. package/comate-engine/assets/skills/cnap-comate/SKILL.md +157 -0
  12. package/comate-engine/assets/skills/cnap-comate/references/cases.md +198 -0
  13. package/comate-engine/assets/skills/cnap-comate/references/deploy-troubleshoot.md +15 -0
  14. package/comate-engine/assets/skills/cnap-comate/references/install.md +43 -0
  15. package/comate-engine/assets/skills/cnap-comate/references/kubectl.md +55 -0
  16. package/comate-engine/assets/skills/cnap-comate/references/login.md +125 -0
  17. package/comate-engine/assets/skills/cnap-comate/references/oncall.md +24 -0
  18. package/comate-engine/assets/skills/cnap-comate/scripts/install_cnap_cli.sh +36 -0
  19. package/comate-engine/assets/skills/code-security/SKILL.md +176 -0
  20. package/comate-engine/assets/skills/code-security/references/credential_hosting.md +102 -0
  21. package/comate-engine/assets/skills/code-security/references/vul_repair_sensitive.md +219 -0
  22. package/comate-engine/assets/skills/code-security/scripts/build_repair_info.py +0 -0
  23. package/comate-engine/assets/skills/code-security/scripts/credential_hosting.py +99 -0
  24. package/comate-engine/assets/skills/code-security/scripts/credential_poll.py +350 -0
  25. package/comate-engine/assets/skills/code-security/scripts/http_client.py +173 -0
  26. package/comate-engine/assets/skills/code-security/scripts/parse_scan_result.py +301 -0
  27. package/comate-engine/assets/skills/code-security/scripts/repair_vulnerability.py +261 -0
  28. package/comate-engine/assets/skills/code-security/scripts/report_chat.py +198 -0
  29. package/comate-engine/assets/skills/code-security/scripts/scan_vulnerability.py +316 -0
  30. package/comate-engine/assets/skills/code-security-comate/SKILL.md +219 -0
  31. package/comate-engine/assets/skills/code-security-comate/references/credential_hosting.md +102 -0
  32. package/comate-engine/assets/skills/code-security-comate/references/vul_repair-go_sql_injection.md +399 -0
  33. package/comate-engine/assets/skills/code-security-comate/references/vul_repair-java_sql_injection.md +591 -0
  34. package/comate-engine/assets/skills/code-security-comate/references/vul_repair-php_sql_injection.md +318 -0
  35. package/comate-engine/assets/skills/code-security-comate/references/vul_repair-python_sql_injection.md +198 -0
  36. package/comate-engine/assets/skills/code-security-comate/references/vul_repair_sensitive.md +219 -0
  37. package/comate-engine/assets/skills/code-security-comate/scripts/credential_hosting.py +87 -0
  38. package/comate-engine/assets/skills/code-security-comate/scripts/credential_poll.py +345 -0
  39. package/comate-engine/assets/skills/code-security-comate/scripts/http_client.py +173 -0
  40. package/comate-engine/assets/skills/code-security-comate/scripts/parse_scan_result.py +392 -0
  41. package/comate-engine/assets/skills/code-security-comate/scripts/repair_vulnerability.py +245 -0
  42. package/comate-engine/assets/skills/code-security-comate/scripts/report_chat.py +145 -0
  43. package/comate-engine/assets/skills/code-security-comate/scripts/scan_vulnerability.py +444 -0
  44. package/comate-engine/assets/skills/code-security-comate/scripts/utils.py +153 -0
  45. package/comate-engine/assets/skills/comate-docs-comate/SKILL.md +148 -0
  46. package/comate-engine/assets/skills/comate-docs-comate/references/doc-map-extended.md +78 -0
  47. package/comate-engine/assets/skills/comate-docs-comate/references/models-and-billing.md +51 -0
  48. package/comate-engine/assets/skills/comate-docs-comate/references/product-overview.md +73 -0
  49. package/comate-engine/assets/skills/comate-docs-comate/references/query_content.md +83 -0
  50. package/comate-engine/assets/skills/comate-docs-comate/references/query_repo.md +57 -0
  51. package/comate-engine/assets/skills/comate-docs-comate/scripts/ku_operator.py +1575 -0
  52. package/comate-engine/assets/skills/create-image-comate/SKILL.md +278 -0
  53. package/comate-engine/assets/skills/create-skill-comate/SKILL.md +308 -217
  54. package/comate-engine/assets/skills/create-skill-comate/agents/analyzer.md +274 -0
  55. package/comate-engine/assets/skills/create-skill-comate/agents/comparator.md +202 -0
  56. package/comate-engine/assets/skills/create-skill-comate/agents/grader.md +223 -0
  57. package/comate-engine/assets/skills/create-skill-comate/assets/eval_review.html +146 -0
  58. package/comate-engine/assets/skills/create-skill-comate/eval-viewer/generate_review.py +489 -0
  59. package/comate-engine/assets/skills/create-skill-comate/eval-viewer/viewer.html +1325 -0
  60. package/comate-engine/assets/skills/create-skill-comate/references/schemas.md +430 -0
  61. package/comate-engine/assets/skills/create-skill-comate/scripts/__init__.py +0 -0
  62. package/comate-engine/assets/skills/create-skill-comate/scripts/__pycache__/__init__.cpython-311.pyc +0 -0
  63. package/comate-engine/assets/skills/create-skill-comate/scripts/__pycache__/aggregate_benchmark.cpython-311.pyc +0 -0
  64. package/comate-engine/assets/skills/create-skill-comate/scripts/aggregate_benchmark.py +412 -0
  65. package/comate-engine/assets/skills/create-skill-comate/scripts/generate_report.py +334 -0
  66. package/comate-engine/assets/skills/create-skill-comate/scripts/package_skill.py +140 -0
  67. package/comate-engine/assets/skills/create-skill-comate/scripts/utils.py +53 -0
  68. package/comate-engine/assets/skills/find-skills-comate/SKILL.md +15 -12
  69. package/comate-engine/assets/skills/find-skills-comate/scripts/fetch_skills.py +32 -3
  70. package/comate-engine/assets/skills/get-ugate-token-comate/SKILL.md +159 -0
  71. package/comate-engine/assets/skills/get-ugate-token-comate/getUgateToken.py +150 -0
  72. package/comate-engine/assets/skills/icafe-comate/SKILL.md +240 -0
  73. package/comate-engine/assets/skills/icafe-comate/references/ai-workflows.md +233 -0
  74. package/comate-engine/assets/skills/icafe-comate/references/commands.md +1147 -0
  75. package/comate-engine/assets/skills/icafe-comate/references/error-handling.md +164 -0
  76. package/comate-engine/assets/skills/icafe-comate/references/git-auto-bindcard-workflow.md +201 -0
  77. package/comate-engine/assets/skills/icafe-comate/references/git-bindcard-workflow.md +327 -0
  78. package/comate-engine/assets/skills/icafe-comate/references/iql-syntax.md +327 -0
  79. package/comate-engine/assets/skills/icafe-comate/references/platform-concepts.md +317 -0
  80. package/comate-engine/assets/skills/icafe-comate/references/smart-create-workflow.md +171 -0
  81. package/comate-engine/assets/skills/icafe-comate/references/smart-find-workflow.md +127 -0
  82. package/comate-engine/assets/skills/icafe-comate/references/smart-update-workflow.md +118 -0
  83. package/comate-engine/assets/skills/icode-comate/SKILL.md +366 -0
  84. package/comate-engine/assets/skills/icode-comate/references/api/add_reviewers.md +44 -0
  85. package/comate-engine/assets/skills/icode-comate/references/api/build_fetch_command.md +89 -0
  86. package/comate-engine/assets/skills/icode-comate/references/api/check_repo_permission.md +89 -0
  87. package/comate-engine/assets/skills/icode-comate/references/api/create_branch.md +79 -0
  88. package/comate-engine/assets/skills/icode-comate/references/api/create_draft_comment.md +109 -0
  89. package/comate-engine/assets/skills/icode-comate/references/api/get_ai_cr_result.md +190 -0
  90. package/comate-engine/assets/skills/icode-comate/references/api/get_ai_review.md +97 -0
  91. package/comate-engine/assets/skills/icode-comate/references/api/get_diff_content.md +92 -0
  92. package/comate-engine/assets/skills/icode-comate/references/api/get_diff_file.md +88 -0
  93. package/comate-engine/assets/skills/icode-comate/references/api/get_machine_check.md +73 -0
  94. package/comate-engine/assets/skills/icode-comate/references/api/get_my_reviews.md +115 -0
  95. package/comate-engine/assets/skills/icode-comate/references/api/get_person_commit.md +89 -0
  96. package/comate-engine/assets/skills/icode-comate/references/api/get_person_repo.md +63 -0
  97. package/comate-engine/assets/skills/icode-comate/references/api/get_repo_branch.md +62 -0
  98. package/comate-engine/assets/skills/icode-comate/references/api/get_repo_config.md +91 -0
  99. package/comate-engine/assets/skills/icode-comate/references/api/get_repo_members.md +118 -0
  100. package/comate-engine/assets/skills/icode-comate/references/api/get_repo_reviews.md +91 -0
  101. package/comate-engine/assets/skills/icode-comate/references/api/get_review_comments.md +87 -0
  102. package/comate-engine/assets/skills/icode-comate/references/api/get_review_info.md +81 -0
  103. package/comate-engine/assets/skills/icode-comate/references/api/get_submit_settings.md +105 -0
  104. package/comate-engine/assets/skills/icode-comate/references/api/icode-api.md +86 -0
  105. package/comate-engine/assets/skills/icode-comate/references/api/publish_comments.md +72 -0
  106. package/comate-engine/assets/skills/icode-comate/references/api/set_review_score.md +58 -0
  107. package/comate-engine/assets/skills/icode-comate/references/api/start_ai_review.md +77 -0
  108. package/comate-engine/assets/skills/icode-comate/references/api/submit_review.md +50 -0
  109. package/comate-engine/assets/skills/icode-comate/references/api/trigger_ai_cr.md +63 -0
  110. package/comate-engine/assets/skills/icode-comate/references/feature/add-reviewer.md +92 -0
  111. package/comate-engine/assets/skills/icode-comate/references/feature/fix-machine-check.md +144 -0
  112. package/comate-engine/assets/skills/icode-comate/references/feature/merge-cr.md +100 -0
  113. package/comate-engine/assets/skills/icode-comate/references/feature/ssh-setup.md +106 -0
  114. package/comate-engine/assets/skills/icode-comate/references/feature/submit-acr.md +135 -0
  115. package/comate-engine/assets/skills/icode-comate/references/feature/submit-cr.md +123 -0
  116. package/comate-engine/assets/skills/icode-comate/references/git/clone.md +67 -0
  117. package/comate-engine/assets/skills/icode-comate/references/git/icode-git.md +68 -0
  118. package/comate-engine/assets/skills/icode-comate/references/git/push.md +64 -0
  119. package/comate-engine/assets/skills/icode-comate/references/git/push_cr.md +103 -0
  120. package/comate-engine/assets/skills/icode-comate/references/install.md +144 -0
  121. package/comate-engine/assets/skills/icode-comate/references/login.md +111 -0
  122. package/comate-engine/assets/skills/icode-comate/scripts/add-reviewer.sh +154 -0
  123. package/comate-engine/assets/skills/icode-comate/scripts/common.sh +145 -0
  124. package/comate-engine/assets/skills/icode-comate/scripts/fix-machine-check.sh +131 -0
  125. package/comate-engine/assets/skills/icode-comate/scripts/merge-cr.sh +105 -0
  126. package/comate-engine/assets/skills/icode-comate/scripts/ssh-setup.sh +159 -0
  127. package/comate-engine/assets/skills/icode-comate/scripts/submit-acr.sh +236 -0
  128. package/comate-engine/assets/skills/icode-comate/scripts/submit-cr.sh +104 -0
  129. package/comate-engine/assets/skills/icode-comate/scripts/test-preflight.sh +89 -0
  130. package/comate-engine/assets/skills/ku-operator-comate/SKILL.md +121 -0
  131. package/comate-engine/assets/skills/ku-operator-comate/examples.md +190 -0
  132. package/comate-engine/assets/skills/ku-operator-comate/references/add_member.md +49 -0
  133. package/comate-engine/assets/skills/ku-operator-comate/references/change_scope.md +38 -0
  134. package/comate-engine/assets/skills/ku-operator-comate/references/copy_doc.md +50 -0
  135. package/comate-engine/assets/skills/ku-operator-comate/references/create_doc.md +61 -0
  136. package/comate-engine/assets/skills/ku-operator-comate/references/delete_doc.md +31 -0
  137. package/comate-engine/assets/skills/ku-operator-comate/references/edit_content.md +568 -0
  138. package/comate-engine/assets/skills/ku-operator-comate/references/move_doc.md +45 -0
  139. package/comate-engine/assets/skills/ku-operator-comate/references/query_comment.md +79 -0
  140. package/comate-engine/assets/skills/ku-operator-comate/references/query_content.md +83 -0
  141. package/comate-engine/assets/skills/ku-operator-comate/references/query_flowchart.md +84 -0
  142. package/comate-engine/assets/skills/ku-operator-comate/references/query_permission.md +38 -0
  143. package/comate-engine/assets/skills/ku-operator-comate/references/query_recent_view.md +67 -0
  144. package/comate-engine/assets/skills/ku-operator-comate/references/query_repo.md +57 -0
  145. package/comate-engine/assets/skills/ku-operator-comate/references/query_user_info.md +37 -0
  146. package/comate-engine/assets/skills/ku-operator-comate/references/update_member.md +41 -0
  147. package/comate-engine/assets/skills/ku-operator-comate/references/upload_attachment.md +52 -0
  148. package/comate-engine/assets/skills/ku-operator-comate/scripts/ku_operator.py +1575 -0
  149. package/comate-engine/node_modules/better-sqlite3/node_modules/.bin/prebuild-install +2 -2
  150. package/comate-engine/node_modules/tree-sitter-bash/node_modules/.bin/node-gyp-build +2 -2
  151. package/comate-engine/node_modules/tree-sitter-bash/node_modules/.bin/node-gyp-build-optional +2 -2
  152. package/comate-engine/node_modules/tree-sitter-bash/node_modules/.bin/node-gyp-build-test +2 -2
  153. package/comate-engine/package.json +2 -0
  154. package/comate-engine/server.js +263 -79
  155. package/dist/bundle/index.js +8 -8
  156. package/package.json +1 -1
  157. package/comate-engine/assets/skills/figma2code-comate/codeConnect.md +0 -37
  158. package/comate-engine/assets/skills/figma2code-comate/designToken.md +0 -3
  159. package/comate-engine/assets/skills/figma2code-comate/f2cMcp.md +0 -59
  160. package/comate-engine/assets/skills/smart-commit/SKILL.md +0 -646
  161. package/comate-engine/node_modules/@comate/plugin-host/dist/index-AZIho4HV.js +0 -1
  162. package/comate-engine/node_modules/@comate/plugin-host/dist/user-BIpzRUfb.js +0 -44
  163. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/references/issue_type_mapping.json +0 -0
  164. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/references/query_reference.md +0 -0
  165. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/compat.py +0 -0
  166. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/create_card_cli.py +0 -0
  167. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/icafe/__init__.py +0 -0
  168. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/logger.py +0 -0
  169. /package/comate-engine/assets/skills/{smart-commit → auto-commit-comate}/scripts/recognize_card_cli.py +0 -0
@@ -0,0 +1,83 @@
1
+ # query-content — 查询文档内容
2
+
3
+ 查询知识库文档内容,自动转换为 Markdown 格式输出,并可自动下载文档中引用的图片和附件。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ python3 scripts/ku_operator.py query-content --doc-id <文档ID>
9
+ python3 scripts/ku_operator.py query-content --url <文档URL>
10
+
11
+ # 禁用自动下载资源
12
+ python3 scripts/ku_operator.py query-content --doc-id <文档ID> --no-download-assets
13
+
14
+ # 指定资源保存目录
15
+ python3 scripts/ku_operator.py query-content --doc-id <文档ID> --save-assets-dir ./my_assets
16
+
17
+ # 输出原始 JSON(含 blockId,用于 edit-content 操作)
18
+ python3 scripts/ku_operator.py query-content --doc-id <文档ID> --raw-json
19
+ ```
20
+
21
+ ## 参数表
22
+
23
+ | 参数 | 必填 | 说明 |
24
+ |------|------|------|
25
+ | `--doc-id` | 与 `--url` 二选一 | 文档 ID |
26
+ | `--url` | 与 `--doc-id` 二选一 | 文档 URL |
27
+ | `--save-assets-dir` | 否 | 图片/附件保存目录,默认 `./ku_assets` |
28
+ | `--no-download-assets` | 否 | 禁用自动下载图片/附件(默认会自动下载) |
29
+ | `--raw-json` | 否 | 输出原始 JSON block 结构(含 blockId),不转换为 Markdown |
30
+
31
+ ## 输出说明
32
+
33
+ ### 默认模式(Markdown 输出)
34
+
35
+ - 直接输出 **Markdown 格式** 的文档内容(通过内部 jsonToMd 服务自动转换),可直接阅读
36
+ - **自动资源下载**:脚本会自动提取 Markdown 中的远程图片和附件 URL,下载到本地 `{save-assets-dir}/{doc_id}/` 目录,并将 Markdown 中的远程 URL 替换为本地路径。下载摘要会输出到 stderr
37
+
38
+ > **重要**:读取文档后,请关注 stderr 中输出的资源下载摘要。如果文档包含图片,这些图片已下载到本地,在分析文档时应结合图片内容(使用 Read 工具读取图片文件)进行理解,不要忽略图片中的信息。
39
+
40
+ ### --raw-json 模式
41
+
42
+ - 输出文档内容的 **原始 JSON block 数组**,每个 block 包含 `blockId`、`type` 等完整字段
43
+ - 不经过 jsonToMd 转换,不下载资源
44
+ - 主要用于获取 `blockId` 以配合 `edit-content` 命令进行精确编辑(如表格替换、定点插入/删除)
45
+
46
+ 输出格式示例:
47
+
48
+ ```json
49
+ [
50
+ {
51
+ "type": "heading",
52
+ "level": 2,
53
+ "blockId": "docyg-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
54
+ "children": [{"text": "标题内容"}]
55
+ },
56
+ {
57
+ "type": "paragraph",
58
+ "blockId": "docyg-yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
59
+ "children": [{"text": "段落内容"}]
60
+ },
61
+ {
62
+ "type": "table",
63
+ "blockId": "docyg-zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz",
64
+ "data": {"headless": true, "width": [150, 150]},
65
+ "children": [...]
66
+ }
67
+ ]
68
+ ```
69
+
70
+ ## 使用示例
71
+
72
+ ### 通过 doc-id 查询
73
+
74
+ ```bash
75
+ python3 scripts/ku_operator.py query-content --doc-id OQAehZAod_HVHC
76
+ ```
77
+
78
+ ### 通过完整 URL 查询
79
+
80
+ ```bash
81
+ python3 scripts/ku_operator.py query-content \
82
+ --url "https://ku.baidu-int.com/knowledge/HFVrC2hT9H/pKzYIZbmZx/B8wSneaLSC/OQAehZAod_HVHC"
83
+ ```
@@ -0,0 +1,84 @@
1
+ # query-flowchart — 查询流程图
2
+
3
+ 查询文档中嵌入的流程图数据。支持自动发现文档中的所有流程图,无需提前知道流程图 ID。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ # 自动发现文档中所有流程图并查询(推荐)
9
+ python3 scripts/ku_operator.py query-flowchart --doc-id <文档ID>
10
+
11
+ # 指定流程图 ID 查询
12
+ python3 scripts/ku_operator.py query-flowchart --doc-id <文档ID> --flowchart-id <流程图ID>
13
+
14
+ # 保存到文件
15
+ python3 scripts/ku_operator.py query-flowchart --doc-id <文档ID> --output out.xml
16
+ ```
17
+
18
+ ## 参数表
19
+
20
+ | 参数 | 必填 | 说明 |
21
+ |------|------|------|
22
+ | `--doc-id` | 是 | 文档 ID |
23
+ | `--flowchart-id` | 否 | 流程图 ID。不传时自动调用 queryContent 从文档正文中发现所有 `type=diagram` 的节点并逐一查询 |
24
+ | `--output` | 否 | 输出文件路径。多个流程图时自动添加序号后缀(如 `out_1.xml`、`out_2.xml`) |
25
+
26
+ ## 自动发现机制
27
+
28
+ 当 `--flowchart-id` 未指定时,脚本会:
29
+
30
+ 1. 调用 `queryContent` API 获取文档正文的 block 列表
31
+ 2. 筛选 `type=diagram` 的 block,提取其 `id` 字段作为流程图 ID
32
+ 3. 逐一调用 `queryFlowchart` API 查询每个流程图的数据
33
+ 4. 输出 agent 友好的结构化结果
34
+
35
+ ## 输出说明
36
+
37
+ 输出包含以下信息:
38
+
39
+ - **流程图元信息**:文档 ID、流程图 ID、格式
40
+ - **节点列表**:每个节点的 ID、形状类型(菱形=判断、矩形=处理、椭圆=开始/结束等)、文字内容
41
+ - **连线列表**:每条连线的源节点、目标节点、标签
42
+ - **原始 XML**:mxGraph 格式的完整流程图数据
43
+
44
+ ## 使用示例
45
+
46
+ ### 自动发现并查询所有流程图(推荐)
47
+
48
+ ```bash
49
+ python3 scripts/ku_operator.py query-flowchart \
50
+ --doc-id D5JiZRULjdEJHR
51
+ ```
52
+
53
+ 输出示例:
54
+ ```
55
+ ## 流程图 #1
56
+ - 文档 ID: D5JiZRULjdEJHR
57
+ - 流程图 ID: 5282101654e6424c9c6d8e483c856afc
58
+ - 格式: mxGraph XML
59
+
60
+ ### 节点 (2 个)
61
+ - [2] diamond (判断): 条件判断
62
+ - [3] process (处理): 执行任务
63
+ ### 连线 (1 个)
64
+ - [4] 2 → 3 (是)
65
+
66
+ ### 原始 XML
67
+ ...
68
+ ```
69
+
70
+ ### 指定流程图 ID 查询
71
+
72
+ ```bash
73
+ python3 scripts/ku_operator.py query-flowchart \
74
+ --doc-id D5JiZRULjdEJHR \
75
+ --flowchart-id 5282101654e6424c9c6d8e483c856afc
76
+ ```
77
+
78
+ ### 保存到文件
79
+
80
+ ```bash
81
+ python3 scripts/ku_operator.py query-flowchart \
82
+ --doc-id D5JiZRULjdEJHR \
83
+ --output flowchart.xml
84
+ ```
@@ -0,0 +1,38 @@
1
+ # query-permission — 查询文档权限
2
+
3
+ 查询指定用户对某文档的权限信息。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ python3 scripts/ku_operator.py query-permission --doc-id <文档ID> --usernames <用户名列表>
9
+ ```
10
+
11
+ ## 参数表
12
+
13
+ | 参数 | 必填 | 说明 |
14
+ |------|------|------|
15
+ | `--doc-id` | 是 | 文档 ID |
16
+ | `--usernames` | 是 | 用户名,多个用逗号分隔(如 `user1,user2`) |
17
+
18
+ ## 输出说明
19
+
20
+ 返回 JSON 格式结果,包含每个用户对该文档的权限角色信息。
21
+
22
+ ## 使用示例
23
+
24
+ ### 查询单个用户权限
25
+
26
+ ```bash
27
+ python3 scripts/ku_operator.py query-permission \
28
+ --doc-id OQAehZAod_HVHC \
29
+ --usernames zhangsan
30
+ ```
31
+
32
+ ### 查询多个用户权限
33
+
34
+ ```bash
35
+ python3 scripts/ku_operator.py query-permission \
36
+ --doc-id OQAehZAod_HVHC \
37
+ --usernames zhangsan,lisi,wangwu
38
+ ```
@@ -0,0 +1,67 @@
1
+ # query-recent-view — 查询文档浏览记录
2
+
3
+ 查询指定文档的最近浏览记录,输出格式化文本。可按时间范围过滤,支持分页。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ python3 scripts/ku_operator.py query-recent-view --doc-id <文档ID> [--begin-time TIME] [--end-time TIME] [--page N] [--page-size N] [--raw-json]
9
+ ```
10
+
11
+ ## 参数表
12
+
13
+ | 参数 | 必填 | 说明 |
14
+ |------|------|------|
15
+ | `--doc-id` | 是 | 文档 ID |
16
+ | `--begin-time` | 否 | 起始时间,支持格式:`YYYY-MM-DD`、`YYYY-MM-DD HH:MM`、`YYYY-MM-DD HH:MM:SS` |
17
+ | `--end-time` | 否 | 结束时间,格式同上 |
18
+ | `--page` | 否 | 页码,默认 1 |
19
+ | `--page-size` | 否 | 每页条数,默认 100 |
20
+ | `--raw-json` | 否 | 输出原始 JSON(不做格式化) |
21
+
22
+ ## 输出说明
23
+
24
+ 默认输出格式化文本,包含浏览统计和记录列表:
25
+
26
+ ```
27
+ 文档 D5JiZRULjdEJHR 浏览记录(共 24 次,3 位访客)
28
+
29
+ - 王哲 (wangzhe12) · 2026-03-20 18:00
30
+ - 张三 (zhangsan) · 2026-03-20 17:30
31
+ - 李四 (lisi) · 2026-03-20 16:00
32
+ ```
33
+
34
+ 传 `--raw-json` 时输出原始 API 响应 JSON。
35
+
36
+ ## 使用示例
37
+
38
+ ### 查询最近浏览
39
+
40
+ ```bash
41
+ python3 scripts/ku_operator.py query-recent-view \
42
+ --doc-id D5JiZRULjdEJHR
43
+ ```
44
+
45
+ ### 按时间范围查询
46
+
47
+ ```bash
48
+ python3 scripts/ku_operator.py query-recent-view \
49
+ --doc-id D5JiZRULjdEJHR \
50
+ --begin-time "2026-03-20" \
51
+ --end-time "2026-03-21"
52
+ ```
53
+
54
+ ```bash
55
+ python3 scripts/ku_operator.py query-recent-view \
56
+ --doc-id D5JiZRULjdEJHR \
57
+ --begin-time "2026-03-20 09:00" \
58
+ --end-time "2026-03-20 18:00"
59
+ ```
60
+
61
+ ### 输出原始 JSON
62
+
63
+ ```bash
64
+ python3 scripts/ku_operator.py query-recent-view \
65
+ --doc-id D5JiZRULjdEJHR \
66
+ --raw-json
67
+ ```
@@ -0,0 +1,57 @@
1
+ # query-repo — 查询知识库目录
2
+
3
+ 查询知识库的目录结构,以文本树形格式输出,支持分页。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ # 查询根目录(默认行为)
9
+ python3 scripts/ku_operator.py query-repo --repo-guid <知识库ID>
10
+
11
+ # 查询某个目录下的直接子文档
12
+ python3 scripts/ku_operator.py query-repo --repo-guid <知识库ID> --parent-doc-guid <父文档ID>
13
+
14
+ # 大目录翻页
15
+ python3 scripts/ku_operator.py query-repo --repo-guid <知识库ID> --page 2
16
+ ```
17
+
18
+ ## 参数表
19
+
20
+ | 参数 | 必填 | 说明 |
21
+ |------|------|------|
22
+ | `--repo-guid` | 是 | 知识库 ID |
23
+ | `--parent-doc-guid` | 否 | 父文档 ID,不传则默认查询**根目录**下的直接子文档 |
24
+ | `--page` | 否 | 页码,默认 1(每页固定 100 条) |
25
+
26
+ ## 输出说明
27
+
28
+ 以文本树形格式输出,示例:
29
+
30
+ ```
31
+ 知识库 Xw0t0FBvVy 根目录(共 3 项):
32
+
33
+ 📄 欢迎使用 (GgD6PTVjSmZEC3)
34
+ 📁 浏览器相关 (gsrJkBZ6XlyGRl) [2 子文档]
35
+ 📄 接口说明 (vtUh01DEnyYDA6)
36
+ ```
37
+
38
+ - `📁` 表示有子文档(可通过其 docGuid 作为 `--parent-doc-guid` 进一步展开查看)
39
+ - `📄` 表示叶子文档
40
+ - 括号内为 `docGuid`,可直接用于后续的 `query-content`、`create-doc`、`move-doc` 等操作
41
+ - 当目录内容超过一页时,末尾会提示使用 `--page` 翻页
42
+
43
+ ## 使用示例
44
+
45
+ ### 查询根目录
46
+
47
+ ```bash
48
+ python3 scripts/ku_operator.py query-repo --repo-guid Xw0t0FBvVy
49
+ ```
50
+
51
+ ### 展开子目录
52
+
53
+ ```bash
54
+ python3 scripts/ku_operator.py query-repo \
55
+ --repo-guid Xw0t0FBvVy \
56
+ --parent-doc-guid gsrJkBZ6XlyGRl
57
+ ```
@@ -0,0 +1,37 @@
1
+ # query-user-info — 查询当前用户信息
2
+
3
+ 查询当前登录用户的知识库信息,包括个人知识库 ID 和 URL。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ python3 scripts/ku_operator.py query-user-info
9
+ ```
10
+
11
+ ## 参数表
12
+
13
+ 无需任何参数,用户名自动从环境变量 `COMATE_USERNAME` 读取。
14
+
15
+ ## 输出说明
16
+
17
+ 以 JSON 格式输出当前用户的关键信息,示例:
18
+
19
+ ```json
20
+ {
21
+ "username": "wangzhe12",
22
+ "nickname": "王哲",
23
+ "email": "wangzhe12@baidu.com",
24
+ "personalRepoGuid": "yxin2LKp-R",
25
+ "personalRepoUrl": "https://ku.baidu-int.com/knowledge/HFVrC7hq1Q/pKzJfZczuc/yxin2LKp-R"
26
+ }
27
+ ```
28
+
29
+ 返回结果关键字段:
30
+ - `personalRepoGuid` — 个人知识库 ID,可直接用于 `--repo-guid` 参数
31
+ - `personalRepoUrl` — 个人知识库 URL
32
+
33
+ ## 使用示例
34
+
35
+ ```bash
36
+ python3 scripts/ku_operator.py query-user-info
37
+ ```
@@ -0,0 +1,41 @@
1
+ # update-member — 更新文档成员角色
2
+
3
+ 更新文档中已有成员的角色。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ python3 scripts/ku_operator.py update-member --doc-id <文档ID> --username <用户名> --role <新角色>
9
+ ```
10
+
11
+ ## 参数表
12
+
13
+ | 参数 | 必填 | 说明 |
14
+ |------|------|------|
15
+ | `--doc-id` | 是 | 文档 ID |
16
+ | `--username` | 是 | 用户名(单个) |
17
+ | `--role` | 是 | 新角色,可选 `DocReader` / `DocEditor`(或 `DocMember`) / `DocAdmin`。`DocEditor` 会自动映射为 API 实际值 `DocMember` |
18
+
19
+ ## 输出说明
20
+
21
+ 返回 JSON 格式结果,操作成功时返回 JSON 中不包含 `error` 字段。
22
+
23
+ ## 使用示例
24
+
25
+ ### 将成员升级为编辑者
26
+
27
+ ```bash
28
+ python3 scripts/ku_operator.py update-member \
29
+ --doc-id OQAehZAod_HVHC \
30
+ --username zhangsan \
31
+ --role DocEditor
32
+ ```
33
+
34
+ ### 将成员降级为只读
35
+
36
+ ```bash
37
+ python3 scripts/ku_operator.py update-member \
38
+ --doc-id OQAehZAod_HVHC \
39
+ --username zhangsan \
40
+ --role DocReader
41
+ ```
@@ -0,0 +1,52 @@
1
+ # upload-attachment — 上传附件并插入文档正文
2
+
3
+ 上传本地文件作为附件到指定文档,默认自动插入文档正文。使用 multipart/form-data 方式上传,超时时间 120 秒。
4
+
5
+ ## CLI 用法
6
+
7
+ ```bash
8
+ python3 scripts/ku_operator.py upload-attachment --doc-id <文档ID> --file <本地文件路径> [--no-insert] [--view-type attachment|preview]
9
+ ```
10
+
11
+ ## 参数表
12
+
13
+ | 参数 | 必填 | 说明 |
14
+ |------|------|------|
15
+ | `--doc-id` | 是 | 文档 ID |
16
+ | `--file` | 是 | 本地文件路径 |
17
+ | `--no-insert` | 否 | 只上传不插入正文 |
18
+ | `--view-type` | 否 | 显示方式:`attachment`=附件卡片(默认), `preview`=内嵌预览 |
19
+
20
+ ## 输出说明
21
+
22
+ 返回 JSON 格式结果,包含上传成功后的附件信息(attachId、name、extension、size 等)。上传成功后默认自动调用 edit-content 将附件 block 插入文档末尾。
23
+
24
+ > 上传超时时间为 120 秒,适合大文件上传。
25
+
26
+ ## 使用示例
27
+
28
+ ### 上传 PDF 并自动插入正文
29
+
30
+ ```bash
31
+ python3 scripts/ku_operator.py upload-attachment \
32
+ --doc-id OQAehZAod_HVHC \
33
+ --file ./report.pdf
34
+ ```
35
+
36
+ ### 只上传不插入正文
37
+
38
+ ```bash
39
+ python3 scripts/ku_operator.py upload-attachment \
40
+ --doc-id OQAehZAod_HVHC \
41
+ --file ./data.xlsx \
42
+ --no-insert
43
+ ```
44
+
45
+ ### 以内嵌预览方式插入
46
+
47
+ ```bash
48
+ python3 scripts/ku_operator.py upload-attachment \
49
+ --doc-id OQAehZAod_HVHC \
50
+ --file ./screenshot.png \
51
+ --view-type preview
52
+ ```