workspai 0.45.0 → 0.47.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.
- package/README.md +307 -532
- package/contracts/agent-customization-pack.v1.json +6 -1
- package/contracts/bootstrap-compliance.v1.json +14 -0
- package/contracts/cli-runtime-command-inventory.v1.snapshot.json +8 -0
- package/contracts/extension-cli-compatibility.v1.json +9 -2
- package/contracts/mirror-ops.v1.json +16 -0
- package/contracts/published-contract-catalog.v1.json +38 -1
- package/contracts/runtime-command-surface.v1.json +190 -7
- package/contracts/transparency-evidence.v1.json +13 -0
- package/contracts/workspace-archive-capabilities.v1.json +17 -6
- package/contracts/workspace-contract.v1.json +78 -0
- package/contracts/workspace-intelligence/studio-blocker-handoff.v1.json +4 -0
- package/contracts/workspace-intelligence/workspace-context.v1.json +20 -0
- package/contracts/workspace-intelligence/workspace-graph-token-efficiency.v1.json +72 -0
- package/contracts/workspace-intelligence/workspace-intelligence-run.v1.json +212 -0
- package/contracts/workspace-intelligence/workspace-knowledge-graph-change-overlay.v1.json +200 -0
- package/contracts/workspace-intelligence/workspace-knowledge-graph.v1.json +260 -0
- package/contracts/workspace-intelligence/workspace-knowledge-search.v1.json +60 -0
- package/contracts/workspace-intelligence-architecture.v1.json +7 -4
- package/contracts/workspace-intelligence-chain.v1.json +51 -4
- package/contracts/workspace-share-bundle.v1.json +16 -0
- package/dist/analyze-UVXPRGYZ.js +1 -0
- package/dist/artifact-remediation-plan-EPALZ2LC.js +3 -0
- package/dist/autopilot-release-5BQ6F5L2.js +1 -0
- package/dist/chunk-22NJ2ZMG.js +2 -0
- package/dist/{chunk-XIVFLY6G.js → chunk-2GHUZDYA.js} +1 -1
- package/dist/chunk-2TEDAKP6.js +2 -0
- package/dist/chunk-52PBRX7F.js +1 -0
- package/dist/chunk-6SWRNA47.js +4 -0
- package/dist/chunk-76YOPAOT.js +1 -0
- package/dist/chunk-7VLCK5JW.js +1 -0
- package/dist/{chunk-DXPU4DDV.js → chunk-BSRVO52Y.js} +92 -78
- package/dist/chunk-COARSXRC.js +1 -0
- package/dist/chunk-CV5HKU4P.js +1 -0
- package/dist/chunk-CW7PGBIQ.js +13 -0
- package/dist/{chunk-KU4S7RCM.js → chunk-DV6GJD4K.js} +1 -1
- package/dist/chunk-EYJ2CQSK.js +1 -0
- package/dist/chunk-FB7SCXAZ.js +1 -0
- package/dist/chunk-FPJNWPKU.js +1 -0
- package/dist/{chunk-JP25YL3J.js → chunk-FTY7GGXJ.js} +2 -2
- package/dist/chunk-FXQJX34Z.js +1 -0
- package/dist/{chunk-J4AICQFB.js → chunk-HSGFUKCN.js} +1 -1
- package/dist/{chunk-OOOPYUL2.js → chunk-ITCAMC2E.js} +1 -1
- package/dist/chunk-KB44JP4M.js +2 -0
- package/dist/{chunk-WANW4QA4.js → chunk-KZZ36CK5.js} +1 -1
- package/dist/chunk-LNRAB7UY.js +1 -0
- package/dist/chunk-MEMHNE7Y.js +80 -0
- package/dist/chunk-MER6ZBN2.js +13 -0
- package/dist/chunk-NOFM7MNA.js +2 -0
- package/dist/chunk-NRYS4CLR.js +2 -0
- package/dist/chunk-OA537ZQ5.js +1 -0
- package/dist/chunk-PBHP6JNY.js +8 -0
- package/dist/chunk-QDWYIRHR.js +8 -0
- package/dist/chunk-RWRLFSKW.js +2 -0
- package/dist/chunk-SK6XRKGG.js +1 -0
- package/dist/chunk-THIOE2PB.js +2 -0
- package/dist/chunk-TNQI5VCW.js +36 -0
- package/dist/chunk-TWNFECMN.js +2 -0
- package/dist/{chunk-2QOWRBQD.js → chunk-U5EZHZBX.js} +1 -1
- package/dist/{chunk-K63BSU56.js → chunk-VBSQ7MF6.js} +62 -51
- package/dist/chunk-WDKNMTJQ.js +1 -0
- package/dist/chunk-YCL3I2JO.js +2 -0
- package/dist/chunk-ZDN7RHXJ.js +1 -0
- package/dist/chunk-ZM5NQ5Z2.js +1 -0
- package/dist/{create-KFR6FLRT.js → create-7JKJDAQV.js} +1 -1
- package/dist/doctor-PGPNIS76.js +1 -0
- package/dist/{dotnet-webapi-clean-BYUUHX5Y.js → dotnet-webapi-clean-6TVFBTVI.js} +20 -20
- package/dist/{gofiber-standard-B6UK5GR7.js → gofiber-standard-2BL7GWZB.js} +1 -1
- package/dist/{gogin-standard-BXU44VEM.js → gogin-standard-XGP3KBXA.js} +1 -1
- package/dist/index.d.ts +112 -16
- package/dist/index.js +198 -195
- package/dist/pipeline-IB6ILJSV.js +5 -0
- package/dist/{platform-capabilities-YICBF4FA.js → platform-capabilities-2B4QMZXE.js} +1 -1
- package/dist/{pythonRapidkitExec-UJYIB6FL.js → pythonRapidkitExec-CVCIK225.js} +1 -1
- package/dist/{springboot-standard-PEHDKH2L.js → springboot-standard-JJNUID6M.js} +6 -6
- package/dist/workspace-H3QXBFGB.js +1 -0
- package/dist/{workspace-agent-sync-G5YVI3BJ.js → workspace-agent-sync-C7SG2Z5W.js} +1 -1
- package/dist/workspace-archive-P76EDIUG.js +10 -0
- package/dist/{workspace-context-E3UFWL5X.js → workspace-context-BKQBKA4C.js} +1 -1
- package/dist/workspace-contract-RPQQBQXR.js +1 -0
- package/dist/workspace-dependency-graph-23BI2HG7.js +1 -0
- package/dist/workspace-explain-WVN7JH3U.js +1 -0
- package/dist/workspace-explain-contract-SEFTVF6J.js +1 -0
- package/dist/{workspace-feedback-YY6WQPWQ.js → workspace-feedback-WAID3IOE.js} +1 -1
- package/dist/{workspace-foundation-3C2DLCVI.js → workspace-foundation-5OOJEO2D.js} +1 -1
- package/dist/workspace-graph-token-efficiency-CFGFCJ5V.js +1 -0
- package/dist/{workspace-history-VF3CHDYQ.js → workspace-history-C6OP3IAQ.js} +1 -1
- package/dist/workspace-intelligence-VKDL3H2J.js +1 -0
- package/dist/workspace-intelligence-runner-LVALAZY7.js +1 -0
- package/dist/workspace-knowledge-graph-FE2NTZKV.js +1 -0
- package/dist/workspace-knowledge-graph-change-overlay-XG6FC4IX.js +1 -0
- package/dist/workspace-knowledge-graph-query-VOSPPH4W.js +1 -0
- package/dist/workspace-mcp-serve-KT2I676Z.js +3 -0
- package/dist/workspace-model-S33CIB2R.js +1 -0
- package/dist/workspace-model-hash-MHXK5MEI.js +1 -0
- package/dist/workspace-python-engine-state-2MLKJYQG.js +2 -0
- package/dist/workspace-registry-summary-A3YDL63D.js +1 -0
- package/dist/workspace-run-M4LNJILC.js +1 -0
- package/dist/{workspace-verify-ZNT6JX7D.js → workspace-verify-ZGH3NXAH.js} +1 -1
- package/dist/workspace-watch-EVBJTMV7.js +1 -0
- package/docs/AI_DYNAMIC_INTEGRATION.md +73 -432
- package/docs/AI_EXAMPLES.md +37 -395
- package/docs/AI_FEATURES.md +76 -465
- package/docs/AI_QUICKSTART.md +49 -209
- package/docs/DEVELOPMENT.md +5 -5
- package/docs/From Code to Shared Understanding.png +0 -0
- package/docs/GLOSSARY.md +60 -0
- package/docs/OPEN_SOURCE_USER_SCENARIOS.md +91 -9
- package/docs/OPTIMIZATION_GUIDE.md +19 -51
- package/docs/PACKAGE_MANAGER_POLICY.md +4 -1
- package/docs/README.md +91 -42
- package/docs/SECURITY.md +13 -6
- package/docs/SETUP.md +6 -3
- package/docs/UTILITIES.md +8 -20
- package/docs/WORKSPACE_MARKER_SPEC.md +27 -20
- package/docs/ci-workflows.md +19 -5
- package/docs/commands-reference.md +88 -13
- package/docs/config-file-guide.md +67 -246
- package/docs/contracts/ARTIFACT_CATALOG.md +78 -36
- package/docs/contracts/CLI_LOG_EVENT_STREAM.md +1 -1
- package/docs/contracts/README.md +48 -9
- package/docs/contracts/RUNTIME_ACCEPTANCE_MATRIX.md +4 -4
- package/docs/contracts/RUNTIME_SUPPORT_MATRIX.md +14 -10
- package/docs/creating-workspaces-and-projects.md +649 -0
- package/docs/doctor-command.md +5 -4
- package/docs/examples/ci-agent-grounding.yml +16 -10
- package/docs/from-code-to-shared-understanding.md +69 -38
- package/docs/graph-benchmark-methodology.md +121 -0
- package/docs/workspace-intelligence-runner.md +186 -0
- package/docs/workspace-knowledge-graph.md +295 -0
- package/docs/workspace-operations.md +78 -11
- package/docs/workspace-run.md +4 -1
- package/package.json +10 -8
- package/rapidkit.config.example.cjs +5 -5
- package/scripts/enforce-package-manager.cjs +1 -1
- package/scripts/prepack-enterprise.mjs +4 -0
- package/workspai.config.example.cjs +12 -47
- package/dist/analyze-YLV7NVLF.js +0 -1
- package/dist/artifact-remediation-plan-WLZGROUU.js +0 -3
- package/dist/autopilot-release-YBN3SWAA.js +0 -1
- package/dist/chunk-2K3GYCPS.js +0 -1
- package/dist/chunk-42G2OK64.js +0 -1
- package/dist/chunk-5AKYMAIL.js +0 -1
- package/dist/chunk-5GNT4RJI.js +0 -8
- package/dist/chunk-5PVEQ6CZ.js +0 -13
- package/dist/chunk-6AA3WWQZ.js +0 -2
- package/dist/chunk-6ZENXBMG.js +0 -33
- package/dist/chunk-7RIWU5TZ.js +0 -1
- package/dist/chunk-7UZVOYF5.js +0 -2
- package/dist/chunk-BJLE5CH7.js +0 -4
- package/dist/chunk-G3H5R3RR.js +0 -1
- package/dist/chunk-HYJK7W3B.js +0 -1
- package/dist/chunk-IMUU5Q2V.js +0 -13
- package/dist/chunk-KPPGZCUW.js +0 -78
- package/dist/chunk-LCRROMRR.js +0 -2
- package/dist/chunk-LG6RFLPZ.js +0 -1
- package/dist/chunk-P424XYHP.js +0 -1
- package/dist/chunk-P7SCWJFG.js +0 -8
- package/dist/chunk-QWU2CZBG.js +0 -2
- package/dist/chunk-V2H2KRMZ.js +0 -1
- package/dist/chunk-XZGVNGRB.js +0 -1
- package/dist/chunk-ZWO6K24C.js +0 -2
- package/dist/doctor-YJDM5XBH.js +0 -1
- package/dist/imported-projects-registry-FOIE27WT.js +0 -1
- package/dist/pipeline-FEDYO3IA.js +0 -5
- package/dist/workspace-PLXOO6ST.js +0 -1
- package/dist/workspace-archive-EEGLHZDW.js +0 -10
- package/dist/workspace-contract-LQJDZV36.js +0 -1
- package/dist/workspace-explain-G74ZIF23.js +0 -1
- package/dist/workspace-explain-contract-KT757JGQ.js +0 -1
- package/dist/workspace-intelligence-3GG7GEDQ.js +0 -1
- package/dist/workspace-mcp-serve-MJMUV4RY.js +0 -3
- package/dist/workspace-model-NG45SRM5.js +0 -1
- package/dist/workspace-python-engine-state-MTWIIZPY.js +0 -2
- package/dist/workspace-registry-summary-JM2XY52C.js +0 -1
- package/dist/workspace-run-WEQYIERE.js +0 -1
- package/dist/workspace-watch-W47T4RX2.js +0 -1
|
@@ -72,21 +72,44 @@ the same evidence without losing the workspace source of truth.
|
|
|
72
72
|
|
|
73
73
|
## Workspace intelligence
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
|
80
|
-
|
|
|
81
|
-
| `
|
|
82
|
-
| `workspace
|
|
83
|
-
| `workspace
|
|
84
|
-
| `workspace
|
|
85
|
-
| `workspace
|
|
86
|
-
| `
|
|
87
|
-
| `workspace
|
|
88
|
-
| `workspace
|
|
89
|
-
| `workspace
|
|
75
|
+
Bare artifact names in this table are relative to `.workspai/reports/`.
|
|
76
|
+
Entries beginning with `reports/` are relative to `.workspai/`; paths such as
|
|
77
|
+
`AGENTS.md` are relative to the workspace root.
|
|
78
|
+
|
|
79
|
+
| Command | Artifact | Schema | Contract file |
|
|
80
|
+
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -------------------------------------------------------------------------- |
|
|
81
|
+
| `workspace model --write` | `workspace-model.json` | `workspace-model.v1` | `contracts/workspace-intelligence/workspace-model.v1.json` |
|
|
82
|
+
| `workspace model --write` | `workspace-knowledge-graph.json` | `workspace-knowledge-graph.v1` | `contracts/workspace-intelligence/workspace-knowledge-graph.v1.json` |
|
|
83
|
+
| `workspace snapshot` | `workspace-model-snapshot.json` | `workspace-model-snapshot.v1` | `contracts/workspace-intelligence/workspace-model-snapshot.v1.json` |
|
|
84
|
+
| `workspace diff` | `workspace-model-diff-last-run.json` | `workspace-model-diff.v1` | `contracts/workspace-intelligence/workspace-model-diff.v1.json` |
|
|
85
|
+
| `workspace impact --from <diff>` | `workspace-impact-last-run.json` | `workspace-impact.v1` | `contracts/workspace-intelligence/workspace-impact.v1.json` |
|
|
86
|
+
| `analyze --json` | `analyze-last-run.json` | `rapidkit-analyze-v1` | `contracts/analyze-last-run.v1.json` |
|
|
87
|
+
| `workspace verify` | `workspace-verify-last-run.json` | `workspace-verify.v1` | `contracts/workspace-intelligence/workspace-verify.v1.json` |
|
|
88
|
+
| `workspace context --write` | `workspace-context-agent.json` | `workspace-context.v1` | `contracts/workspace-intelligence/workspace-context.v1.json` |
|
|
89
|
+
| `workspace agent-sync --write` | `reports/agent-customization-pack.json` | `rapidkit-agent-customization-pack.v1` | `contracts/workspace-intelligence/agent-customization-pack-report.v1.json` |
|
|
90
|
+
| `workspace agent-sync --write` | `reports/INDEX.json` | `rapidkit-agent-reports-index.v1` | `contracts/workspace-intelligence/agent-reports-index.v1.json` |
|
|
91
|
+
| `workspace agent-sync --write` | `reports/workspace-skills-index.json` | `workspace-skills-index.v1` | `contracts/workspace-intelligence/workspace-skills-index.v1.json` |
|
|
92
|
+
| `workspace agent-sync --write` | `reports/workspai-mcp-design.json`, `.workspai/skills/*.md`, `.workspai/AGENT-GROUNDING.md`, `AGENTS.md`, IDE agent surfaces | Mixed generated surfaces | See customization pack output inventory |
|
|
93
|
+
| `workspace explain --write` | `workspace-explain-last-run.json` | `workspace-explain.v1` | `contracts/workspace-intelligence/workspace-explain.v1.json` |
|
|
94
|
+
| `workspace why --write` | `workspace-why-last-run.json` | `workspace-explain.v1` | `contracts/workspace-intelligence/workspace-explain.v1.json` |
|
|
95
|
+
| `workspace trace --write` | `workspace-trace-last-run.json` | `workspace-explain.v1` | `contracts/workspace-intelligence/workspace-explain.v1.json` |
|
|
96
|
+
| `workspace intelligence run` | `workspace-intelligence-run-last-run.json` | `workspace-intelligence-run.v1` | `contracts/workspace-intelligence/workspace-intelligence-run.v1.json` |
|
|
97
|
+
| `workspace feedback record` / `doctor * --fix` | `workspace-intelligence-history.json` (`kind: agent-action`, `doctor-fix`) | `workspace-intelligence-history.v1` | `contracts/workspace-intelligence/workspace-intelligence-history.v1.json` |
|
|
98
|
+
|
|
99
|
+
The unified runner report separates its execution envelope from the canonical
|
|
100
|
+
intelligence chain. `preflight` always contains exactly `sync` and `baseline`;
|
|
101
|
+
baseline resolution runs after `model` and before `diff`, recording `created` or
|
|
102
|
+
`reused`. `stages` always contains exactly the 11 ordered steps declared by
|
|
103
|
+
`workspace-intelligence-chain.v1`. JSON Schema enforces the transport shape and
|
|
104
|
+
the runtime semantic validator additionally enforces artifact parity,
|
|
105
|
+
status/exit coherence, hard-failure skip propagation, and the aggregate verdict.
|
|
106
|
+
See [Unified Workspace Intelligence Runner](../workspace-intelligence-runner.md)
|
|
107
|
+
for the normative user and integration semantics.
|
|
108
|
+
|
|
109
|
+
`workspace-model.json` and `workspace-knowledge-graph.json` are published as one
|
|
110
|
+
recoverable artifact transaction. The graph carries a SHA-256 `source` binding
|
|
111
|
+
to the canonical model, so consumers must reject a graph whose source hash does
|
|
112
|
+
not equal the current structural model hash.
|
|
90
113
|
|
|
91
114
|
**CLI semantics:** `workspace diff --from` expects a **model or snapshot** baseline. `workspace impact --from` expects a **diff report**.
|
|
92
115
|
Persisted artifacts retain their artifact schema. JSON command projections that add operation metadata
|
|
@@ -177,11 +200,18 @@ block, in `warn` mode they escalate to needs-attention.
|
|
|
177
200
|
a dependency change makes every dependent stale deterministically. The verdict compares against
|
|
178
201
|
the previously written verify report. Canonical source: `src/workspace-graph-freshness.ts`.
|
|
179
202
|
|
|
180
|
-
**Graph command surface.** `workspace graph` emits the graph plus
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
203
|
+
**Graph command surface.** `workspace graph` emits the dependency graph plus
|
|
204
|
+
integrity and hotspots. `explain <project>` returns centrality and
|
|
205
|
+
direct/transitive relationships. `search`, `entities`, `evidence`, and `path`
|
|
206
|
+
return bounded Knowledge Graph projections with proof references; `benchmark`
|
|
207
|
+
measures corpus-versus-retrieval payload; `overlay --from` compares a proposed
|
|
208
|
+
or earlier graph with the current graph; `emit` returns the complete
|
|
209
|
+
interchange graph; and `dot|mermaid` render deterministic dependency views.
|
|
210
|
+
Canonical sources are `src/workspace-graph.ts`,
|
|
211
|
+
`src/workspace-knowledge-graph-query.ts`,
|
|
212
|
+
`src/workspace-knowledge-graph-change-overlay.ts`, and
|
|
213
|
+
`src/workspace-graph-token-efficiency.ts`. These command surfaces are published
|
|
214
|
+
through `runtime-command-surface.v1` for IDE/CI capability detection.
|
|
185
215
|
|
|
186
216
|
### Model cache (`workspace-model-cache.v1`)
|
|
187
217
|
|
|
@@ -251,18 +281,19 @@ Canonical source: `src/observability/run-correlation.ts` (`attachRunCorrelation`
|
|
|
251
281
|
|
|
252
282
|
## Operational / platform
|
|
253
283
|
|
|
254
|
-
| Command | Artifact
|
|
255
|
-
| -------------------------------- |
|
|
256
|
-
| `workspace run` | `workspace-run-last.json`
|
|
257
|
-
| `autopilot release` (run stages) | same `workspace-run-last.json`
|
|
258
|
-
| `bootstrap` | `bootstrap-compliance-{ts}.json`, `bootstrap-compliance.latest.json`
|
|
259
|
-
| `mirror status` | `mirror-ops-{ts}.json`, `mirror-ops.latest.json`
|
|
260
|
-
| `mirror` (transparency) | `transparency-evidence-{ts}.json`, `transparency-evidence.latest.json` |
|
|
261
|
-
| `infra plan` | `infra-plan.json`
|
|
262
|
-
| `workspace archive` | `.workspai/archive-manifest.json` inside ZIP/ZIP64
|
|
263
|
-
| `workspace share` | `reports/share-bundle.json` (default)
|
|
264
|
-
| `import` / `
|
|
265
|
-
| `
|
|
284
|
+
| Command | Artifact | Notes | Contract |
|
|
285
|
+
| -------------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
286
|
+
| `workspace run` | `workspace-run-last.json` | `workspace-run-v1` (multi-stage: `stages.test`, `stages.build`, …) | `contracts/workspace-run-last.v1.json` |
|
|
287
|
+
| `autopilot release` (run stages) | same `workspace-run-last.json` | Autopilot publishes test/build into aggregate (no separate `autopilot-workspace-run-*.json`) | — |
|
|
288
|
+
| `bootstrap` | `bootstrap-compliance-{ts}.json`, `bootstrap-compliance.latest.json` | `bootstrap-compliance.v1` | `contracts/bootstrap-compliance.v1.json` |
|
|
289
|
+
| `mirror status` | `mirror-ops-{ts}.json`, `mirror-ops.latest.json` | `mirror-ops.v1` | `contracts/mirror-ops.v1.json` |
|
|
290
|
+
| `mirror` (transparency) | `transparency-evidence-{ts}.json`, `transparency-evidence.latest.json` | `transparency-evidence.v1` | `contracts/transparency-evidence.v1.json` |
|
|
291
|
+
| `infra plan` | `infra-plan.json` | `rapidkit.infra-plan.v1` | — |
|
|
292
|
+
| `workspace archive` | `.workspai/archive-manifest.json` inside ZIP/ZIP64 | Streaming handoff; workspace payload is unlimited by default and safety budgets are opt-in | `contracts/workspace-archive-manifest.v1.json` |
|
|
293
|
+
| `workspace share` | `reports/share-bundle.json` (default) | Aggregation bundle (`1.1`) | `contracts/workspace-share-bundle.v1.json` |
|
|
294
|
+
| `import` | `{project}/.workspai/import.json`, `{project}/.workspai/import-readiness.json` | Copied/cloned project metadata and readiness | — |
|
|
295
|
+
| `adopt` | `{project}/.workspai/adopt.json`, `{project}/.workspai/adopt-readiness.json` | In-place project metadata and readiness | — |
|
|
296
|
+
| `workspace contract verify` | `workspace-contract-verify-last-run.json` | CLI verify cache | `contracts/workspace-intelligence/workspace-contract-verify.v1.json` |
|
|
266
297
|
|
|
267
298
|
## Static capability contracts
|
|
268
299
|
|
|
@@ -308,18 +339,29 @@ them as portable repository contracts. The portable source is
|
|
|
308
339
|
|
|
309
340
|
Under `{project}/.workspai/reports/` when commands run at project scope (e.g. project doctor). Workspace-level reports stay under `{workspace}/.workspai/reports/`.
|
|
310
341
|
|
|
342
|
+
After a Python Core bridge creates a project, Workspai validates and mirrors
|
|
343
|
+
legacy `.rapidkit/project.json`, `context.json`, and `file-hashes.json` into the
|
|
344
|
+
canonical project `.workspai/` directory without overwriting an existing
|
|
345
|
+
canonical file. Legacy files remain readable during the compatibility window.
|
|
346
|
+
|
|
311
347
|
## Consumer rules
|
|
312
348
|
|
|
313
349
|
1. **Project count:** read `workspace-registry.v1.json` (or run `workspace registry status --json`).
|
|
314
|
-
2. **
|
|
350
|
+
2. **Workspace Intelligence chain:** run `workspace intelligence run --for-agent codex --strict --json` to preserve Model → Diff → Impact → Doctor + Contract Verify + Analyze → Readiness → Verify → Context → Agent Sync → Explain. `pipeline` is the broader governance/release orchestrator and `autopilot` is a separate release surface; neither redefines the canonical chain. Use `pipeline-last-run.json` only for the pipeline orchestration summary.
|
|
315
351
|
3. **Do not** use `workspace.json.projects` (removed in schema 1.0).
|
|
316
352
|
4. Prefer `schemaVersion` constants in each artifact; legacy `v1` on readiness is accepted when reading old reports.
|
|
317
|
-
5. **Agent
|
|
353
|
+
5. **Agent retrieval:** start with `AGENTS.md` and `.workspai/reports/INDEX.json`, then use `workspace graph search <query> --limit <n> --json` or MCP `searchWorkspaceGraph` for question-sized facts. Follow returned proof paths to source evidence. Read the full context, model, or graph only when the bounded result is insufficient.
|
|
354
|
+
6. **Agent customization state:** use `.workspai/reports/agent-customization-pack.json` to inspect generated surfaces and drift; regenerate with `workspace agent-sync --write --refresh-context --preset enterprise`.
|
|
318
355
|
|
|
319
356
|
## Agent customization files (repo hooks)
|
|
320
357
|
|
|
321
358
|
Written by `workspace agent-sync --write --refresh-context --preset enterprise` (and by default after `workspace context --for-agent --write`):
|
|
322
359
|
|
|
360
|
+
The generated output inventory is committed as one journaled transaction. On
|
|
361
|
+
failure, all touched files are restored; an interrupted transaction is recovered
|
|
362
|
+
before the next agent-sync. `agent-customization-pack.json` is written last and
|
|
363
|
+
serves as the completed-generation marker.
|
|
364
|
+
|
|
323
365
|
| Path | Consumer |
|
|
324
366
|
| ----------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
325
367
|
| `AGENTS.md` | Copilot, Cursor, Claude Code, Codex, Grok (open standard) |
|
|
@@ -333,7 +375,7 @@ Written by `workspace agent-sync --write --refresh-context --preset enterprise`
|
|
|
333
375
|
| `.github/prompts/workspai-adopt-project.prompt.md` | Copilot adopt/import workflow prompt |
|
|
334
376
|
| `.github/skills/workspai-grounding/SKILL.md` | Copilot skills |
|
|
335
377
|
| `.github/skills/workspai-workspace-intelligence/SKILL.md` | Enterprise Workspace Intelligence skill |
|
|
336
|
-
| `.github/skills/workspai-workspace-intelligence/resources/mcp-tools.md` |
|
|
378
|
+
| `.github/skills/workspai-workspace-intelligence/resources/mcp-tools.md` | MCP tool and evidence-retrieval reference |
|
|
337
379
|
| `.github/agents/workspai-advisor.agent.md` | Read-only workspace advisor agent |
|
|
338
380
|
| `.github/agents/workspai-repair.agent.md` | Blocker repair agent |
|
|
339
381
|
| `.github/agents/workspai-release.agent.md` | Release safety agent |
|
|
@@ -341,7 +383,7 @@ Written by `workspace agent-sync --write --refresh-context --preset enterprise`
|
|
|
341
383
|
| `.cursor/rules/workspai-grounding.mdc` | Cursor always-on rule |
|
|
342
384
|
| `CLAUDE.md` | Claude Code (imports `@AGENTS.md`) |
|
|
343
385
|
| `.claude/rules/workspai-evidence.md` | Claude Code scoped evidence rule |
|
|
344
|
-
| `.claude/rules/rapidkit-evidence.md` | Legacy
|
|
386
|
+
| `.claude/rules/rapidkit-evidence.md` | Legacy compatibility alias pointing to the canonical rule |
|
|
345
387
|
| `.workspai/AGENT-GROUNDING.md` | Tool-agnostic operator doc |
|
|
346
388
|
| `.workspai/reports/agent-customization-pack.json` | Versioned output inventory, target matrix, drift state |
|
|
347
389
|
| `.workspai/reports/workspai-mcp-design.json` | Read-mostly MCP-ready design manifest |
|
|
@@ -75,7 +75,7 @@ Each stderr line is a single JSON object:
|
|
|
75
75
|
"component": "cli",
|
|
76
76
|
"message": "CLI run started",
|
|
77
77
|
"command": ["workspace", "model"],
|
|
78
|
-
"metadata": { "cwd": "/path/to/workspace", "rapidkitVersion": "
|
|
78
|
+
"metadata": { "cwd": "/path/to/workspace", "rapidkitVersion": "<workspai-version>" }
|
|
79
79
|
}
|
|
80
80
|
```
|
|
81
81
|
|
package/docs/contracts/README.md
CHANGED
|
@@ -2,6 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
Contract documentation for JSON payloads, support matrices, and cross-repo parity.
|
|
4
4
|
|
|
5
|
+
## Complete contract discovery
|
|
6
|
+
|
|
7
|
+
The complete machine-readable inventory is
|
|
8
|
+
[`../../contracts/published-contract-catalog.v1.json`](../../contracts/published-contract-catalog.v1.json).
|
|
9
|
+
It is the source of truth for every published schema/capability path; the lists
|
|
10
|
+
below are grouped entry points, not a substitute for that catalog.
|
|
11
|
+
|
|
12
|
+
Installed consumers can discover the active package version and contract map
|
|
13
|
+
without scraping Markdown:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx workspai --version --json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Resolve contract files from the installed `workspai/contracts/` directory and
|
|
20
|
+
validate payloads against the exact catalog revision shipped with that CLI.
|
|
21
|
+
Do not copy a schema from `main` and assume it matches an older installed CLI.
|
|
22
|
+
|
|
5
23
|
## Monorepo workflow
|
|
6
24
|
|
|
7
25
|
Canonical JSON lives in **`../../contracts/`** (CLI package root, published in the tarball).
|
|
@@ -12,26 +30,31 @@ Canonical JSON lives in **`../../contracts/`** (CLI package root, published in t
|
|
|
12
30
|
| `npm run check:generated-contracts` | Verify committed JSON matches generators |
|
|
13
31
|
| `npm run sync:parity-snapshot` | Copy canonical → vscode `contracts/` mirror |
|
|
14
32
|
| `npm run check:parity-snapshot` | Verify mirrors match canonical |
|
|
15
|
-
| `npm run validate:contracts` |
|
|
33
|
+
| `npm run validate:contracts` | Shared-contract checks and focused contract tests |
|
|
34
|
+
| `npm run contracts:validate` | Comprehensive generated/shared contract, parity, runtime-conformance, and adversarial gate |
|
|
16
35
|
| `npm run check:agent-customization-drift` | Verify generated agent customization files are committed in a consumer workspace |
|
|
17
36
|
|
|
18
37
|
Workflow: change code → `npm run generate:contracts` → `npm run sync:parity-snapshot` → commit npm + vscode `contracts/`.
|
|
19
38
|
|
|
20
39
|
## Documents in this folder
|
|
21
40
|
|
|
22
|
-
| File | Purpose
|
|
23
|
-
| -------------------------------------------------------------- |
|
|
24
|
-
| [ARTIFACT_CATALOG.md](./ARTIFACT_CATALOG.md) | On-disk artifact paths, schema versions, and consumer rules
|
|
25
|
-
| [COMMAND_OWNERSHIP_MATRIX.md](./COMMAND_OWNERSHIP_MATRIX.md) | Which commands the npm wrapper owns vs Python Core
|
|
41
|
+
| File | Purpose |
|
|
42
|
+
| -------------------------------------------------------------- | ----------------------------------------------------------------- |
|
|
43
|
+
| [ARTIFACT_CATALOG.md](./ARTIFACT_CATALOG.md) | On-disk artifact paths, schema versions, and consumer rules |
|
|
44
|
+
| [COMMAND_OWNERSHIP_MATRIX.md](./COMMAND_OWNERSHIP_MATRIX.md) | Which commands the npm wrapper owns vs Python Core |
|
|
26
45
|
| [NAMING_AND_COEXISTENCE.md](./NAMING_AND_COEXISTENCE.md) | Workspace Intelligence command naming and generated surface rules |
|
|
27
|
-
| [RUNTIME_SUPPORT_MATRIX.md](./RUNTIME_SUPPORT_MATRIX.md) | Scaffold, import, lifecycle, and module support tiers
|
|
28
|
-
| [RUNTIME_ACCEPTANCE_MATRIX.md](./RUNTIME_ACCEPTANCE_MATRIX.md) | Runtime acceptance matrix expectations
|
|
29
|
-
| [rapidkit-cli-contracts.json](./rapidkit-cli-contracts.json) | Core CLI JSON schema fragments
|
|
46
|
+
| [RUNTIME_SUPPORT_MATRIX.md](./RUNTIME_SUPPORT_MATRIX.md) | Scaffold, import, lifecycle, and module support tiers |
|
|
47
|
+
| [RUNTIME_ACCEPTANCE_MATRIX.md](./RUNTIME_ACCEPTANCE_MATRIX.md) | Runtime acceptance matrix expectations |
|
|
48
|
+
| [rapidkit-cli-contracts.json](./rapidkit-cli-contracts.json) | Core CLI JSON schema fragments |
|
|
30
49
|
|
|
31
50
|
## Workspace intelligence schemas
|
|
32
51
|
|
|
33
52
|
Published under `../../contracts/` (not duplicated in this folder):
|
|
34
53
|
|
|
54
|
+
- `published-contract-catalog.v1.json` — complete machine-readable contract inventory
|
|
55
|
+
- `workspace-contract.v1.json` — canonical workspace project/relationship contract
|
|
56
|
+
- `runtime-command-surface.v1.json` and `cli-runtime-command-inventory.v1.snapshot.json` — supported command/capability discovery
|
|
57
|
+
- `workspace-intelligence-architecture.v1.json` and `workspace-intelligence-chain.v1.json` — architecture boundaries and ordered loop
|
|
35
58
|
- `workspace-registry.v1.json` — canonical project registry summary (see [ARTIFACT_CATALOG.md](./ARTIFACT_CATALOG.md))
|
|
36
59
|
- `release-readiness.v1.json` — release readiness gate evidence
|
|
37
60
|
- `workspace-run-last.v1.json` — multi-stage workspace run evidence
|
|
@@ -43,12 +66,21 @@ Published under `../../contracts/` (not duplicated in this folder):
|
|
|
43
66
|
- `project-entry-capability.v1.json` — open-ended adopt/import contract for readable projects
|
|
44
67
|
- `create-planner-capabilities.v1.json` — native, official, and existing capability lanes
|
|
45
68
|
- `agent-customization-pack.v1.json` — generated instructions, prompts, skills, agents, optional hooks, MCP-ready design metadata, target matrix, and drift state for AI agent surfaces
|
|
69
|
+
- `workspace-list.v1.json`, `workspace-sync.v1.json`, and `compatibility-matrix.v1.json` — workspace discovery, synchronization, and platform compatibility
|
|
70
|
+
- `project-archive.v1.json`, `workspace-snapshot.v1.json`, and `workspace-snapshot.v2.json` — recoverable lifecycle records
|
|
71
|
+
- `infra-plan.v1.json`, `private-product-manifest.v1.json`, and `product-factory-plan.v1.json` — infrastructure and product planning payloads
|
|
72
|
+
- `workspace-model-cache.v1.json`, `workspace-watch-event.v1.json`, `doctor-project-scan.v2.json`, and `doctor-workspace-cache.v2.json` — cache/watch/diagnostic support contracts
|
|
46
73
|
|
|
47
74
|
Workspace intelligence (`../../contracts/workspace-intelligence/`):
|
|
48
75
|
|
|
76
|
+
- `workspace-intelligence-run.v1.json` — authoritative full-chain result, stage outcomes, verdict, exit code, and durable artifact path
|
|
49
77
|
- `workspace-model.v1.json`
|
|
50
78
|
- `workspace-context.v1.json`
|
|
51
79
|
- `workspace-dependency-graph.v1.json`
|
|
80
|
+
- `workspace-knowledge-graph.v1.json` — proof-backed entities, relations, evidence, providers, and model binding
|
|
81
|
+
- `workspace-knowledge-graph-change-overlay.v1.json` — proposed/change-set facts and relations without mutating the base graph
|
|
82
|
+
- `workspace-knowledge-search.v1.json` — bounded ranked retrieval for CLI, MCP, IDE, and agent consumers
|
|
83
|
+
- `workspace-graph-token-efficiency.v1.json` — reproducible corpus-versus-retrieval payload measurement
|
|
52
84
|
- `workspace-model-snapshot.v1.json`
|
|
53
85
|
- `workspace-model-diff.v1.json`
|
|
54
86
|
- `workspace-impact.v1.json`
|
|
@@ -62,8 +94,15 @@ Workspace intelligence (`../../contracts/workspace-intelligence/`):
|
|
|
62
94
|
- `blocker-resolution.v1.json`
|
|
63
95
|
- `doctor-fix-result.v1.json`
|
|
64
96
|
- `studio-blocker-handoff.v1.json`
|
|
97
|
+
- `mcp-design.v1.json` and `agent-hooks.v1.json` — generated MCP/IDE integration surfaces
|
|
98
|
+
|
|
99
|
+
These schemas describe durable artifacts or bounded query results. A command's
|
|
100
|
+
stdout may wrap an artifact with operation metadata such as `status`,
|
|
101
|
+
`outputPath`, or a structured error; that envelope follows
|
|
102
|
+
`cli-operation-result.v1.json` and does not change the nested artifact contract.
|
|
65
103
|
|
|
66
|
-
CLI commands: see [commands-reference.md](../commands-reference.md) and
|
|
104
|
+
CLI commands: see [commands-reference.md](../commands-reference.md) and the
|
|
105
|
+
[CLI README](../../README.md#one-intelligence-chain).
|
|
67
106
|
|
|
68
107
|
## Core CLI JSON payloads
|
|
69
108
|
|
|
@@ -43,10 +43,10 @@ lifecycle failures only when the CLI prints actionable diagnostics such as
|
|
|
43
43
|
|
|
44
44
|
The matrix verifies:
|
|
45
45
|
|
|
46
|
-
- npm-owned global entrypoints: `--version
|
|
47
|
-
-
|
|
48
|
-
|
|
49
|
-
`
|
|
46
|
+
- npm-owned global entrypoints: `--version`, `-v`, and `commands --json`.
|
|
47
|
+
- delegated Core catalog surfaces in default/full modes: `version`, `list`,
|
|
48
|
+
`info`, `frameworks`, `modules`, and `license`. The normal
|
|
49
|
+
`workspai --version` path remains wrapper-owned.
|
|
50
50
|
- `create workspace` with a Python-free minimal profile.
|
|
51
51
|
- `create project` for npm-backed Go Fiber, Go Gin, Spring Boot, and ASP.NET
|
|
52
52
|
Core Clean Web API kits.
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Workspai Runtime Support Matrix
|
|
2
2
|
|
|
3
|
-
Last updated: 2026-
|
|
3
|
+
Last updated: 2026-07-18
|
|
4
4
|
|
|
5
5
|
This document defines the public support contract for Workspai workspace projects.
|
|
6
6
|
It separates three concerns:
|
|
7
7
|
|
|
8
|
-
- **First-class**: curated
|
|
8
|
+
- **First-class**: curated kit/framework with scaffold/import/govern/lifecycle support. Core module mutation additionally requires metadata for a module-enabled kit.
|
|
9
9
|
- **Extended**: scaffold/import/govern/lifecycle or import/govern workflows are supported, but Core module mutation is disabled unless explicitly added later.
|
|
10
10
|
- **Observed**: import/govern/contract visibility is supported; lifecycle commands may require manual project scripts or future adapters.
|
|
11
11
|
|
|
@@ -13,8 +13,8 @@ It separates three concerns:
|
|
|
13
13
|
|
|
14
14
|
| Runtime | Tier | Scaffold | Import | Lifecycle Commands | Module Commands | Doctor |
|
|
15
15
|
| ------------------- | ----------- | -------: | -----: | ------------------------------------------------- | --------------: | --------- |
|
|
16
|
-
| Python | first-class | yes | yes | init, dev, start, build, test, lint, format, help |
|
|
17
|
-
| Node.js | extended | yes | yes | init, dev, start, build, test, lint, format, help |
|
|
16
|
+
| Python | first-class | yes | yes | init, dev, start, build, test, lint, format, help | kit-dependent | full |
|
|
17
|
+
| Node.js | extended | yes | yes | init, dev, start, build, test, lint, format, help | kit-dependent | full |
|
|
18
18
|
| Go | extended | yes | yes | init, dev, start, build, test, lint, format, help | no | readiness |
|
|
19
19
|
| Java / Spring Boot | extended | yes | yes | init, dev, start, build, test, lint, format, help | no | readiness |
|
|
20
20
|
| .NET / ASP.NET Core | extended | yes | yes | init, dev, start, build, test, lint, format, help | no | readiness |
|
|
@@ -31,13 +31,17 @@ It separates three concerns:
|
|
|
31
31
|
|
|
32
32
|
## Framework Tiers
|
|
33
33
|
|
|
34
|
-
> **Runtime vs framework:** Python
|
|
34
|
+
> **Runtime vs framework:** Python remains a first-class runtime and Node.js is
|
|
35
|
+
> extended. Core module mutation is guaranteed only when project metadata names
|
|
36
|
+
> a module-enabled kit: `fastapi.standard`, `fastapi.ddd`, or
|
|
37
|
+
> `nestjs.standard`. Arbitrary FastAPI, NestJS, Python, Node.js, and frontend
|
|
38
|
+
> projects remain governable without gaining module mutation.
|
|
35
39
|
|
|
36
|
-
| Tier | Frameworks
|
|
37
|
-
| ----------- |
|
|
38
|
-
| first-class | FastAPI, NestJS
|
|
40
|
+
| Tier | Frameworks |
|
|
41
|
+
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
42
|
+
| first-class | FastAPI, NestJS |
|
|
39
43
|
| extended | Go/Fiber, Go/Gin, Spring Boot, ASP.NET Core, Django, Flask, Express, Fastify, Koa, Echo, Laravel, Symfony, Rails, Sinatra, Actix, Axum, Rocket, Phoenix, Next.js, Remix, React, Vue, Svelte, Solid, Nuxt, Angular, Astro, SvelteKit |
|
|
40
|
-
| observed | Python, Node.js, Go, Java, PHP, Ruby, Rust, Elixir, Unknown/generic projects
|
|
44
|
+
| observed | Python, Node.js, Go, Java, PHP, Ruby, Rust, Elixir, Unknown/generic projects |
|
|
41
45
|
|
|
42
46
|
## Import Policy
|
|
43
47
|
|
|
@@ -45,7 +49,7 @@ Imported projects are **observed and governed by default**:
|
|
|
45
49
|
|
|
46
50
|
- Workspai writes `.workspai/project.json` so workspace contract, graph, doctor, and sharing flows can discover the project.
|
|
47
51
|
- Workspai writes canonical project metadata to `.workspai/project.json` and reads legacy `.rapidkit/project.json` as fallback for older projects.
|
|
48
|
-
- Workspai writes `.workspai/import.json` and `.workspai/import-readiness.json` for auditability
|
|
52
|
+
- Workspai writes `.workspai/import.json` and `.workspai/import-readiness.json` for auditability while preserving existing Python Core or legacy `.rapidkit` project state.
|
|
49
53
|
- Secrets and dependency/build caches are not copied during local-folder import.
|
|
50
54
|
- `module_support` defaults to `false` for imported projects unless existing RapidKit metadata explicitly opts in.
|
|
51
55
|
|