@sanqianx/project-knowledge 5.0.19 → 5.0.20

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 (200) hide show
  1. package/.agents/plugins/marketplace.json +3 -3
  2. package/.claude-plugin/marketplace.json +1 -1
  3. package/CHANGELOG.md +5 -0
  4. package/LICENSE +201 -201
  5. package/NOTICE +5 -5
  6. package/README.md +349 -349
  7. package/_modules/knowledge-engine/README.md +4 -0
  8. package/_modules/knowledge-engine/src/analysis-failures.js +39 -0
  9. package/_modules/knowledge-engine/src/analysis-worker.js +6 -2
  10. package/_modules/knowledge-engine/src/coordinator.js +7 -0
  11. package/_modules/knowledge-engine/src/headless-analyzer.js +2 -1
  12. package/_modules/knowledge-engine/src/server.js +1 -1
  13. package/_site/_test/agent-capture-mcp-ui-test.js +67 -67
  14. package/_site/_test/ai-profile-test.js +75 -75
  15. package/_site/_test/ai-vendor-presets-test.js +91 -91
  16. package/_site/_test/automatic-context-test.js +70 -70
  17. package/_site/_test/bin-cli-test.js +230 -230
  18. package/_site/_test/bridge-adapter-test.js +95 -95
  19. package/_site/_test/bridge-consumer-service-test.js +310 -310
  20. package/_site/_test/candidate-bin-content-test.js +35 -35
  21. package/_site/_test/candidate-product-assets-test.js +13 -13
  22. package/_site/_test/candidate-release-contract-test.js +14 -14
  23. package/_site/_test/capture-hook-dedup-test.js +158 -158
  24. package/_site/_test/claude-executable-discovery-test.js +28 -28
  25. package/_site/_test/claude-session-lifecycle-sweep-test.js +252 -252
  26. package/_site/_test/cli-instance-management-test.js +62 -62
  27. package/_site/_test/client-capture-restart-e2e-test.js +189 -189
  28. package/_site/_test/codex-conversation-projection-test.js +60 -60
  29. package/_site/_test/codex-marketplace-scoped-path-test.js +186 -186
  30. package/_site/_test/codex-notify-capture-e2e-test.js +101 -101
  31. package/_site/_test/codex-notify-fanout-test.js +134 -134
  32. package/_site/_test/codex-notify-upgrade-test.js +253 -253
  33. package/_site/_test/commit-boundary-freeze-test.js +147 -147
  34. package/_site/_test/commit-conversation-binding-test.js +4 -4
  35. package/_site/_test/configuration-generation-test.js +22 -22
  36. package/_site/_test/context-pack-test.js +200 -200
  37. package/_site/_test/conversation-api-test.js +10 -10
  38. package/_site/_test/conversation-origin-test.js +15 -15
  39. package/_site/_test/cross-repo-isolation-e2e-test.js +187 -187
  40. package/_site/_test/embedding-config-test.js +32 -32
  41. package/_site/_test/fixtures/fake-browser-exit.js +10 -10
  42. package/_site/_test/fixtures/fake-browser-hang.js +10 -10
  43. package/_site/_test/fixtures/integration-busy-worker.cjs +6 -6
  44. package/_site/_test/fixtures/make-git-repos.js +92 -92
  45. package/_site/_test/fixtures/retrieval-gold-queries.json +32 -32
  46. package/_site/_test/fresh-hook-reimport-test.js +53 -53
  47. package/_site/_test/fresh-product-data-test.js +56 -56
  48. package/_site/_test/git-path-compatibility-test.js +80 -80
  49. package/_site/_test/git-validation-test.js +81 -81
  50. package/_site/_test/hook-worktree-test.js +42 -42
  51. package/_site/_test/index-builder-test.js +41 -41
  52. package/_site/_test/index-error-display-contract-test.js +10 -10
  53. package/_site/_test/integration-adapters-test.js +67 -67
  54. package/_site/_test/integration-capture-setup-test.js +118 -118
  55. package/_site/_test/integration-runtime-binding-a2-test.js +566 -566
  56. package/_site/_test/integration-runtime-binding-a3-test.js +227 -227
  57. package/_site/_test/integration-runtime-binding-test.js +473 -473
  58. package/_site/_test/integration-status-scan-test.js +29 -29
  59. package/_site/_test/kb-framework-test.js +57 -57
  60. package/_site/_test/kbpath-follow-test.js +63 -63
  61. package/_site/_test/knowledge-db-test.js +144 -144
  62. package/_site/_test/knowledge-engine-client-test.js +109 -109
  63. package/_site/_test/knowledge-maintenance-test.js +40 -40
  64. package/_site/_test/knowledge-panel-ui-contract-test.js +112 -0
  65. package/_site/_test/knowledge-scopes-test.js +37 -37
  66. package/_site/_test/knowledge-storage-location-test.js +28 -28
  67. package/_site/_test/launcher-readiness-test.js +80 -80
  68. package/_site/_test/legacy-claude-session-alias-test.js +106 -106
  69. package/_site/_test/legacy-routes-removed-test.js +47 -47
  70. package/_site/_test/legacy-workbench-exclusion-test.js +92 -92
  71. package/_site/_test/live-gateway-test.js +48 -48
  72. package/_site/_test/local-marketplace-test.js +16 -16
  73. package/_site/_test/log-redaction-test.js +58 -58
  74. package/_site/_test/markdown-maintenance-test.js +11 -11
  75. package/_site/_test/model-context-windows-test.js +89 -89
  76. package/_site/_test/module-agent-start-proxy-test.js +65 -65
  77. package/_site/_test/module-artifact-integrity-test.js +27 -27
  78. package/_site/_test/module-boundary-test.js +30 -30
  79. package/_site/_test/module-bridge-eventbridge-test.js +202 -202
  80. package/_site/_test/module-dynamic-port-test.js +118 -118
  81. package/_site/_test/module-index-proxy-test.js +33 -33
  82. package/_site/_test/module-model-configuration-test.js +44 -44
  83. package/_site/_test/module-process-lifecycle-test.js +35 -35
  84. package/_site/_test/module-stream-proxy-test.js +34 -34
  85. package/_site/_test/module-terminal-restart-test.js +63 -63
  86. package/_site/_test/module-wiring-unbind-race-test.js +59 -59
  87. package/_site/_test/native-context-integrations-test.js +86 -86
  88. package/_site/_test/orphaned-claim-recovery-test.js +80 -80
  89. package/_site/_test/package-boundary-test.js +43 -42
  90. package/_site/_test/package-startup-test.js +56 -56
  91. package/_site/_test/packaged-ui-smoke-test.js +88 -88
  92. package/_site/_test/pr-consumer-contract-test.js +55 -55
  93. package/_site/_test/product-brand-contract-test.js +25 -25
  94. package/_site/_test/product-diagnostics-ui-test.js +93 -93
  95. package/_site/_test/product-import-ui-test.js +104 -104
  96. package/_site/_test/product-progress-status-test.js +12 -1
  97. package/_site/_test/project-remove-running-guard-test.js +79 -79
  98. package/_site/_test/project-store-test.js +90 -90
  99. package/_site/_test/registry-events-test.js +38 -38
  100. package/_site/_test/release-version-sync-test.js +115 -115
  101. package/_site/_test/requirement-binding-test.js +113 -113
  102. package/_site/_test/runtime-endpoint-test.js +64 -64
  103. package/_site/_test/scanner-test.js +83 -83
  104. package/_site/_test/server-security-test.js +96 -96
  105. package/_site/_test/sessions-stream-test.js +93 -93
  106. package/_site/_test/shared-scope-root-binding-test.js +67 -67
  107. package/_site/_test/simple-import-test.js +98 -98
  108. package/_site/_test/startup-analysis-disabled-test.js +6 -6
  109. package/_site/_test/team-knowledge-store-sparse-checkout-test.js +196 -196
  110. package/_site/_test/team-knowledge-store-test.js +132 -132
  111. package/_site/_test/test-server-cleanup-test.js +35 -35
  112. package/_site/_test/test-server-module-isolation-test.js +37 -37
  113. package/_site/_test/tracking-start-test.js +35 -35
  114. package/_site/_test/workbench-context-receipts-test.js +22 -22
  115. package/_site/_test/workspace-ui-contract-test.js +31 -31
  116. package/_site/_test/zcode-capture-integration-test.js +108 -108
  117. package/_site/lib/ai-vendor-presets.js +83 -83
  118. package/_site/lib/ai-workspace.js +3 -3
  119. package/_site/lib/atomic-file.js +204 -204
  120. package/_site/lib/bridge-adapter.js +260 -260
  121. package/_site/lib/capture-hook-config.js +108 -108
  122. package/_site/lib/claude-cli-runner.js +89 -89
  123. package/_site/lib/cli-instances.js +43 -43
  124. package/_site/lib/codex-context-status.js +17 -17
  125. package/_site/lib/codex-notify-config.js +193 -193
  126. package/_site/lib/commit-conversation-binder.js +12 -12
  127. package/_site/lib/commit-reconciler.js +38 -38
  128. package/_site/lib/context-pack-builder.js +299 -299
  129. package/_site/lib/conversation-exclusions.js +204 -204
  130. package/_site/lib/conversation-query-service.js +17 -17
  131. package/_site/lib/data-dir.js +13 -13
  132. package/_site/lib/embedding-service.js +85 -85
  133. package/_site/lib/engine-connection.js +93 -93
  134. package/_site/lib/engine-knowledge-client.js +72 -72
  135. package/_site/lib/folder-picker-output.js +3 -3
  136. package/_site/lib/git-path.js +14 -14
  137. package/_site/lib/github-team-store.js +3 -3
  138. package/_site/lib/index-builder.js +157 -157
  139. package/_site/lib/integration-status-scan.js +99 -99
  140. package/_site/lib/integration-status-worker.js +14 -14
  141. package/_site/lib/kb-framework.js +15 -15
  142. package/_site/lib/knowledge-db.js +363 -363
  143. package/_site/lib/knowledge-schema.js +121 -121
  144. package/_site/lib/live-gateway.js +78 -78
  145. package/_site/lib/llm-client.js +12 -12
  146. package/_site/lib/model-context-windows.js +82 -82
  147. package/_site/lib/module-bridge.js +874 -874
  148. package/_site/lib/module-port-resolver.js +57 -57
  149. package/_site/lib/post-commit-automation.js +54 -54
  150. package/_site/lib/product-data.js +35 -35
  151. package/_site/lib/project-lifecycle-service.js +14 -14
  152. package/_site/lib/project-registry-store.js +129 -129
  153. package/_site/lib/prompt-registry.js +148 -148
  154. package/_site/lib/registry-events.js +16 -16
  155. package/_site/lib/requirement-adapters.js +10 -10
  156. package/_site/lib/requirement-binder.js +112 -112
  157. package/_site/lib/runtime-control.js +89 -89
  158. package/_site/lib/runtime-endpoint.js +5 -5
  159. package/_site/lib/zcode-context-integration.js +60 -60
  160. package/_site/scripts/codex-notify-fanout.cjs +95 -95
  161. package/_site/scripts/install-module-candidates.js +69 -69
  162. package/_site/scripts/pack-module-candidates.js +89 -89
  163. package/_site/scripts/sync-product-content.js +28 -28
  164. package/_site/scripts/sync-release-version.js +164 -164
  165. package/_site/scripts/vendor-modules.js +49 -49
  166. package/_site/scripts/verify-module-runtime.js +50 -50
  167. package/_site/scripts/verify-product-runtime.js +36 -36
  168. package/_site/scripts/verify-retrieval-gold.js +83 -83
  169. package/_site/server.js +15 -15
  170. package/_site/start.bat +26 -26
  171. package/_site/stop.bat +11 -11
  172. package/bin/project-knowledge-integrations.js +254 -254
  173. package/bin/project-knowledge-kb.js +67 -67
  174. package/bin/project-knowledge-mcp.js +8 -8
  175. package/bin/project-knowledge.js +170 -170
  176. package/claude-prompts.json +21 -21
  177. package/docs/README.zh-CN.md +205 -205
  178. package/docs/assets/architecture.svg +181 -181
  179. package/docs/assets/logo.svg +49 -49
  180. package/docs/fresh-v5-start.md +42 -42
  181. package/docs/leader-glm-workbench-playbook.md +122 -122
  182. package/docs/project-registry-schema.md +11 -11
  183. package/docs/release-5.0.16-acceptance.md +176 -176
  184. package/docs/release-5.0.17-acceptance.md +117 -117
  185. package/docs/release-5.0.19-acceptance.md +39 -25
  186. package/docs/team-knowledge-mode-a-plan.md +73 -73
  187. package/module-runtime-manifest.json +53 -33
  188. package/package.json +3 -2
  189. package/plugins/project-knowledge/.claude-plugin/plugin.json +1 -1
  190. package/plugins/project-knowledge/.codex-plugin/plugin.json +1 -1
  191. package/plugins/project-knowledge/.mcp.json +1 -1
  192. package/plugins/project-knowledge/opencode/project-knowledge.md +3 -3
  193. package/plugins/project-knowledge/skills/project-knowledge/SKILL.md +28 -28
  194. package/templates/change.md +30 -30
  195. package/templates/project-readme.md +18 -18
  196. package/ui/index.html +1 -1
  197. package/ui/knowledge-panel.html +118 -0
  198. package/ui/product.css +8 -0
  199. package/ui/product.js +146 -4
  200. package/vendor-manifest.json +55 -54
@@ -1,254 +1,254 @@
1
- #!/usr/bin/env node
2
-
3
- const {
4
- IntegrationManager,
5
- SUPPORTED_CLIENTS,
6
- normalizeClient,
7
- } = require('../_site/lib/integration-installer');
8
- const { Logger } = require('../_site/lib/structured-logger');
9
- const { createId } = require('../_site/lib/contracts');
10
-
11
- function printHelp() {
12
- console.log(`project-knowledge-integrations
13
-
14
- Install Project Knowledge for coding agents: Knowledge Integration (MCP +
15
- Skill / plugin) and Development Capture (Bridge hooks / notify / plugin).
16
-
17
- Usage:
18
- project-knowledge-integrations install [--ide <client>] [--scope <scope>] [--knowledge-only|--capture-only]
19
- project-knowledge-integrations update [--ide <client>] [--scope <scope>]
20
- project-knowledge-integrations uninstall [--ide <client>] [--scope <scope>] [--knowledge-only|--capture-only]
21
- project-knowledge-integrations status [--ide <client>]
22
- project-knowledge-integrations disable-capture
23
-
24
- Clients:
25
- claude Claude Code plugin (MCP + Skill) + managed Bridge hooks
26
- opencode OpenCode MCP + global Skill + managed Bridge plugin
27
- codex Codex plugin (MCP + Skill) + managed Bridge notify
28
- zcode ZCode native context + managed Bridge capture (not an MCP-plugin claim)
29
- all All supported clients
30
-
31
- Options:
32
- --ide <client> Repeat or use a comma-separated list
33
- --scope <scope> Claude scope: user, project, or local (default: user)
34
- --marketplace <src> Marketplace GitHub repo, Git URL, or local path
35
- --knowledge-only Only install/uninstall the Knowledge Integration
36
- --capture-only Only install/uninstall the Development Capture
37
- --dry-run Show intended operations without changing config
38
- --json Print machine-readable results
39
- -h, --help Show this help
40
-
41
- Without --ide, installed clients are detected automatically. One install
42
- action configures both capabilities. Codex automatic context additionally
43
- requires native /hooks review and trust; installation never bypasses it.`);
44
- }
45
-
46
- function parseArgs(argv) {
47
- const operation = argv[0] && !argv[0].startsWith('-') ? argv[0] : 'status';
48
- const start = operation === 'status' && (!argv[0] || argv[0].startsWith('-')) ? 0 : 1;
49
- const options = {
50
- operation,
51
- clients: [],
52
- scope: 'user',
53
- dryRun: false,
54
- json: false,
55
- help: false,
56
- marketplaceSource: '',
57
- knowledgeOnly: false,
58
- captureOnly: false,
59
- };
60
- for (let i = start; i < argv.length; i++) {
61
- const arg = argv[i];
62
- if (arg === '--ide' && argv[i + 1]) {
63
- options.clients.push(...argv[++i].split(',').filter(Boolean));
64
- } else if (arg === '--all') {
65
- options.clients.push('all');
66
- } else if (arg === '--scope' && argv[i + 1]) {
67
- options.scope = argv[++i];
68
- } else if (arg === '--marketplace' && argv[i + 1]) {
69
- options.marketplaceSource = argv[++i];
70
- } else if (arg === '--knowledge-only') {
71
- options.knowledgeOnly = true;
72
- } else if (arg === '--capture-only') {
73
- options.captureOnly = true;
74
- } else if (arg === '--dry-run') {
75
- options.dryRun = true;
76
- } else if (arg === '--json') {
77
- options.json = true;
78
- } else if (arg === '--help' || arg === '-h') {
79
- options.help = true;
80
- } else {
81
- throw new Error(`unknown option: ${arg}`);
82
- }
83
- }
84
- if (options.knowledgeOnly && options.captureOnly) {
85
- throw new Error('--knowledge-only and --capture-only are mutually exclusive');
86
- }
87
- if (!['install', 'update', 'uninstall', 'status', 'disable-capture'].includes(options.operation)) {
88
- throw new Error(`unknown operation: ${options.operation}`);
89
- }
90
- if (!['user', 'project', 'local'].includes(options.scope)) {
91
- throw new Error(`unsupported scope: ${options.scope}`);
92
- }
93
- return options;
94
- }
95
-
96
- function selectClients(requested, manager) {
97
- if (requested.some(item => String(item).toLowerCase() === 'all')) return [...SUPPORTED_CLIENTS];
98
- if (requested.length) return [...new Set(requested.map(normalizeClient))];
99
- const detected = manager.detectClients();
100
- if (detected.length) return detected;
101
- return [...SUPPORTED_CLIENTS];
102
- }
103
-
104
- function printCapabilityLine(prefix, capability) {
105
- if (!capability) return;
106
- const mark = capability.supported === false ? 'INFO' : capability.ok ? 'OK' : 'FAIL';
107
- console.log(` [${mark}] ${prefix}: ${capability.state} - ${capability.detail}`);
108
- }
109
-
110
- async function runCli(argv = process.argv.slice(2), dependencies = {}) {
111
- const options = parseArgs(argv);
112
- if (options.help) {
113
- printHelp();
114
- return 0;
115
- }
116
- const logger = dependencies.manager ? null : new Logger();
117
- const manager = dependencies.manager || new IntegrationManager({
118
- logger,
119
- operationId: createId('op'),
120
- dryRun: options.dryRun,
121
- marketplaceSource: options.marketplaceSource || undefined,
122
- });
123
- try { return await runOperation(options, manager); }
124
- finally { if (logger) await logger.close(); }
125
- }
126
-
127
- async function runOperation(options, manager) {
128
- const clients = selectClients(options.clients, manager);
129
-
130
- if (options.operation === 'disable-capture') {
131
- const summary = await manager.disableAllCapture({ clients });
132
- if (options.json) {
133
- console.log(JSON.stringify({ operation: 'disable-capture', ...summary, planned: manager.planned }, null, 2));
134
- } else {
135
- for (const result of summary.clients) {
136
- const mark = result.ok ? 'OK' : 'FAIL';
137
- console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
138
- }
139
- const consumerMark = summary.consumer.ok ? 'OK' : 'FAIL';
140
- console.log(`[${consumerMark}] Bridge consumer: ${summary.consumer.state || summary.consumer.detail}`);
141
- }
142
- return summary.clients.some(result => !result.ok) || !summary.consumer.ok ? 1 : 0;
143
- }
144
-
145
- if (options.operation === 'install' || options.operation === 'update' && options.captureOnly) {
146
- // One action configures Knowledge Integration + Development Capture
147
- // together (per-client flags narrow the scope). No client UI is needed.
148
- const summary = await manager.installAll({ clients, knowledgeOnly: options.knowledgeOnly, captureOnly: options.captureOnly, scope: options.scope });
149
- if (options.json) {
150
- console.log(JSON.stringify({ operation: 'install', ...summary, planned: manager.planned }, null, 2));
151
- } else {
152
- const bridgeMark = summary.bridge.ok ? 'OK' : 'FAIL';
153
- console.log(`[${bridgeMark}] Bridge: ${summary.bridge.state} - consumer ${manager.bridgeConsumerName}`);
154
- for (const entry of summary.clients) {
155
- printCapabilityLine(`${entry.label} Knowledge Integration`, entry.knowledgeIntegration);
156
- printCapabilityLine(`${entry.label} Development Capture`, entry.developmentCapture);
157
- if (entry.automaticContext) console.log(` [INFO] ${entry.label} Automatic Context: ${entry.automaticContext.state} - ${entry.automaticContext.detail}`);
158
- }
159
- if (options.dryRun && manager.planned.length) {
160
- console.log('\nPlanned operations:');
161
- for (const item of manager.planned) {
162
- if (item.command) console.log(` ${item.command} ${item.args.join(' ')}`);
163
- else if (item.copy) console.log(` copy ${item.copy} -> ${item.destination}`);
164
- else console.log(` remove ${item.removeConfig} and ${item.removeDirectory}`);
165
- }
166
- }
167
- }
168
- return summary.clients.some(entry =>
169
- (entry.knowledgeIntegration && !entry.knowledgeIntegration.ok)
170
- || (entry.developmentCapture && !entry.developmentCapture.ok)
171
- ) || !summary.bridge.ok ? 1 : 0;
172
- }
173
-
174
- if (options.operation === 'uninstall') {
175
- if (options.captureOnly) {
176
- const results = await manager.operateCapture('uninstall', clients, {});
177
- if (options.json) {
178
- console.log(JSON.stringify({ operation: 'uninstall', captureOnly: true, results, planned: manager.planned }, null, 2));
179
- } else {
180
- for (const result of results) {
181
- const mark = result.ok ? 'OK' : 'FAIL';
182
- console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
183
- }
184
- }
185
- return results.some(result => !result.ok) ? 1 : 0;
186
- }
187
- // Default uninstall removes both capabilities but KEEPS the host Bridge
188
- // consumer; use disable-capture for the global consumer unregister.
189
- const knowledgeResults = await manager.operate('uninstall', clients, { scope: options.scope });
190
- const captureResults = options.knowledgeOnly ? [] : await manager.operateCapture('uninstall', clients, {});
191
- if (options.json) {
192
- console.log(JSON.stringify({ operation: 'uninstall', knowledgeResults, captureResults, planned: manager.planned }, null, 2));
193
- } else {
194
- for (const result of [...knowledgeResults, ...captureResults]) {
195
- const mark = result.ok ? 'OK' : 'FAIL';
196
- console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
197
- }
198
- }
199
- return [...knowledgeResults, ...captureResults].some(result => !result.ok) ? 1 : 0;
200
- }
201
-
202
- if (options.operation === 'status') {
203
- const summary = await manager.statusAll({ clients });
204
- if (options.json) {
205
- console.log(JSON.stringify({ operation: 'status', ...summary, planned: manager.planned }, null, 2));
206
- } else {
207
- const bridgeMark = summary.bridge.ok ? 'OK' : 'FAIL';
208
- console.log(`[${bridgeMark}] Bridge: consumer ${summary.bridge.consumerRegistered ? 'registered' : 'not registered'}, journal ${summary.bridge.bridgeHealthy ? 'healthy' : 'unavailable'}`);
209
- for (const entry of summary.clients) {
210
- printCapabilityLine(`${entry.label} Knowledge Integration`, entry.knowledgeIntegration);
211
- printCapabilityLine(`${entry.label} Development Capture`, entry.developmentCapture);
212
- }
213
- }
214
- return 0;
215
- }
216
-
217
- const results = await manager.operate(options.operation, clients, { scope: options.scope });
218
- if (options.json) {
219
- console.log(JSON.stringify({
220
- operation: options.operation,
221
- results,
222
- planned: manager.planned,
223
- }, null, 2));
224
- } else {
225
- for (const result of results) {
226
- const mark = result.ok ? 'OK' : 'FAIL';
227
- console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
228
- }
229
- if (options.dryRun && manager.planned.length) {
230
- console.log('\nPlanned operations:');
231
- for (const item of manager.planned) {
232
- if (item.command) console.log(` ${item.command} ${item.args.join(' ')}`);
233
- else if (item.copy) console.log(` copy ${item.copy} -> ${item.destination}`);
234
- else console.log(` remove ${item.removeConfig} and ${item.removeDirectory}`);
235
- }
236
- }
237
- }
238
- return results.some(result => !result.ok) ? 1 : 0;
239
- }
240
-
241
- if (require.main === module) {
242
- runCli().then(code => {
243
- process.exitCode = code;
244
- }).catch(error => {
245
- console.error(`project-knowledge-integrations: ${error.message}`);
246
- process.exitCode = 1;
247
- });
248
- }
249
-
250
- module.exports = {
251
- parseArgs,
252
- runCli,
253
- selectClients,
254
- };
1
+ #!/usr/bin/env node
2
+
3
+ const {
4
+ IntegrationManager,
5
+ SUPPORTED_CLIENTS,
6
+ normalizeClient,
7
+ } = require('../_site/lib/integration-installer');
8
+ const { Logger } = require('../_site/lib/structured-logger');
9
+ const { createId } = require('../_site/lib/contracts');
10
+
11
+ function printHelp() {
12
+ console.log(`project-knowledge-integrations
13
+
14
+ Install Project Knowledge for coding agents: Knowledge Integration (MCP +
15
+ Skill / plugin) and Development Capture (Bridge hooks / notify / plugin).
16
+
17
+ Usage:
18
+ project-knowledge-integrations install [--ide <client>] [--scope <scope>] [--knowledge-only|--capture-only]
19
+ project-knowledge-integrations update [--ide <client>] [--scope <scope>]
20
+ project-knowledge-integrations uninstall [--ide <client>] [--scope <scope>] [--knowledge-only|--capture-only]
21
+ project-knowledge-integrations status [--ide <client>]
22
+ project-knowledge-integrations disable-capture
23
+
24
+ Clients:
25
+ claude Claude Code plugin (MCP + Skill) + managed Bridge hooks
26
+ opencode OpenCode MCP + global Skill + managed Bridge plugin
27
+ codex Codex plugin (MCP + Skill) + managed Bridge notify
28
+ zcode ZCode native context + managed Bridge capture (not an MCP-plugin claim)
29
+ all All supported clients
30
+
31
+ Options:
32
+ --ide <client> Repeat or use a comma-separated list
33
+ --scope <scope> Claude scope: user, project, or local (default: user)
34
+ --marketplace <src> Marketplace GitHub repo, Git URL, or local path
35
+ --knowledge-only Only install/uninstall the Knowledge Integration
36
+ --capture-only Only install/uninstall the Development Capture
37
+ --dry-run Show intended operations without changing config
38
+ --json Print machine-readable results
39
+ -h, --help Show this help
40
+
41
+ Without --ide, installed clients are detected automatically. One install
42
+ action configures both capabilities. Codex automatic context additionally
43
+ requires native /hooks review and trust; installation never bypasses it.`);
44
+ }
45
+
46
+ function parseArgs(argv) {
47
+ const operation = argv[0] && !argv[0].startsWith('-') ? argv[0] : 'status';
48
+ const start = operation === 'status' && (!argv[0] || argv[0].startsWith('-')) ? 0 : 1;
49
+ const options = {
50
+ operation,
51
+ clients: [],
52
+ scope: 'user',
53
+ dryRun: false,
54
+ json: false,
55
+ help: false,
56
+ marketplaceSource: '',
57
+ knowledgeOnly: false,
58
+ captureOnly: false,
59
+ };
60
+ for (let i = start; i < argv.length; i++) {
61
+ const arg = argv[i];
62
+ if (arg === '--ide' && argv[i + 1]) {
63
+ options.clients.push(...argv[++i].split(',').filter(Boolean));
64
+ } else if (arg === '--all') {
65
+ options.clients.push('all');
66
+ } else if (arg === '--scope' && argv[i + 1]) {
67
+ options.scope = argv[++i];
68
+ } else if (arg === '--marketplace' && argv[i + 1]) {
69
+ options.marketplaceSource = argv[++i];
70
+ } else if (arg === '--knowledge-only') {
71
+ options.knowledgeOnly = true;
72
+ } else if (arg === '--capture-only') {
73
+ options.captureOnly = true;
74
+ } else if (arg === '--dry-run') {
75
+ options.dryRun = true;
76
+ } else if (arg === '--json') {
77
+ options.json = true;
78
+ } else if (arg === '--help' || arg === '-h') {
79
+ options.help = true;
80
+ } else {
81
+ throw new Error(`unknown option: ${arg}`);
82
+ }
83
+ }
84
+ if (options.knowledgeOnly && options.captureOnly) {
85
+ throw new Error('--knowledge-only and --capture-only are mutually exclusive');
86
+ }
87
+ if (!['install', 'update', 'uninstall', 'status', 'disable-capture'].includes(options.operation)) {
88
+ throw new Error(`unknown operation: ${options.operation}`);
89
+ }
90
+ if (!['user', 'project', 'local'].includes(options.scope)) {
91
+ throw new Error(`unsupported scope: ${options.scope}`);
92
+ }
93
+ return options;
94
+ }
95
+
96
+ function selectClients(requested, manager) {
97
+ if (requested.some(item => String(item).toLowerCase() === 'all')) return [...SUPPORTED_CLIENTS];
98
+ if (requested.length) return [...new Set(requested.map(normalizeClient))];
99
+ const detected = manager.detectClients();
100
+ if (detected.length) return detected;
101
+ return [...SUPPORTED_CLIENTS];
102
+ }
103
+
104
+ function printCapabilityLine(prefix, capability) {
105
+ if (!capability) return;
106
+ const mark = capability.supported === false ? 'INFO' : capability.ok ? 'OK' : 'FAIL';
107
+ console.log(` [${mark}] ${prefix}: ${capability.state} - ${capability.detail}`);
108
+ }
109
+
110
+ async function runCli(argv = process.argv.slice(2), dependencies = {}) {
111
+ const options = parseArgs(argv);
112
+ if (options.help) {
113
+ printHelp();
114
+ return 0;
115
+ }
116
+ const logger = dependencies.manager ? null : new Logger();
117
+ const manager = dependencies.manager || new IntegrationManager({
118
+ logger,
119
+ operationId: createId('op'),
120
+ dryRun: options.dryRun,
121
+ marketplaceSource: options.marketplaceSource || undefined,
122
+ });
123
+ try { return await runOperation(options, manager); }
124
+ finally { if (logger) await logger.close(); }
125
+ }
126
+
127
+ async function runOperation(options, manager) {
128
+ const clients = selectClients(options.clients, manager);
129
+
130
+ if (options.operation === 'disable-capture') {
131
+ const summary = await manager.disableAllCapture({ clients });
132
+ if (options.json) {
133
+ console.log(JSON.stringify({ operation: 'disable-capture', ...summary, planned: manager.planned }, null, 2));
134
+ } else {
135
+ for (const result of summary.clients) {
136
+ const mark = result.ok ? 'OK' : 'FAIL';
137
+ console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
138
+ }
139
+ const consumerMark = summary.consumer.ok ? 'OK' : 'FAIL';
140
+ console.log(`[${consumerMark}] Bridge consumer: ${summary.consumer.state || summary.consumer.detail}`);
141
+ }
142
+ return summary.clients.some(result => !result.ok) || !summary.consumer.ok ? 1 : 0;
143
+ }
144
+
145
+ if (options.operation === 'install' || options.operation === 'update' && options.captureOnly) {
146
+ // One action configures Knowledge Integration + Development Capture
147
+ // together (per-client flags narrow the scope). No client UI is needed.
148
+ const summary = await manager.installAll({ clients, knowledgeOnly: options.knowledgeOnly, captureOnly: options.captureOnly, scope: options.scope });
149
+ if (options.json) {
150
+ console.log(JSON.stringify({ operation: 'install', ...summary, planned: manager.planned }, null, 2));
151
+ } else {
152
+ const bridgeMark = summary.bridge.ok ? 'OK' : 'FAIL';
153
+ console.log(`[${bridgeMark}] Bridge: ${summary.bridge.state} - consumer ${manager.bridgeConsumerName}`);
154
+ for (const entry of summary.clients) {
155
+ printCapabilityLine(`${entry.label} Knowledge Integration`, entry.knowledgeIntegration);
156
+ printCapabilityLine(`${entry.label} Development Capture`, entry.developmentCapture);
157
+ if (entry.automaticContext) console.log(` [INFO] ${entry.label} Automatic Context: ${entry.automaticContext.state} - ${entry.automaticContext.detail}`);
158
+ }
159
+ if (options.dryRun && manager.planned.length) {
160
+ console.log('\nPlanned operations:');
161
+ for (const item of manager.planned) {
162
+ if (item.command) console.log(` ${item.command} ${item.args.join(' ')}`);
163
+ else if (item.copy) console.log(` copy ${item.copy} -> ${item.destination}`);
164
+ else console.log(` remove ${item.removeConfig} and ${item.removeDirectory}`);
165
+ }
166
+ }
167
+ }
168
+ return summary.clients.some(entry =>
169
+ (entry.knowledgeIntegration && !entry.knowledgeIntegration.ok)
170
+ || (entry.developmentCapture && !entry.developmentCapture.ok)
171
+ ) || !summary.bridge.ok ? 1 : 0;
172
+ }
173
+
174
+ if (options.operation === 'uninstall') {
175
+ if (options.captureOnly) {
176
+ const results = await manager.operateCapture('uninstall', clients, {});
177
+ if (options.json) {
178
+ console.log(JSON.stringify({ operation: 'uninstall', captureOnly: true, results, planned: manager.planned }, null, 2));
179
+ } else {
180
+ for (const result of results) {
181
+ const mark = result.ok ? 'OK' : 'FAIL';
182
+ console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
183
+ }
184
+ }
185
+ return results.some(result => !result.ok) ? 1 : 0;
186
+ }
187
+ // Default uninstall removes both capabilities but KEEPS the host Bridge
188
+ // consumer; use disable-capture for the global consumer unregister.
189
+ const knowledgeResults = await manager.operate('uninstall', clients, { scope: options.scope });
190
+ const captureResults = options.knowledgeOnly ? [] : await manager.operateCapture('uninstall', clients, {});
191
+ if (options.json) {
192
+ console.log(JSON.stringify({ operation: 'uninstall', knowledgeResults, captureResults, planned: manager.planned }, null, 2));
193
+ } else {
194
+ for (const result of [...knowledgeResults, ...captureResults]) {
195
+ const mark = result.ok ? 'OK' : 'FAIL';
196
+ console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
197
+ }
198
+ }
199
+ return [...knowledgeResults, ...captureResults].some(result => !result.ok) ? 1 : 0;
200
+ }
201
+
202
+ if (options.operation === 'status') {
203
+ const summary = await manager.statusAll({ clients });
204
+ if (options.json) {
205
+ console.log(JSON.stringify({ operation: 'status', ...summary, planned: manager.planned }, null, 2));
206
+ } else {
207
+ const bridgeMark = summary.bridge.ok ? 'OK' : 'FAIL';
208
+ console.log(`[${bridgeMark}] Bridge: consumer ${summary.bridge.consumerRegistered ? 'registered' : 'not registered'}, journal ${summary.bridge.bridgeHealthy ? 'healthy' : 'unavailable'}`);
209
+ for (const entry of summary.clients) {
210
+ printCapabilityLine(`${entry.label} Knowledge Integration`, entry.knowledgeIntegration);
211
+ printCapabilityLine(`${entry.label} Development Capture`, entry.developmentCapture);
212
+ }
213
+ }
214
+ return 0;
215
+ }
216
+
217
+ const results = await manager.operate(options.operation, clients, { scope: options.scope });
218
+ if (options.json) {
219
+ console.log(JSON.stringify({
220
+ operation: options.operation,
221
+ results,
222
+ planned: manager.planned,
223
+ }, null, 2));
224
+ } else {
225
+ for (const result of results) {
226
+ const mark = result.ok ? 'OK' : 'FAIL';
227
+ console.log(`[${mark}] ${result.label}: ${result.state} - ${result.detail}`);
228
+ }
229
+ if (options.dryRun && manager.planned.length) {
230
+ console.log('\nPlanned operations:');
231
+ for (const item of manager.planned) {
232
+ if (item.command) console.log(` ${item.command} ${item.args.join(' ')}`);
233
+ else if (item.copy) console.log(` copy ${item.copy} -> ${item.destination}`);
234
+ else console.log(` remove ${item.removeConfig} and ${item.removeDirectory}`);
235
+ }
236
+ }
237
+ }
238
+ return results.some(result => !result.ok) ? 1 : 0;
239
+ }
240
+
241
+ if (require.main === module) {
242
+ runCli().then(code => {
243
+ process.exitCode = code;
244
+ }).catch(error => {
245
+ console.error(`project-knowledge-integrations: ${error.message}`);
246
+ process.exitCode = 1;
247
+ });
248
+ }
249
+
250
+ module.exports = {
251
+ parseArgs,
252
+ runCli,
253
+ selectClients,
254
+ };
@@ -1,67 +1,67 @@
1
- #!/usr/bin/env node
2
-
3
- const { KnowledgeToolRuntime } = require('../_site/lib/knowledge-tool-runtime');
4
- const { serializeErrorEnvelope, createId } = require('../_site/lib/contracts');
5
-
6
- function parseOptions(args) {
7
- const first = args[0] || 'help';
8
- const output = { command: first === '--help' || first === '-h' ? 'help' : first };
9
- for (let index = 1; index < args.length; index += 1) {
10
- const key = args[index];
11
- if (!key.startsWith('--')) continue;
12
- const name = key.slice(2).replace(/-([a-z])/g, (_match, letter) => letter.toUpperCase());
13
- if (args[index + 1] && !args[index + 1].startsWith('--')) output[name] = args[++index];
14
- else output[name] = true;
15
- }
16
- return output;
17
- }
18
-
19
- function help() {
20
- process.stdout.write(`project-knowledge-kb
21
-
22
- Read-only local knowledge tools:
23
- project-knowledge-kb search --project <projectId-or-legacy-slug> --query <text> [--limit 8]
24
- project-knowledge-kb ask --project <projectId-or-legacy-slug> --query <text> [--limit 8]
25
- project-knowledge-kb get --project <projectId-or-legacy-slug> --entry <path>
26
- project-knowledge-kb history --project <projectId-or-legacy-slug> [--limit 20]
27
-
28
- Add --scope project|domain|brain for a search range, --space <id> for a cited
29
- shared entry, and --json for machine-readable output. These commands never
30
- modify knowledge or project configuration.\n`);
31
- }
32
-
33
- async function main(argv = process.argv.slice(2), options = {}) {
34
- const args = parseOptions(argv);
35
- if (args.command === 'help' || args.help) {
36
- help();
37
- return 0;
38
- }
39
- if (!['search', 'ask', 'get', 'history'].includes(args.command)) throw new Error(`unknown command: ${args.command}`);
40
- if (!args.project) throw new Error('--project is required');
41
- const runtime = options.runtime || new KnowledgeToolRuntime(options);
42
- try {
43
- const input = { project: args.project, query: args.query, limit: args.limit, entry: args.entry, scope: args.scope, spaceId: args.spaceId || args.space };
44
- let result;
45
- if (args.command === 'search') result = await runtime.search(input);
46
- else if (args.command === 'ask') result = await runtime.ask(input);
47
- else if (args.command === 'get') result = await runtime.get(input);
48
- else result = await runtime.history(input);
49
- if (args.json || args.command !== 'ask') process.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
50
- else process.stdout.write(`${result.answer}\n`);
51
- return 0;
52
- } finally {
53
- await runtime.close();
54
- }
55
- }
56
-
57
- if (require.main === module) {
58
- const jsonMode = process.argv.includes('--json');
59
- const operationId = createId('op');
60
- main().catch(error => {
61
- if (jsonMode) process.stderr.write(`${JSON.stringify(serializeErrorEnvelope(error, operationId))}\n`);
62
- else process.stderr.write(`project-knowledge-kb: ${String(error && error.message || 'The operation failed.')} [${operationId}]\n`);
63
- process.exitCode = 1;
64
- });
65
- }
66
-
67
- module.exports = { main, parseOptions };
1
+ #!/usr/bin/env node
2
+
3
+ const { KnowledgeToolRuntime } = require('../_site/lib/knowledge-tool-runtime');
4
+ const { serializeErrorEnvelope, createId } = require('../_site/lib/contracts');
5
+
6
+ function parseOptions(args) {
7
+ const first = args[0] || 'help';
8
+ const output = { command: first === '--help' || first === '-h' ? 'help' : first };
9
+ for (let index = 1; index < args.length; index += 1) {
10
+ const key = args[index];
11
+ if (!key.startsWith('--')) continue;
12
+ const name = key.slice(2).replace(/-([a-z])/g, (_match, letter) => letter.toUpperCase());
13
+ if (args[index + 1] && !args[index + 1].startsWith('--')) output[name] = args[++index];
14
+ else output[name] = true;
15
+ }
16
+ return output;
17
+ }
18
+
19
+ function help() {
20
+ process.stdout.write(`project-knowledge-kb
21
+
22
+ Read-only local knowledge tools:
23
+ project-knowledge-kb search --project <projectId-or-legacy-slug> --query <text> [--limit 8]
24
+ project-knowledge-kb ask --project <projectId-or-legacy-slug> --query <text> [--limit 8]
25
+ project-knowledge-kb get --project <projectId-or-legacy-slug> --entry <path>
26
+ project-knowledge-kb history --project <projectId-or-legacy-slug> [--limit 20]
27
+
28
+ Add --scope project|domain|brain for a search range, --space <id> for a cited
29
+ shared entry, and --json for machine-readable output. These commands never
30
+ modify knowledge or project configuration.\n`);
31
+ }
32
+
33
+ async function main(argv = process.argv.slice(2), options = {}) {
34
+ const args = parseOptions(argv);
35
+ if (args.command === 'help' || args.help) {
36
+ help();
37
+ return 0;
38
+ }
39
+ if (!['search', 'ask', 'get', 'history'].includes(args.command)) throw new Error(`unknown command: ${args.command}`);
40
+ if (!args.project) throw new Error('--project is required');
41
+ const runtime = options.runtime || new KnowledgeToolRuntime(options);
42
+ try {
43
+ const input = { project: args.project, query: args.query, limit: args.limit, entry: args.entry, scope: args.scope, spaceId: args.spaceId || args.space };
44
+ let result;
45
+ if (args.command === 'search') result = await runtime.search(input);
46
+ else if (args.command === 'ask') result = await runtime.ask(input);
47
+ else if (args.command === 'get') result = await runtime.get(input);
48
+ else result = await runtime.history(input);
49
+ if (args.json || args.command !== 'ask') process.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
50
+ else process.stdout.write(`${result.answer}\n`);
51
+ return 0;
52
+ } finally {
53
+ await runtime.close();
54
+ }
55
+ }
56
+
57
+ if (require.main === module) {
58
+ const jsonMode = process.argv.includes('--json');
59
+ const operationId = createId('op');
60
+ main().catch(error => {
61
+ if (jsonMode) process.stderr.write(`${JSON.stringify(serializeErrorEnvelope(error, operationId))}\n`);
62
+ else process.stderr.write(`project-knowledge-kb: ${String(error && error.message || 'The operation failed.')} [${operationId}]\n`);
63
+ process.exitCode = 1;
64
+ });
65
+ }
66
+
67
+ module.exports = { main, parseOptions };