workspai 0.46.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 +61 -12
- 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 +4 -0
- package/contracts/extension-cli-compatibility.v1.json +7 -1
- package/contracts/mirror-ops.v1.json +16 -0
- package/contracts/published-contract-catalog.v1.json +31 -0
- package/contracts/runtime-command-surface.v1.json +149 -1
- package/contracts/transparency-evidence.v1.json +13 -0
- package/contracts/workspace-contract.v1.json +78 -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 +6 -1
- 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 +6 -3
- package/contracts/workspace-intelligence-chain.v1.json +14 -3
- 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-UQWOVV6V.js → chunk-2GHUZDYA.js} +1 -1
- package/dist/chunk-2TEDAKP6.js +2 -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-J5PIZCAU.js → chunk-BSRVO52Y.js} +1 -1
- package/dist/chunk-COARSXRC.js +1 -0
- package/dist/chunk-CV5HKU4P.js +1 -0
- package/dist/chunk-CW7PGBIQ.js +13 -0
- package/dist/{chunk-WPEEC5BX.js → chunk-DV6GJD4K.js} +1 -1
- package/dist/chunk-FB7SCXAZ.js +1 -0
- package/dist/{chunk-4LGXSBCN.js → chunk-HSGFUKCN.js} +1 -1
- package/dist/{chunk-ZKAI3PJE.js → chunk-ITCAMC2E.js} +1 -1
- package/dist/chunk-KB44JP4M.js +2 -0
- package/dist/{chunk-QA5BGEQW.js → chunk-KZZ36CK5.js} +1 -1
- package/dist/chunk-LNRAB7UY.js +1 -0
- package/dist/{chunk-VFDM65IE.js → chunk-MEMHNE7Y.js} +22 -22
- 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-6IIZJQLV.js → chunk-U5EZHZBX.js} +1 -1
- package/dist/{chunk-YUATNVOT.js → chunk-VBSQ7MF6.js} +19 -19
- 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-WCV3L6XH.js → create-7JKJDAQV.js} +1 -1
- package/dist/{doctor-5BWM2EMJ.js → doctor-PGPNIS76.js} +1 -1
- package/dist/index.d.ts +33 -12
- package/dist/index.js +317 -317
- package/dist/pipeline-IB6ILJSV.js +5 -0
- package/dist/{workspace-7OXW5YTJ.js → workspace-H3QXBFGB.js} +1 -1
- package/dist/{workspace-agent-sync-O4IA6VOA.js → workspace-agent-sync-C7SG2Z5W.js} +1 -1
- package/dist/{workspace-archive-H74NBBNW.js → workspace-archive-P76EDIUG.js} +1 -1
- package/dist/{workspace-context-R7IPUBPG.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-SVFJAAEI.js → workspace-explain-contract-SEFTVF6J.js} +1 -1
- package/dist/{workspace-feedback-REOS36ZZ.js → workspace-feedback-WAID3IOE.js} +1 -1
- package/dist/{workspace-foundation-KXT4QI5O.js → workspace-foundation-5OOJEO2D.js} +1 -1
- package/dist/workspace-graph-token-efficiency-CFGFCJ5V.js +1 -0
- package/dist/{workspace-history-OGOVSKZG.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-registry-summary-SZ46R5PD.js → workspace-registry-summary-A3YDL63D.js} +1 -1
- package/dist/workspace-run-M4LNJILC.js +1 -0
- package/dist/{workspace-verify-MFQ7IXGD.js → workspace-verify-ZGH3NXAH.js} +1 -1
- package/dist/workspace-watch-EVBJTMV7.js +1 -0
- package/docs/AI_DYNAMIC_INTEGRATION.md +73 -428
- package/docs/AI_EXAMPLES.md +37 -395
- package/docs/AI_FEATURES.md +76 -456
- package/docs/AI_QUICKSTART.md +49 -212
- package/docs/GLOSSARY.md +60 -0
- package/docs/OPEN_SOURCE_USER_SCENARIOS.md +68 -7
- package/docs/README.md +63 -41
- package/docs/commands-reference.md +51 -4
- package/docs/config-file-guide.md +6 -2
- package/docs/contracts/ARTIFACT_CATALOG.md +67 -37
- package/docs/contracts/README.md +44 -8
- package/docs/graph-benchmark-methodology.md +121 -0
- package/docs/workspace-knowledge-graph.md +295 -0
- package/docs/workspace-operations.md +49 -0
- package/package.json +2 -1
- package/dist/analyze-BEBEZSZK.js +0 -1
- package/dist/artifact-remediation-plan-FFQSESAM.js +0 -3
- package/dist/autopilot-release-WUR4CQIT.js +0 -1
- package/dist/chunk-2G7FASAO.js +0 -2
- package/dist/chunk-4EPHWD27.js +0 -8
- package/dist/chunk-CVHMUSRX.js +0 -1
- package/dist/chunk-DIPD72H4.js +0 -2
- package/dist/chunk-EFYHGCGX.js +0 -2
- package/dist/chunk-FWRXA435.js +0 -2
- package/dist/chunk-HDURFXW5.js +0 -2
- package/dist/chunk-HMUKBW2S.js +0 -4
- package/dist/chunk-K4WNYXKK.js +0 -33
- package/dist/chunk-LG6RFLPZ.js +0 -1
- package/dist/chunk-N7DV5L7C.js +0 -1
- package/dist/chunk-PRBVYW3T.js +0 -1
- package/dist/chunk-QZLIURER.js +0 -13
- package/dist/chunk-RIEF2DDX.js +0 -8
- package/dist/chunk-SXMTSV5M.js +0 -1
- package/dist/chunk-SXPY523X.js +0 -1
- package/dist/chunk-V3LRQZ36.js +0 -1
- package/dist/chunk-WYFPXTTS.js +0 -2
- package/dist/pipeline-ORIWVVYM.js +0 -5
- package/dist/workspace-contract-HKCMOMFE.js +0 -1
- package/dist/workspace-explain-GOPQYTPQ.js +0 -1
- package/dist/workspace-intelligence-7IESQSXY.js +0 -1
- package/dist/workspace-intelligence-runner-6GJ5M4HB.js +0 -1
- package/dist/workspace-mcp-serve-FRVWBO36.js +0 -3
- package/dist/workspace-model-PPYX7B4S.js +0 -1
- package/dist/workspace-run-V3KKHTVF.js +0 -1
- package/dist/workspace-watch-SOPZHRWA.js +0 -1
package/docs/README.md
CHANGED
|
@@ -27,6 +27,7 @@ instructions; see the [Artifact Catalog](./contracts/ARTIFACT_CATALOG.md).
|
|
|
27
27
|
|
|
28
28
|
## Table of contents
|
|
29
29
|
|
|
30
|
+
- [Choose a guide by goal](#choose-a-guide-by-goal)
|
|
30
31
|
- [User documentation](#user-documentation)
|
|
31
32
|
- [Operations & security](#operations--security)
|
|
32
33
|
- [AI module recommendations](#ai-module-recommendations)
|
|
@@ -34,23 +35,44 @@ instructions; see the [Artifact Catalog](./contracts/ARTIFACT_CATALOG.md).
|
|
|
34
35
|
- [Contributor documentation](#contributor-documentation)
|
|
35
36
|
- [Validation commands](#validation-commands)
|
|
36
37
|
|
|
38
|
+
## Choose a guide by goal
|
|
39
|
+
|
|
40
|
+
| I want to… | Start here | Expected outcome |
|
|
41
|
+
| ---------------------------------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
|
42
|
+
| Create a workspace or project | [Creating workspaces and projects](./creating-workspaces-and-projects.md) | A registered project with canonical `.workspai` metadata |
|
|
43
|
+
| Bring an existing repository under governance | [Workspace operations](./workspace-operations.md#import-and-adoption) | Source stays in place with `adopt`, or is copied/cloned with `import` |
|
|
44
|
+
| Run the complete intelligence loop | [Unified runner](./workspace-intelligence-runner.md) | One ordered run report with durable stage evidence |
|
|
45
|
+
| Ask an architecture or dependency question | [Workspace Knowledge Graph](./workspace-knowledge-graph.md) | A bounded answer with proof references rather than the whole graph |
|
|
46
|
+
| Integrate CI or release gates | [CI workflows](./ci-workflows.md) | Machine-readable exit codes and uploadable evidence |
|
|
47
|
+
| Find the writer, schema, or path for an output | [Artifact Catalog](./contracts/ARTIFACT_CATALOG.md) | One canonical source instead of path guessing |
|
|
48
|
+
| Understand Workspai terminology | [Glossary](./GLOSSARY.md) | Shared meanings for model, graph, evidence, gate, and artifacts |
|
|
49
|
+
| Contribute to the CLI | [Development](./DEVELOPMENT.md) | Local build, test, contract, and documentation gates |
|
|
50
|
+
|
|
51
|
+
There are two different AI-facing features. Workspace Intelligence is
|
|
52
|
+
deterministic, proof-backed, and does not require an AI API key. The optional
|
|
53
|
+
module recommender uses embeddings to suggest FastAPI or NestJS modules; start
|
|
54
|
+
with [AI Quickstart](./AI_QUICKSTART.md) only when that is your goal.
|
|
55
|
+
|
|
37
56
|
## User documentation
|
|
38
57
|
|
|
39
|
-
| Document
|
|
40
|
-
|
|
|
41
|
-
| [creating-workspaces-and-projects.md](./creating-workspaces-and-projects.md)
|
|
42
|
-
| [commands-reference.md](./commands-reference.md)
|
|
43
|
-
| [workspace-operations.md](./workspace-operations.md)
|
|
44
|
-
| [workspace-run.md](./workspace-run.md)
|
|
45
|
-
| [workspace-intelligence-runner.md](./workspace-intelligence-runner.md)
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
48
|
-
| [
|
|
49
|
-
| [
|
|
50
|
-
| [
|
|
51
|
-
| [
|
|
52
|
-
| [
|
|
53
|
-
| [
|
|
58
|
+
| Document | Description |
|
|
59
|
+
| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
60
|
+
| [creating-workspaces-and-projects.md](./creating-workspaces-and-projects.md) | Plain-language guide to every workspace and project creation scenario |
|
|
61
|
+
| [commands-reference.md](./commands-reference.md) | Full CLI syntax, profiles, and policy keys |
|
|
62
|
+
| [workspace-operations.md](./workspace-operations.md) | Import, adopt, snapshots, archives, contracts, infra |
|
|
63
|
+
| [workspace-run.md](./workspace-run.md) | Polyglot fleet orchestration (`workspace run`) |
|
|
64
|
+
| [workspace-intelligence-runner.md](./workspace-intelligence-runner.md) | Canonical unified runner, execution envelope, report schema, exit codes, failure propagation, and CI consumption |
|
|
65
|
+
| [workspace-knowledge-graph.md](./workspace-knowledge-graph.md) | Two-minute graph quickstart, proof model, AI/MCP consumption, performance, and honest token-efficiency measurement |
|
|
66
|
+
| [graph-benchmark-methodology.md](./graph-benchmark-methodology.md) | Reproducible payload-reduction benchmark, formulas, claim boundaries, and publication rules |
|
|
67
|
+
| [GLOSSARY.md](./GLOSSARY.md) | Plain-language definitions for workspace, model, graph, evidence, gates, and AI integrations |
|
|
68
|
+
| [create-planner-capabilities.md](./create-planner-capabilities.md) | Native create, official, and existing lanes |
|
|
69
|
+
| [../contracts/project-entry-capability.v1.json](../contracts/project-entry-capability.v1.json) | Contract: any readable project can enter through adopt/import when it can be registered |
|
|
70
|
+
| [from-code-to-shared-understanding.md](./from-code-to-shared-understanding.md) | GitHub-rendered Workspace Intelligence diagram |
|
|
71
|
+
| [OPEN_SOURCE_USER_SCENARIOS.md](./OPEN_SOURCE_USER_SCENARIOS.md) | Role-based workflows (junior → enterprise) |
|
|
72
|
+
| [doctor-command.md](./doctor-command.md) | Doctor scopes, CI exit codes, JSON evidence |
|
|
73
|
+
| [config-file-guide.md](./config-file-guide.md) | User config file (`~/.workspairc.json`, `workspai.config.*`, with legacy fallbacks) |
|
|
74
|
+
| [WORKSPACE_MARKER_SPEC.md](./WORKSPACE_MARKER_SPEC.md) | Workspace marker format |
|
|
75
|
+
| [PACKAGE_MANAGER_POLICY.md](./PACKAGE_MANAGER_POLICY.md) | npm-only policy for this repository |
|
|
54
76
|
|
|
55
77
|
**Common tasks**
|
|
56
78
|
|
|
@@ -63,35 +85,35 @@ instructions; see the [Artifact Catalog](./contracts/ARTIFACT_CATALOG.md).
|
|
|
63
85
|
|
|
64
86
|
## Operations & security
|
|
65
87
|
|
|
66
|
-
| Document
|
|
67
|
-
|
|
|
68
|
-
| [SECURITY.md](./SECURITY.md)
|
|
69
|
-
| [policies.workspace.example.yml](./policies.workspace.example.yml)
|
|
70
|
-
| [governance-policy.enterprise.example.json](./governance-policy.enterprise.example.json) | Sigstore governance allowlist template
|
|
71
|
-
| [mirror-config.enterprise.example.json](./mirror-config.enterprise.example.json)
|
|
88
|
+
| Document | Description |
|
|
89
|
+
| ---------------------------------------------------------------------------------------- | ---------------------------------------------- |
|
|
90
|
+
| [SECURITY.md](./SECURITY.md) | Vulnerability reporting and supported versions |
|
|
91
|
+
| [policies.workspace.example.yml](./policies.workspace.example.yml) | Workspace policy template |
|
|
92
|
+
| [governance-policy.enterprise.example.json](./governance-policy.enterprise.example.json) | Sigstore governance allowlist template |
|
|
93
|
+
| [mirror-config.enterprise.example.json](./mirror-config.enterprise.example.json) | Mirror + evidence export template |
|
|
72
94
|
|
|
73
95
|
## AI module recommendations
|
|
74
96
|
|
|
75
97
|
FastAPI/NestJS module suggestions via OpenAI embeddings (optional).
|
|
76
98
|
|
|
77
|
-
| Document
|
|
78
|
-
|
|
|
79
|
-
| [AI_QUICKSTART.md](./AI_QUICKSTART.md)
|
|
80
|
-
| [AI_FEATURES.md](./AI_FEATURES.md)
|
|
81
|
-
| [AI_EXAMPLES.md](./AI_EXAMPLES.md)
|
|
82
|
-
| [AI_DYNAMIC_INTEGRATION.md](./AI_DYNAMIC_INTEGRATION.md) | Integration architecture
|
|
99
|
+
| Document | Description |
|
|
100
|
+
| -------------------------------------------------------- | -------------------------- |
|
|
101
|
+
| [AI_QUICKSTART.md](./AI_QUICKSTART.md) | 60-second setup |
|
|
102
|
+
| [AI_FEATURES.md](./AI_FEATURES.md) | Complete feature reference |
|
|
103
|
+
| [AI_EXAMPLES.md](./AI_EXAMPLES.md) | Use-case examples |
|
|
104
|
+
| [AI_DYNAMIC_INTEGRATION.md](./AI_DYNAMIC_INTEGRATION.md) | Integration architecture |
|
|
83
105
|
|
|
84
106
|
## Technical contracts
|
|
85
107
|
|
|
86
108
|
JSON schemas and ownership rules for tooling parity.
|
|
87
109
|
|
|
88
|
-
| Location
|
|
89
|
-
|
|
|
90
|
-
| [contracts/README.md](./contracts/README.md)
|
|
91
|
-
| [contracts/COMMAND_OWNERSHIP_MATRIX.md](./contracts/COMMAND_OWNERSHIP_MATRIX.md)
|
|
92
|
-
| [contracts/RUNTIME_SUPPORT_MATRIX.md](./contracts/RUNTIME_SUPPORT_MATRIX.md)
|
|
93
|
-
| [contracts/RUNTIME_ACCEPTANCE_MATRIX.md](./contracts/RUNTIME_ACCEPTANCE_MATRIX.md) | Runtime acceptance test expectations
|
|
94
|
-
| [../contracts/](../contracts/)
|
|
110
|
+
| Location | Description |
|
|
111
|
+
| ---------------------------------------------------------------------------------- | ------------------------------------------------- |
|
|
112
|
+
| [contracts/README.md](./contracts/README.md) | Core CLI JSON contracts + generator scripts |
|
|
113
|
+
| [contracts/COMMAND_OWNERSHIP_MATRIX.md](./contracts/COMMAND_OWNERSHIP_MATRIX.md) | npm wrapper vs Core command ownership |
|
|
114
|
+
| [contracts/RUNTIME_SUPPORT_MATRIX.md](./contracts/RUNTIME_SUPPORT_MATRIX.md) | Scaffold/import/lifecycle support tiers |
|
|
115
|
+
| [contracts/RUNTIME_ACCEPTANCE_MATRIX.md](./contracts/RUNTIME_ACCEPTANCE_MATRIX.md) | Runtime acceptance test expectations |
|
|
116
|
+
| [../contracts/](../contracts/) | Canonical JSON schemas (published in npm tarball) |
|
|
95
117
|
|
|
96
118
|
Regenerate and verify:
|
|
97
119
|
|
|
@@ -103,13 +125,13 @@ npm run contracts:validate
|
|
|
103
125
|
|
|
104
126
|
## Contributor documentation
|
|
105
127
|
|
|
106
|
-
| Document
|
|
107
|
-
|
|
|
108
|
-
| [DEVELOPMENT.md](./DEVELOPMENT.md)
|
|
109
|
-
| [SETUP.md](./SETUP.md)
|
|
110
|
-
| [ci-workflows.md](./ci-workflows.md)
|
|
111
|
-
| [OPTIMIZATION_GUIDE.md](./OPTIMIZATION_GUIDE.md) | Performance and improvement notes
|
|
112
|
-
| [UTILITIES.md](./UTILITIES.md)
|
|
128
|
+
| Document | Description |
|
|
129
|
+
| ------------------------------------------------ | ----------------------------------------- |
|
|
130
|
+
| [DEVELOPMENT.md](./DEVELOPMENT.md) | Local dev, testing, debugging |
|
|
131
|
+
| [SETUP.md](./SETUP.md) | Build gates, smoke flows, release hygiene |
|
|
132
|
+
| [ci-workflows.md](./ci-workflows.md) | GitHub Actions workflow map |
|
|
133
|
+
| [OPTIMIZATION_GUIDE.md](./OPTIMIZATION_GUIDE.md) | Performance and improvement notes |
|
|
134
|
+
| [UTILITIES.md](./UTILITIES.md) | Internal cache and metrics helpers |
|
|
113
135
|
|
|
114
136
|
Also see [../CONTRIBUTING.md](../CONTRIBUTING.md) and [../CHANGELOG.md](../CHANGELOG.md).
|
|
115
137
|
|
|
@@ -65,7 +65,7 @@ npx workspai workspace snapshot [--workspace <path>] [--json] [--include-paths]
|
|
|
65
65
|
npx workspai workspace diff --from <snapshot-or-report|git[:ref]> [--workspace <path>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>] [--strict]
|
|
66
66
|
npx workspai workspace impact --from <workspace-diff-report> [--workspace <path>] [--scope project:<name>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>] [--strict]
|
|
67
67
|
npx workspai workspace verify [--from-impact <file>] [--workspace <path>] [--scope project:<name>] [--strict] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>]
|
|
68
|
-
npx workspai workspace graph [emit|explain|dot|mermaid] [key] [--workspace <path>] [--scope project:<name>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>]
|
|
68
|
+
npx workspai workspace graph [emit|explain|search|benchmark|entities|evidence|path|overlay|dot|mermaid] [key] [value] [--from <graph.json>] [--limit <1..100>] [--workspace <path>] [--scope project:<name>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>]
|
|
69
69
|
npx workspai workspace watch [--workspace <path>] [--json] [--once] [--scan-depth <count>]
|
|
70
70
|
npx workspai workspace explain|why <target> [--workspace <path>] [--json] [--write]
|
|
71
71
|
npx workspai workspace trace --from <workspace-diff-report> [--workspace <path>] [--json] [--write]
|
|
@@ -94,6 +94,17 @@ npx workspai infra down [--workspace <path>] [--volumes]
|
|
|
94
94
|
npx workspai infra status [--workspace <path>] [--json] [--strict]
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
+
The contract graph includes its backward-compatible service projection, the
|
|
98
|
+
canonical `workspace-dependency-graph.v1` project topology, and the portable
|
|
99
|
+
`workspace-knowledge-graph.v1` evidence graph. The knowledge projection covers
|
|
100
|
+
workspace/project structure, packages and dependencies, source files, modules,
|
|
101
|
+
symbols, HTTP endpoints, OpenAPI/GraphQL/Protocol Buffers/AsyncAPI contracts,
|
|
102
|
+
Compose/Kubernetes/Dockerfile/Terraform/Helm infrastructure, CI workflows,
|
|
103
|
+
documentation, ADRs, tests, owners, environments, databases, and queues.
|
|
104
|
+
Every entity and relation has stable identity and portable proof paths; proof
|
|
105
|
+
taxonomy separates authored, extracted, and inferred facts and records trust,
|
|
106
|
+
confidence, and freshness. Environment and secret values are never emitted.
|
|
107
|
+
|
|
97
108
|
`workspace intelligence run` writes
|
|
98
109
|
`.workspai/reports/workspace-intelligence-run-last-run.json`. Its `preflight`
|
|
99
110
|
contains exactly `sync` and `baseline`, while `stages` contains exactly the 11
|
|
@@ -114,9 +125,45 @@ records are appended to
|
|
|
114
125
|
`.workspai/reports/workspace-intelligence-history.json`; no separate feedback
|
|
115
126
|
artifact is created.
|
|
116
127
|
|
|
117
|
-
`workspace graph
|
|
118
|
-
|
|
119
|
-
|
|
128
|
+
`workspace graph emit --json` returns both the compatibility project graph and
|
|
129
|
+
the knowledge graph. Use `workspace graph entities [kind]`, `workspace graph
|
|
130
|
+
evidence <id-or-unique-label>`, and `workspace graph path <from> <to>` for
|
|
131
|
+
indexed queries. `workspace graph overlay --from <prior-graph.json>` produces a
|
|
132
|
+
portable change/PR overlay with additions, removals, changed fields, proof
|
|
133
|
+
artifacts, proof additions/removals/content changes, bounded one-hop impact,
|
|
134
|
+
and a risk summary. Observation timestamps and freshness alone do not create
|
|
135
|
+
false change noise. Query indexes are cached
|
|
136
|
+
per immutable graph object and invalidated automatically when a new graph is
|
|
137
|
+
built. `dot` and `mermaid` intentionally remain project-topology renderers and
|
|
138
|
+
emit raw text for direct piping.
|
|
139
|
+
|
|
140
|
+
`workspace graph search <query> --limit <n> --json` returns bounded entities,
|
|
141
|
+
one-hop relations, related entity summaries, and portable proofs instead of the
|
|
142
|
+
complete graph. `workspace graph benchmark <query> --limit <n> --json` compares
|
|
143
|
+
that retrieval payload with the readable proof-indexed corpus using a labelled
|
|
144
|
+
`characters / 4` estimate. It measures payload reduction only; it does not
|
|
145
|
+
assert equivalent answer quality or model-specific billing savings.
|
|
146
|
+
|
|
147
|
+
`workspace model --write` also materializes the derived, contract-validated
|
|
148
|
+
knowledge graph at `.workspai/reports/workspace-knowledge-graph.json`. The
|
|
149
|
+
unified intelligence runner treats that artifact as a required output of the
|
|
150
|
+
Model step, so CI, IDE adapters, agent grounding, and MCP all observe the same
|
|
151
|
+
revision. Agent contexts carry its reference, quality counts, and bounded query
|
|
152
|
+
commands instead of copying the entire graph into every prompt. MCP exposes
|
|
153
|
+
`getWorkspaceKnowledgeGraph`, `searchWorkspaceGraph`, `queryWorkspaceEntities`,
|
|
154
|
+
`getWorkspaceGraphEvidence`, and `findWorkspaceGraphPath`.
|
|
155
|
+
|
|
156
|
+
Source extraction is bounded and language-neutral by contract. It recognizes
|
|
157
|
+
the primary source formats for TypeScript/JavaScript, Python, Go, Java/Kotlin,
|
|
158
|
+
.NET/F#, Rust, Ruby, PHP, Swift, Dart, Elixir, Scala, Clojure, Lua, R, C/C++,
|
|
159
|
+
Vue, and Svelte. Package baselines also recognize npm/Deno, Python, Go, Cargo,
|
|
160
|
+
Maven/Gradle, NuGet, Composer, Ruby, Elixir, Dart, SwiftPM, CMake, Bazel, and SBT.
|
|
161
|
+
Regex-backed
|
|
162
|
+
source facts are marked `observed` with medium confidence; authored manifests
|
|
163
|
+
and interface/infrastructure specifications remain authoritative. This avoids
|
|
164
|
+
presenting heuristic symbol discovery as compiler-grade truth while keeping the
|
|
165
|
+
current CLI useful until deeper language providers move into the standalone
|
|
166
|
+
graph package.
|
|
120
167
|
|
|
121
168
|
See [workspace-run.md](./workspace-run.md) for fleet orchestration semantics.
|
|
122
169
|
|
|
@@ -14,7 +14,7 @@ Supported fields include:
|
|
|
14
14
|
{
|
|
15
15
|
"defaultKit": "fastapi.standard",
|
|
16
16
|
"defaultInstallMethod": "poetry",
|
|
17
|
-
"pythonVersion": "3.
|
|
17
|
+
"pythonVersion": "3.10",
|
|
18
18
|
"author": "Platform Team",
|
|
19
19
|
"license": "MIT",
|
|
20
20
|
"skipGit": false,
|
|
@@ -56,7 +56,7 @@ Example:
|
|
|
56
56
|
module.exports = {
|
|
57
57
|
workspace: {
|
|
58
58
|
defaultAuthor: 'Platform Team',
|
|
59
|
-
pythonVersion: '3.
|
|
59
|
+
pythonVersion: '3.10',
|
|
60
60
|
installMethod: 'poetry',
|
|
61
61
|
},
|
|
62
62
|
projects: {
|
|
@@ -66,6 +66,10 @@ module.exports = {
|
|
|
66
66
|
};
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
+
Python-backed workflows require Python 3.10 or newer. `pythonVersion` selects a
|
|
70
|
+
project target; it does not make Python a dependency for Node-only or other
|
|
71
|
+
Python-free Workspai workflows.
|
|
72
|
+
|
|
69
73
|
## Command coverage
|
|
70
74
|
|
|
71
75
|
Directory configuration is currently consumed by the legacy top-level creation
|
|
@@ -72,22 +72,29 @@ 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
|
|
90
|
-
| `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` |
|
|
91
98
|
|
|
92
99
|
The unified runner report separates its execution envelope from the canonical
|
|
93
100
|
intelligence chain. `preflight` always contains exactly `sync` and `baseline`;
|
|
@@ -99,6 +106,11 @@ status/exit coherence, hard-failure skip propagation, and the aggregate verdict.
|
|
|
99
106
|
See [Unified Workspace Intelligence Runner](../workspace-intelligence-runner.md)
|
|
100
107
|
for the normative user and integration semantics.
|
|
101
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.
|
|
113
|
+
|
|
102
114
|
**CLI semantics:** `workspace diff --from` expects a **model or snapshot** baseline. `workspace impact --from` expects a **diff report**.
|
|
103
115
|
Persisted artifacts retain their artifact schema. JSON command projections that add operation metadata
|
|
104
116
|
such as `outputPath`, `status`, or structured errors use
|
|
@@ -188,11 +200,18 @@ block, in `warn` mode they escalate to needs-attention.
|
|
|
188
200
|
a dependency change makes every dependent stale deterministically. The verdict compares against
|
|
189
201
|
the previously written verify report. Canonical source: `src/workspace-graph-freshness.ts`.
|
|
190
202
|
|
|
191
|
-
**Graph command surface.** `workspace graph` emits the graph plus
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
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.
|
|
196
215
|
|
|
197
216
|
### Model cache (`workspace-model-cache.v1`)
|
|
198
217
|
|
|
@@ -262,19 +281,19 @@ Canonical source: `src/observability/run-correlation.ts` (`attachRunCorrelation`
|
|
|
262
281
|
|
|
263
282
|
## Operational / platform
|
|
264
283
|
|
|
265
|
-
| Command | Artifact
|
|
266
|
-
| -------------------------------- |
|
|
267
|
-
| `workspace run` | `workspace-run-last.json`
|
|
268
|
-
| `autopilot release` (run stages) | same `workspace-run-last.json`
|
|
269
|
-
| `bootstrap` | `bootstrap-compliance-{ts}.json`, `bootstrap-compliance.latest.json`
|
|
270
|
-
| `mirror status` | `mirror-ops-{ts}.json`, `mirror-ops.latest.json`
|
|
271
|
-
| `mirror` (transparency) | `transparency-evidence-{ts}.json`, `transparency-evidence.latest.json` |
|
|
272
|
-
| `infra plan` | `infra-plan.json`
|
|
273
|
-
| `workspace archive` | `.workspai/archive-manifest.json` inside ZIP/ZIP64
|
|
274
|
-
| `workspace share` | `reports/share-bundle.json` (default)
|
|
275
|
-
| `import` | `{project}/.workspai/import.json`, `{project}/.workspai/import-readiness.json` | Copied/cloned project metadata and readiness
|
|
276
|
-
| `adopt` | `{project}/.workspai/adopt.json`, `{project}/.workspai/adopt-readiness.json` | In-place project metadata and readiness
|
|
277
|
-
| `workspace contract verify` | `workspace-contract-verify-last-run.json`
|
|
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` |
|
|
278
297
|
|
|
279
298
|
## Static capability contracts
|
|
280
299
|
|
|
@@ -320,18 +339,29 @@ them as portable repository contracts. The portable source is
|
|
|
320
339
|
|
|
321
340
|
Under `{project}/.workspai/reports/` when commands run at project scope (e.g. project doctor). Workspace-level reports stay under `{workspace}/.workspai/reports/`.
|
|
322
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
|
+
|
|
323
347
|
## Consumer rules
|
|
324
348
|
|
|
325
349
|
1. **Project count:** read `workspace-registry.v1.json` (or run `workspace registry status --json`).
|
|
326
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.
|
|
327
351
|
3. **Do not** use `workspace.json.projects` (removed in schema 1.0).
|
|
328
352
|
4. Prefer `schemaVersion` constants in each artifact; legacy `v1` on readiness is accepted when reading old reports.
|
|
329
|
-
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`.
|
|
330
355
|
|
|
331
356
|
## Agent customization files (repo hooks)
|
|
332
357
|
|
|
333
358
|
Written by `workspace agent-sync --write --refresh-context --preset enterprise` (and by default after `workspace context --for-agent --write`):
|
|
334
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
|
+
|
|
335
365
|
| Path | Consumer |
|
|
336
366
|
| ----------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
337
367
|
| `AGENTS.md` | Copilot, Cursor, Claude Code, Codex, Grok (open standard) |
|
|
@@ -345,7 +375,7 @@ Written by `workspace agent-sync --write --refresh-context --preset enterprise`
|
|
|
345
375
|
| `.github/prompts/workspai-adopt-project.prompt.md` | Copilot adopt/import workflow prompt |
|
|
346
376
|
| `.github/skills/workspai-grounding/SKILL.md` | Copilot skills |
|
|
347
377
|
| `.github/skills/workspai-workspace-intelligence/SKILL.md` | Enterprise Workspace Intelligence skill |
|
|
348
|
-
| `.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 |
|
|
349
379
|
| `.github/agents/workspai-advisor.agent.md` | Read-only workspace advisor agent |
|
|
350
380
|
| `.github/agents/workspai-repair.agent.md` | Blocker repair agent |
|
|
351
381
|
| `.github/agents/workspai-release.agent.md` | Release safety agent |
|
|
@@ -353,7 +383,7 @@ Written by `workspace agent-sync --write --refresh-context --preset enterprise`
|
|
|
353
383
|
| `.cursor/rules/workspai-grounding.mdc` | Cursor always-on rule |
|
|
354
384
|
| `CLAUDE.md` | Claude Code (imports `@AGENTS.md`) |
|
|
355
385
|
| `.claude/rules/workspai-evidence.md` | Claude Code scoped evidence rule |
|
|
356
|
-
| `.claude/rules/rapidkit-evidence.md` | Legacy
|
|
386
|
+
| `.claude/rules/rapidkit-evidence.md` | Legacy compatibility alias pointing to the canonical rule |
|
|
357
387
|
| `.workspai/AGENT-GROUNDING.md` | Tool-agnostic operator doc |
|
|
358
388
|
| `.workspai/reports/agent-customization-pack.json` | Versioned output inventory, target matrix, drift state |
|
|
359
389
|
| `.workspai/reports/workspai-mcp-design.json` | Read-mostly MCP-ready design manifest |
|
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,7 +30,7 @@ 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` | Shared-contract checks and focused contract tests
|
|
33
|
+
| `npm run validate:contracts` | Shared-contract checks and focused contract tests |
|
|
16
34
|
| `npm run contracts:validate` | Comprehensive generated/shared contract, parity, runtime-conformance, and adversarial gate |
|
|
17
35
|
| `npm run check:agent-customization-drift` | Verify generated agent customization files are committed in a consumer workspace |
|
|
18
36
|
|
|
@@ -20,19 +38,23 @@ Workflow: change code → `npm run generate:contracts` → `npm run sync:parity-
|
|
|
20
38
|
|
|
21
39
|
## Documents in this folder
|
|
22
40
|
|
|
23
|
-
| File | Purpose
|
|
24
|
-
| -------------------------------------------------------------- |
|
|
25
|
-
| [ARTIFACT_CATALOG.md](./ARTIFACT_CATALOG.md) | On-disk artifact paths, schema versions, and consumer rules
|
|
26
|
-
| [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 |
|
|
27
45
|
| [NAMING_AND_COEXISTENCE.md](./NAMING_AND_COEXISTENCE.md) | Workspace Intelligence command naming and generated surface rules |
|
|
28
|
-
| [RUNTIME_SUPPORT_MATRIX.md](./RUNTIME_SUPPORT_MATRIX.md) | Scaffold, import, lifecycle, and module support tiers
|
|
29
|
-
| [RUNTIME_ACCEPTANCE_MATRIX.md](./RUNTIME_ACCEPTANCE_MATRIX.md) | Runtime acceptance matrix expectations
|
|
30
|
-
| [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 |
|
|
31
49
|
|
|
32
50
|
## Workspace intelligence schemas
|
|
33
51
|
|
|
34
52
|
Published under `../../contracts/` (not duplicated in this folder):
|
|
35
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
|
|
36
58
|
- `workspace-registry.v1.json` — canonical project registry summary (see [ARTIFACT_CATALOG.md](./ARTIFACT_CATALOG.md))
|
|
37
59
|
- `release-readiness.v1.json` — release readiness gate evidence
|
|
38
60
|
- `workspace-run-last.v1.json` — multi-stage workspace run evidence
|
|
@@ -44,6 +66,10 @@ Published under `../../contracts/` (not duplicated in this folder):
|
|
|
44
66
|
- `project-entry-capability.v1.json` — open-ended adopt/import contract for readable projects
|
|
45
67
|
- `create-planner-capabilities.v1.json` — native, official, and existing capability lanes
|
|
46
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
|
|
47
73
|
|
|
48
74
|
Workspace intelligence (`../../contracts/workspace-intelligence/`):
|
|
49
75
|
|
|
@@ -51,6 +77,10 @@ Workspace intelligence (`../../contracts/workspace-intelligence/`):
|
|
|
51
77
|
- `workspace-model.v1.json`
|
|
52
78
|
- `workspace-context.v1.json`
|
|
53
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
|
|
54
84
|
- `workspace-model-snapshot.v1.json`
|
|
55
85
|
- `workspace-model-diff.v1.json`
|
|
56
86
|
- `workspace-impact.v1.json`
|
|
@@ -64,6 +94,12 @@ Workspace intelligence (`../../contracts/workspace-intelligence/`):
|
|
|
64
94
|
- `blocker-resolution.v1.json`
|
|
65
95
|
- `doctor-fix-result.v1.json`
|
|
66
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.
|
|
67
103
|
|
|
68
104
|
CLI commands: see [commands-reference.md](../commands-reference.md) and the
|
|
69
105
|
[CLI README](../../README.md#one-intelligence-chain).
|