workspai 0.48.0 → 0.50.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 +151 -75
- package/contracts/analyze-last-run.v1.json +2 -2
- package/contracts/artifact-remediation-plan.v1.json +3 -9
- package/contracts/autopilot-release.v1.json +2 -0
- package/contracts/bootstrap-compliance.v1.json +2 -1
- package/contracts/cli-log-event.v1.json +1 -1
- package/contracts/cli-runtime-command-inventory.v1.snapshot.json +84 -0
- package/contracts/compatibility-matrix.v1.json +2 -0
- package/contracts/create-planner-capabilities.v1.json +144 -32
- package/contracts/doctor-project-evidence.v1.json +191 -11
- package/contracts/doctor-project-scan.v2.json +2 -0
- package/contracts/doctor-remediation-plan.v1.json +2 -2
- package/contracts/doctor-remediation-plan.v2.json +2 -2
- package/contracts/doctor-workspace-cache.v2.json +2 -0
- package/contracts/doctor-workspace-evidence.v1.json +189 -10
- package/contracts/extension-cli-compatibility.v1.json +11 -1
- package/contracts/infra-plan.v1.json +2 -0
- package/contracts/ingestion-plan.v1.json +85 -0
- package/contracts/ingestion-result.v1.json +59 -0
- package/contracts/mirror-ops.v1.json +2 -1
- package/contracts/pipeline-last-run.v1.json +2 -2
- package/contracts/private-product-manifest.v1.json +2 -0
- package/contracts/product-factory-plan.v1.json +2 -0
- package/contracts/project-archive.v1.json +2 -0
- package/contracts/project-entry-capability.v1.json +2 -3
- package/contracts/project-test-coverage.v1.json +189 -0
- package/contracts/project-workspace-link.v1.json +66 -0
- package/contracts/project-workspace-resolution.v1.json +28 -0
- package/contracts/published-contract-catalog.v1.json +50 -0
- package/contracts/release-readiness.v1.json +2 -2
- package/contracts/runtime-command-surface.v1.json +1456 -123
- package/contracts/transparency-evidence.v1.json +2 -1
- package/contracts/workspace-archive-capabilities.v1.json +11 -5
- package/contracts/workspace-archive-manifest.v1.json +236 -0
- package/contracts/workspace-archive-operation-result.v1.json +236 -0
- package/contracts/workspace-contract.v1.json +1 -1
- package/contracts/workspace-intelligence/agent-action-outcome.v1.json +2 -2
- package/contracts/workspace-intelligence/agent-customization-pack-report.v1.json +1 -1
- package/contracts/workspace-intelligence/agent-hooks.v1.json +2 -0
- package/contracts/workspace-intelligence/agent-reports-index.v1.json +1 -1
- package/contracts/workspace-intelligence/blocker-resolution.v1.json +3 -9
- package/contracts/workspace-intelligence/doctor-fix-result.v1.json +2 -2
- package/contracts/workspace-intelligence/doctor-graph-diagnosis.v1.json +208 -0
- package/contracts/workspace-intelligence/fact-freshness.v1.json +2 -2
- package/contracts/workspace-intelligence/mcp-design.v1.json +2 -0
- package/contracts/workspace-intelligence/model-usage-event.v1.json +1 -1
- package/contracts/workspace-intelligence/project-context-agent.v1.json +360 -0
- package/contracts/workspace-intelligence/studio-blocker-handoff.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-context.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-contract-verify.v1.json +2 -2
- package/contracts/workspace-intelligence/workspace-dependency-graph.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-explain.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-graph-stream.v1.json +262 -0
- package/contracts/workspace-intelligence/workspace-graph-token-efficiency.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-impact.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-intelligence-evaluation-comparison.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-intelligence-history.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-intelligence-run.v1.json +2 -2
- package/contracts/workspace-intelligence/workspace-knowledge-graph-change-overlay.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-knowledge-graph.v1.json +48 -5
- package/contracts/workspace-intelligence/workspace-knowledge-search.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-model-diff.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-model-snapshot.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-model.v1.json +97 -5
- package/contracts/workspace-intelligence/workspace-operational-skill.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-skills-index.v1.json +1 -1
- package/contracts/workspace-intelligence/workspace-verify.v1.json +1 -1
- package/contracts/workspace-intelligence-architecture.v1.json +33 -7
- package/contracts/workspace-intelligence-chain.v1.json +1 -1
- package/contracts/workspace-list.v1.json +2 -0
- package/contracts/workspace-model-cache.v1.json +2 -0
- package/contracts/workspace-registry.v1.json +1 -1
- package/contracts/workspace-run-last.v1.json +1 -1
- package/contracts/workspace-share-bundle.v1.json +2 -1
- package/contracts/workspace-snapshot.v1.json +2 -0
- package/contracts/workspace-snapshot.v2.json +2 -0
- package/contracts/workspace-sync.v1.json +2 -0
- package/contracts/workspace-watch-event.v1.json +2 -0
- package/dist/analyze-ZFQWTCJQ.js +1 -0
- package/dist/{artifact-remediation-plan-SPOUHMK5.js → artifact-remediation-plan-ICN3KOFG.js} +1 -1
- package/dist/autopilot-release-VKXQ7BS7.js +1 -0
- package/dist/chunk-2AXEGYPL.js +1 -0
- package/dist/chunk-2D4UOYOJ.js +1 -0
- package/dist/chunk-2OIBHUVH.js +1 -0
- package/dist/chunk-3GRKUP5W.js +33 -0
- package/dist/{managed-agent-markers-AXUM75OE.js → chunk-3RBUSW7H.js} +1 -1
- package/dist/chunk-5EXZBCAZ.js +4 -0
- package/dist/chunk-6UTM5AJI.js +1 -0
- package/dist/chunk-AFIFZTOY.js +2 -0
- package/dist/{chunk-BMWFQXGW.js → chunk-AHLMIL2T.js} +1 -1
- package/dist/chunk-AL237TSJ.js +7 -0
- package/dist/chunk-AL2A7Q4X.js +86 -0
- package/dist/{chunk-VU7NZHPM.js → chunk-BHYTI3RH.js} +1 -1
- package/dist/{chunk-ESLPI3XZ.js → chunk-BQGBU2Y3.js} +1 -1
- package/dist/chunk-C35UXTDM.js +2 -0
- package/dist/chunk-C3FLCDRN.js +2 -0
- package/dist/chunk-CZC5P2MF.js +1 -0
- package/dist/{chunk-Y5UJLPS4.js → chunk-DDQ3XK3H.js} +13 -13
- package/dist/{chunk-CRHYBQI3.js → chunk-DQ3PI7EP.js} +1 -1
- package/dist/chunk-EWZZUQBR.js +1 -0
- package/dist/{chunk-4KUIFXHM.js → chunk-GNQRYISX.js} +3 -3
- package/dist/chunk-I42F552T.js +2 -0
- package/dist/chunk-IDQKVJUF.js +2 -0
- package/dist/{chunk-3VFA7D5T.js → chunk-IND3TUVU.js} +1 -1
- package/dist/chunk-IPJ5URDF.js +1 -0
- package/dist/{chunk-I46XEIPL.js → chunk-JFUD73OZ.js} +52 -52
- package/dist/chunk-KKAOTTYO.js +8 -0
- package/dist/chunk-KMLPHFLD.js +2 -0
- package/dist/{chunk-NHN4QXPP.js → chunk-KVSYBHUR.js} +1 -1
- package/dist/chunk-KXG6E5VK.js +1 -0
- package/dist/chunk-L2YK5RV2.js +1 -0
- package/dist/chunk-LAJM2SBP.js +15 -0
- package/dist/{chunk-5S3DJQEP.js → chunk-LZQUZGXB.js} +1 -1
- package/dist/chunk-MOSXTVPU.js +1 -0
- package/dist/chunk-MV7KF75Q.js +13 -0
- package/dist/chunk-MVLIONQD.js +1 -0
- package/dist/chunk-RJIYCDVC.js +1 -0
- package/dist/{chunk-BGPXQQNY.js → chunk-RTVRZFIJ.js} +1 -1
- package/dist/chunk-RVQLMTTI.js +2 -0
- package/dist/chunk-SHXJ2GDR.js +75 -0
- package/dist/{chunk-32OJDBIG.js → chunk-SS2VV3D5.js} +1 -1
- package/dist/chunk-TDTCMZK7.js +10 -0
- package/dist/chunk-UETZ7USY.js +36 -0
- package/dist/chunk-VKTUWUS6.js +1 -0
- package/dist/chunk-VRW6KXNK.js +6 -0
- package/dist/chunk-Y5YAP4F3.js +2 -0
- package/dist/chunk-YPKNQCLK.js +2 -0
- package/dist/{create-DBQNAMKP.js → create-I23DC7SN.js} +1 -1
- package/dist/{demo-kit-DZ7TPG7K.js → demo-kit-KHH63TNA.js} +2 -2
- package/dist/{doctor-4NNUDNGZ.js → doctor-DOOMYLIH.js} +1 -1
- package/dist/{dotnet-webapi-clean-A6MVDYXX.js → dotnet-webapi-clean-VXEF4SHM.js} +5 -5
- package/dist/{gofiber-standard-I5YPQG5V.js → gofiber-standard-AQGSC7ON.js} +3 -3
- package/dist/{gogin-standard-VY2L4QT5.js → gogin-standard-7DU3OCBX.js} +3 -3
- package/dist/index.d.ts +41 -6
- package/dist/index.js +268 -356
- package/dist/managed-agent-markers-COE5DJ3W.js +1 -0
- package/dist/pipeline-U77HSINC.js +5 -0
- package/dist/platform-capabilities-PR6YL4KC.js +1 -0
- package/dist/project-intelligence-lens-BKKVPCLC.js +1 -0
- package/dist/project-test-coverage-4TEHZJFC.js +1 -0
- package/dist/{pythonRapidkitExec-CVCIK225.js → pythonRapidkitExec-YR7P5LWG.js} +1 -1
- package/dist/rust-axum-4HXDICIB.js +140 -0
- package/dist/{springboot-standard-55XKCBIZ.js → springboot-standard-EK6GYN5T.js} +7 -7
- package/dist/workspace-ZEYUVR26.js +1 -0
- package/dist/{workspace-agent-sync-662QHXGF.js → workspace-agent-sync-DKYJLUDP.js} +1 -1
- package/dist/workspace-archive-4JNT4S7N.js +1 -0
- package/dist/{workspace-context-23YYCUCP.js → workspace-context-IHUFMZT3.js} +1 -1
- package/dist/workspace-contract-PVLGPBBV.js +1 -0
- package/dist/workspace-explain-64HNKAHO.js +1 -0
- package/dist/workspace-explain-contract-H7O26QJU.js +1 -0
- package/dist/{workspace-feedback-SUVH2LUJ.js → workspace-feedback-RATRXFUC.js} +1 -1
- package/dist/{workspace-foundation-WXJ6I7ES.js → workspace-foundation-D33LJLGT.js} +1 -1
- package/dist/workspace-graph-stream-THNG2T7R.js +1 -0
- package/dist/{workspace-history-BANOJRQ2.js → workspace-history-EWFPT74O.js} +1 -1
- package/dist/workspace-intelligence-MCNSWWDV.js +1 -0
- package/dist/{workspace-intelligence-evaluation-IPH7M3WV.js → workspace-intelligence-evaluation-7CABG5Y6.js} +1 -1
- package/dist/workspace-intelligence-runner-TG2VLHNZ.js +1 -0
- package/dist/workspace-intelligence-runtime-registry-ZZ3GRAL2.js +1 -0
- package/dist/{workspace-knowledge-graph-ARDC6HHG.js → workspace-knowledge-graph-2EYR7N56.js} +1 -1
- package/dist/{workspace-marker-SMBC3Z2Q.js → workspace-marker-7NHMDIRL.js} +1 -1
- package/dist/workspace-mcp-serve-FLAVKWYW.js +3 -0
- package/dist/workspace-model-FMFYLHE4.js +1 -0
- package/dist/workspace-model-hash-ZXYPIGCW.js +1 -0
- package/dist/workspace-onboarding-MYROZDI2.js +1 -0
- package/dist/{workspace-python-engine-state-2MLKJYQG.js → workspace-python-engine-state-J4QKW55K.js} +1 -1
- package/dist/{workspace-registry-summary-ORDK7A36.js → workspace-registry-summary-6VXIAQLX.js} +1 -1
- package/dist/workspace-run-2ZI5UMJ2.js +1 -0
- package/dist/{workspace-verify-EBVL7FWT.js → workspace-verify-FKYI65UQ.js} +1 -1
- package/dist/workspace-watch-RP5KMVP2.js +1 -0
- package/docs/GLOSSARY.md +17 -16
- package/docs/OPEN_SOURCE_USER_SCENARIOS.md +18 -10
- package/docs/README.md +49 -14
- package/docs/README_CONTENT_CONTRACT.md +19 -10
- package/docs/ci-workflows.md +3 -3
- package/docs/commands-reference.md +41 -10
- package/docs/contracts/ARTIFACT_CATALOG.md +72 -27
- package/docs/contracts/COMMAND_OWNERSHIP_MATRIX.md +2 -0
- package/docs/contracts/RUNTIME_SUPPORT_MATRIX.md +3 -3
- package/docs/contracts/rapidkit-cli-contracts.json +2 -2
- package/docs/create-planner-capabilities.md +36 -5
- package/docs/creating-workspaces-and-projects.md +75 -15
- package/docs/doctor-command.md +148 -39
- package/docs/examples/ci-agent-grounding.yml +1 -1
- package/docs/from-code-to-shared-understanding.md +6 -3
- package/docs/graph-benchmark-methodology.md +2 -2
- package/docs/workspace-intelligence-evaluation.md +13 -6
- package/docs/workspace-intelligence-runner.md +17 -6
- package/docs/workspace-knowledge-graph.md +102 -7
- package/docs/workspace-operations.md +154 -10
- package/package.json +10 -5
- package/scripts/enterprise-package-smoke.mjs +13 -1
- package/templates/kits/fastapi-ddd/README.md.j2 +1 -1
- package/dist/analyze-EEEU3MIF.js +0 -1
- package/dist/autopilot-release-XGVXPOZI.js +0 -1
- package/dist/chunk-22DT744Z.js +0 -1
- package/dist/chunk-37CVKXBD.js +0 -1
- package/dist/chunk-3NU32T4A.js +0 -2
- package/dist/chunk-3ZK2GU7C.js +0 -1
- package/dist/chunk-4HDYADHT.js +0 -13
- package/dist/chunk-52PBRX7F.js +0 -1
- package/dist/chunk-54EP5CEV.js +0 -8
- package/dist/chunk-5XATWNME.js +0 -1
- package/dist/chunk-7YHK5NM3.js +0 -2
- package/dist/chunk-AFL3ACCR.js +0 -2
- package/dist/chunk-BFLJ2R4D.js +0 -80
- package/dist/chunk-EYJ2CQSK.js +0 -1
- package/dist/chunk-FTY7GGXJ.js +0 -33
- package/dist/chunk-FXQJX34Z.js +0 -1
- package/dist/chunk-GSWPGELT.js +0 -2
- package/dist/chunk-GZTYAEWX.js +0 -1
- package/dist/chunk-HDXNIN4N.js +0 -1
- package/dist/chunk-HZDXO65G.js +0 -36
- package/dist/chunk-J5ENLXDF.js +0 -1
- package/dist/chunk-KB44JP4M.js +0 -2
- package/dist/chunk-LHOZXC2M.js +0 -2
- package/dist/chunk-MER6ZBN2.js +0 -13
- package/dist/chunk-NAJCUQ4X.js +0 -2
- package/dist/chunk-OA537ZQ5.js +0 -1
- package/dist/chunk-OW42TZFB.js +0 -1
- package/dist/chunk-P3D5YQB2.js +0 -1
- package/dist/chunk-PHXQR6PX.js +0 -2
- package/dist/chunk-PRTR2DQ2.js +0 -1
- package/dist/chunk-QNONOO4F.js +0 -4
- package/dist/chunk-RHQW3DTP.js +0 -1
- package/dist/chunk-T4YR4RAI.js +0 -2
- package/dist/chunk-Y45WZR5N.js +0 -5
- package/dist/chunk-YJZOMRAS.js +0 -1
- package/dist/pipeline-TQM43A3K.js +0 -5
- package/dist/platform-capabilities-2B4QMZXE.js +0 -1
- package/dist/workspace-NCWRINEF.js +0 -1
- package/dist/workspace-archive-P76EDIUG.js +0 -10
- package/dist/workspace-contract-TU2I7GC2.js +0 -1
- package/dist/workspace-dependency-graph-BP4EXYQ5.js +0 -1
- package/dist/workspace-explain-MWUEN643.js +0 -1
- package/dist/workspace-explain-contract-ZPI3JXJU.js +0 -1
- package/dist/workspace-intelligence-MFJE7W67.js +0 -1
- package/dist/workspace-intelligence-runner-THYLHHMF.js +0 -1
- package/dist/workspace-mcp-serve-EZR6O76D.js +0 -3
- package/dist/workspace-model-7OU2M3LE.js +0 -1
- package/dist/workspace-model-hash-MHXK5MEI.js +0 -1
- package/dist/workspace-run-RLIYSOTN.js +0 -1
- package/dist/workspace-watch-3BPGLFLB.js +0 -1
package/README.md
CHANGED
|
@@ -9,17 +9,17 @@
|
|
|
9
9
|
|
|
10
10
|
> One workspace. One truth. Humans and AI aligned.
|
|
11
11
|
|
|
12
|
-
Workspai is an open-source CLI that
|
|
13
|
-
|
|
14
|
-
MCP-compatible tools, and AI agents can use
|
|
15
|
-
|
|
12
|
+
Workspai is an open-source CLI that connects one or many software projects and
|
|
13
|
+
keeps a current, checkable view of the whole system. Developers, CI, IDEs,
|
|
14
|
+
MCP-compatible tools, and AI agents can use that same view instead of rebuilding
|
|
15
|
+
different context from scattered files.
|
|
16
16
|
|
|
17
17
|
- **See the system:** projects, runtimes, APIs, dependencies, infrastructure,
|
|
18
18
|
documentation, policies, and release state in one model.
|
|
19
|
-
- **Ask with proof:**
|
|
20
|
-
|
|
21
|
-
- **
|
|
22
|
-
|
|
19
|
+
- **Ask with proof:** get focused answers that link back to the supporting files
|
|
20
|
+
and facts.
|
|
21
|
+
- **Change with confidence:** see what may be affected, run the right checks,
|
|
22
|
+
and prepare useful context for AI tools.
|
|
23
23
|
|
|
24
24
|
[Quickstart](#start-in-two-minutes) ·
|
|
25
25
|
[Architecture](#from-code-to-shared-understanding) ·
|
|
@@ -30,22 +30,24 @@ rebuilding a different picture from scattered files.
|
|
|
30
30
|
## Understand Workspai in one minute
|
|
31
31
|
|
|
32
32
|
Your software system is more than a repository. It may include several
|
|
33
|
-
applications and services, shared packages, API
|
|
34
|
-
documentation, tests,
|
|
35
|
-
|
|
33
|
+
applications and services, shared packages, API definitions, deployment files,
|
|
34
|
+
documentation, tests, owners, and CI results. Workspai connects those parts
|
|
35
|
+
without asking an AI model to decide what is true.
|
|
36
36
|
|
|
37
37
|
| Term | Plain-language meaning |
|
|
38
38
|
| ------------------- | ------------------------------------------------------------------------------------ |
|
|
39
|
-
| **Workspace** |
|
|
40
|
-
| **Project** | An application, service, library, or existing source
|
|
41
|
-
| **Workspace Model** | The
|
|
42
|
-
| **Knowledge Graph** | A
|
|
43
|
-
| **Evidence** | The
|
|
44
|
-
| **Artifact** | A
|
|
45
|
-
|
|
46
|
-
The Workspace Model is the canonical source of truth.
|
|
47
|
-
|
|
48
|
-
|
|
39
|
+
| **Workspace** | A home for related projects, shared rules, and saved results |
|
|
40
|
+
| **Project** | An application, service, library, or existing source folder connected to a workspace |
|
|
41
|
+
| **Workspace Model** | The main saved record of what Workspai knows about the system |
|
|
42
|
+
| **Knowledge Graph** | A searchable map built from the model, with links back to supporting files |
|
|
43
|
+
| **Evidence** | The file, observation, hash, or report that supports an answer |
|
|
44
|
+
| **Artifact** | A file under `.workspai/` that people and other tools can read |
|
|
45
|
+
|
|
46
|
+
The Workspace Model is the canonical source of truth. This means it is the main
|
|
47
|
+
saved record. The Knowledge Graph is built from that record to make
|
|
48
|
+
relationships easy to search; it is not a second truth and it is not an AI
|
|
49
|
+
guess. In the technical contract, the graph is a derived, revision-bound
|
|
50
|
+
representation of the model.
|
|
49
51
|
|
|
50
52
|
The deterministic model, graph, contracts, and verification chain do not
|
|
51
53
|
require an AI API key. Optional AI-backed features declare that dependency
|
|
@@ -67,35 +69,45 @@ Global installation is optional. Every example below also works with
|
|
|
67
69
|
npx wspai --help
|
|
68
70
|
```
|
|
69
71
|
|
|
70
|
-
`workspai` is the
|
|
71
|
-
|
|
72
|
+
`workspai` is the main npm package and command. `wspai` is an optional shorter
|
|
73
|
+
name for interactive use. This package is the active CLI in the
|
|
72
74
|
[Workspai monorepo](../../README.md).
|
|
73
75
|
|
|
74
|
-
### 2.
|
|
76
|
+
### 2. Connect an existing project
|
|
75
77
|
|
|
76
78
|
```bash
|
|
77
|
-
|
|
78
|
-
npx workspai adopt
|
|
79
|
-
--workspace ~/.workspai/workspaces/platform \
|
|
80
|
-
--json
|
|
81
|
-
cd ~/.workspai/workspaces/platform
|
|
79
|
+
cd /absolute/path/to/project
|
|
80
|
+
npx workspai adopt .
|
|
82
81
|
```
|
|
83
82
|
|
|
84
|
-
`adopt` registers the project without moving or copying it.
|
|
85
|
-
|
|
86
|
-
|
|
83
|
+
`adopt` registers the project without moving or copying it. When run outside a
|
|
84
|
+
workspace, it creates or reuses the minimal default workspace and binds the
|
|
85
|
+
project to it.
|
|
87
86
|
|
|
88
|
-
### 3.
|
|
87
|
+
### 3. Continue from the project
|
|
88
|
+
|
|
89
|
+
The project is now a first-class entry point into its Workspai workspace. Stay
|
|
90
|
+
in the project directory and run:
|
|
89
91
|
|
|
90
92
|
```bash
|
|
91
|
-
npx workspai workspace
|
|
93
|
+
npx workspai project workspace status --json
|
|
94
|
+
npx workspai workspace intelligence run --for-agent generic --strict --json
|
|
92
95
|
```
|
|
93
96
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
the
|
|
97
|
+
Workspai resolves the canonical workspace through a validated machine-local
|
|
98
|
+
link. That link is gitignored; portable project grounding and bounded agent
|
|
99
|
+
context are written under the project's `.workspai/` directory. The project
|
|
100
|
+
lens carries bounded topology, related projects, API/deployment/test surfaces,
|
|
101
|
+
current blockers, proof paths, and model/graph freshness without copying the
|
|
102
|
+
full workspace graph. You only need `--workspace <path>` when resolving an
|
|
103
|
+
ambiguous or moved binding.
|
|
104
|
+
|
|
105
|
+
`generic` creates vendor-neutral context. Use `codex`, `claude`, `cursor`, or
|
|
106
|
+
`orca` when you want context shaped for that agent. Agent Sync also writes the
|
|
107
|
+
shared files used by GitHub Copilot, VS Code, and `AGENTS.md` consumers without
|
|
108
|
+
changing the system information or the checks Workspai runs.
|
|
97
109
|
|
|
98
|
-
The run
|
|
110
|
+
The run saves its results so people and tools can inspect and reuse them:
|
|
99
111
|
|
|
100
112
|
```text
|
|
101
113
|
.workspai/
|
|
@@ -113,20 +125,63 @@ The run creates durable, discoverable output:
|
|
|
113
125
|
AGENTS.md
|
|
114
126
|
```
|
|
115
127
|
|
|
116
|
-
|
|
117
|
-
|
|
128
|
+
Each registered project also receives:
|
|
129
|
+
|
|
130
|
+
```text
|
|
131
|
+
.workspai/
|
|
132
|
+
├── workspace-link.local.json # machine-local, gitignored
|
|
133
|
+
├── PROJECT-GROUNDING.md # portable entry guide
|
|
134
|
+
└── reports/project-context-agent.json
|
|
135
|
+
AGENTS.md # existing content preserved
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
For automation details, including exit codes and blocked results, see the
|
|
139
|
+
[Unified runner guide](docs/workspace-intelligence-runner.md). A blocked result
|
|
118
140
|
is useful evidence, not a crashed command.
|
|
119
141
|
|
|
120
|
-
|
|
121
|
-
ready; it is not a substitute for the canonical chain:
|
|
142
|
+
When you are ready for the broader release workflow, run:
|
|
122
143
|
|
|
123
144
|
```bash
|
|
124
145
|
npx workspai pipeline --json --strict
|
|
125
146
|
```
|
|
126
147
|
|
|
148
|
+
Starting new software instead?
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
npx workspai create workspace my-workspace --profile minimal --yes
|
|
152
|
+
cd ~/.workspai/workspaces/my-workspace
|
|
153
|
+
npx workspai create project nextjs web --yes
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
The project picker is organized by **Backend**, **Frontend**, **Desktop**, and
|
|
157
|
+
**Extension**. In addition to the existing web and service starters, Workspai
|
|
158
|
+
can create Axum, Tauri, Electron, VS Code extension, and Laravel projects:
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
npx workspai create project rust.axum api
|
|
162
|
+
npx workspai create project desktop.tauri desktop-app
|
|
163
|
+
npx workspai create project desktop.electron admin-console
|
|
164
|
+
npx workspai create project extension.vscode editor-tools
|
|
165
|
+
npx workspai create project php.laravel web-api
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Axum is a deterministic Workspai-owned baseline. Tauri, Electron, VS Code, and
|
|
169
|
+
Laravel use their ecosystem generator, after which Workspai writes canonical
|
|
170
|
+
project metadata and joins the project to the same Model, Doctor, Graph, and
|
|
171
|
+
agent-context pipeline. All available official generators request their latest
|
|
172
|
+
stable channel, enforce Node engine compatibility, check required local
|
|
173
|
+
toolchains, and record that policy in project evidence. Frontend remains a
|
|
174
|
+
first-class project category rather than being folded into a generic Node
|
|
175
|
+
project.
|
|
176
|
+
|
|
177
|
+
From the `my-workspace` terminal, create a project, use `adopt` to link one in
|
|
178
|
+
place, or use `import` to copy or clone one into the workspace. See
|
|
179
|
+
[Creating Workspaces and Projects](docs/creating-workspaces-and-projects.md)
|
|
180
|
+
for supported starters.
|
|
181
|
+
|
|
127
182
|
## From Code to Shared Understanding
|
|
128
183
|
|
|
129
|
-

|
|
130
185
|
|
|
131
186
|
[View the Mermaid source and explanation](docs/from-code-to-shared-understanding.md).
|
|
132
187
|
|
|
@@ -135,18 +190,16 @@ Workspai is the deterministic layer between source code and its consumers:
|
|
|
135
190
|
```text
|
|
136
191
|
Code · packages · APIs · infrastructure · docs · CI · policies
|
|
137
192
|
│
|
|
138
|
-
|
|
139
|
-
│
|
|
140
|
-
facts + proofs
|
|
193
|
+
registration · detection · contract reconciliation
|
|
141
194
|
│
|
|
142
195
|
Canonical Workspace Model
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
196
|
+
│
|
|
197
|
+
bounded providers · facts · proofs
|
|
198
|
+
│
|
|
199
|
+
Evidence-backed Knowledge Graph
|
|
200
|
+
│
|
|
148
201
|
diff · impact · verify · context · explain
|
|
149
|
-
|
|
202
|
+
│
|
|
150
203
|
Developers · CI · IDEs · MCP · AI agents
|
|
151
204
|
```
|
|
152
205
|
|
|
@@ -155,6 +208,7 @@ Code · packages · APIs · infrastructure · docs · CI · policies
|
|
|
155
208
|
| **Model** | What projects, runtimes, frameworks, commands, policies, contracts, and dependencies exist? |
|
|
156
209
|
| **Snapshot and diff** | What changed between two known workspace states? |
|
|
157
210
|
| **Impact** | Which projects and transitive dependents are affected? |
|
|
211
|
+
| **Doctor** | Which runtime check failed, what graph evidence is related, and what should verify the fix? |
|
|
158
212
|
| **Evidence** | What do health, analysis, contracts, and readiness reports prove? |
|
|
159
213
|
| **Verify** | Is the affected workspace ready, blocked, stale, or missing evidence? |
|
|
160
214
|
| **Context** | What should developers, IDEs, and AI agents know before acting? |
|
|
@@ -266,11 +320,13 @@ reruns.
|
|
|
266
320
|
|
|
267
321
|
### Governance and operations
|
|
268
322
|
|
|
269
|
-
| What you need | Command
|
|
270
|
-
| ------------------------------------ |
|
|
271
|
-
| Run affected project tests | `npx workspai workspace run test --affected --blast-radius --json`
|
|
272
|
-
|
|
|
273
|
-
|
|
|
323
|
+
| What you need | Command |
|
|
324
|
+
| ------------------------------------ | ----------------------------------------------------------------------------- |
|
|
325
|
+
| Run affected project tests | `npx workspai workspace run test --affected --blast-radius --json` |
|
|
326
|
+
| Measure one project's test coverage | `npx workspai project coverage --run --target 80 --strict --json` |
|
|
327
|
+
| Diagnose one project | `npx workspai doctor project --json` |
|
|
328
|
+
| Run the release/governance gate | `npx workspai pipeline --json --strict` |
|
|
329
|
+
| Run the canonical intelligence chain | `npx workspai workspace intelligence run --for-agent generic --strict --json` |
|
|
274
330
|
|
|
275
331
|
`workspace verify` consumes current impact, doctor, contract, analysis, and
|
|
276
332
|
readiness evidence. Use `workspace intelligence run` for the canonical chain,
|
|
@@ -280,7 +336,7 @@ Other useful operational commands:
|
|
|
280
336
|
|
|
281
337
|
```bash
|
|
282
338
|
npx workspai doctor workspace
|
|
283
|
-
npx workspai setup <python|node|go|java|dotnet> [--warm-deps]
|
|
339
|
+
npx workspai setup <python|node|go|java|dotnet|rust|php> [--warm-deps]
|
|
284
340
|
npx workspai workspace list
|
|
285
341
|
npx workspai cache <status|clear|prune|repair>
|
|
286
342
|
npx workspai mirror <status|sync|verify|rotate>
|
|
@@ -312,6 +368,12 @@ developers, CI, IDEs, and agents reason over the same blast radius.
|
|
|
312
368
|
|
|
313
369
|
### Ground AI tools
|
|
314
370
|
|
|
371
|
+
Workspai creates the initial model, graph, context, `AGENTS.md`, report index,
|
|
372
|
+
skills, and supported agent/IDE files with the workspace. It refreshes them
|
|
373
|
+
after successful project creation, adoption, import, or workspace connection.
|
|
374
|
+
Run Agent Sync directly only when you want an explicit refresh or different
|
|
375
|
+
targets/preset:
|
|
376
|
+
|
|
315
377
|
```bash
|
|
316
378
|
npx workspai workspace agent-sync \
|
|
317
379
|
--write \
|
|
@@ -330,6 +392,15 @@ and reproducible token-efficiency methodology, see the
|
|
|
330
392
|
[Workspace Knowledge Graph guide](docs/workspace-knowledge-graph.md) and
|
|
331
393
|
[Graph Benchmark Methodology](docs/graph-benchmark-methodology.md).
|
|
332
394
|
|
|
395
|
+
The integrated CLI has one canonical direction: **Workspace Model → Knowledge
|
|
396
|
+
Graph**. The model owns the workspace boundary and compact project topology;
|
|
397
|
+
bounded providers enrich that inventory into proof-backed cross-domain
|
|
398
|
+
relationships without writing back into the model. Both artifacts are published
|
|
399
|
+
under one lock with rollback, and the graph contract fixes its source to
|
|
400
|
+
`.workspai/reports/workspace-model.json` plus the model's stable structural
|
|
401
|
+
SHA-256. Doctor, Context, MCP, and graph streaming reject a mismatched persisted
|
|
402
|
+
graph.
|
|
403
|
+
|
|
333
404
|
## Outputs and Consumers
|
|
334
405
|
|
|
335
406
|
Workspai separates human output, machine output, and durable cross-tool state:
|
|
@@ -383,18 +454,23 @@ tools without changing the source of truth:
|
|
|
383
454
|
|
|
384
455
|
All onboarding routes feed the same Workspace Intelligence model.
|
|
385
456
|
|
|
386
|
-
| Route
|
|
387
|
-
|
|
|
388
|
-
| Adopt
|
|
389
|
-
| Import local
|
|
390
|
-
| Import Git
|
|
391
|
-
|
|
|
392
|
-
|
|
|
393
|
-
|
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
457
|
+
| Route | Use it when | Example |
|
|
458
|
+
| ----------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
459
|
+
| Adopt | Existing source should stay in place | `npx workspai adopt /path/to/project --json` |
|
|
460
|
+
| Import local | Existing source should be copied into a workspace | `npx workspai import ../orders-api --workspace /path/to/workspace --json` |
|
|
461
|
+
| Import Git | A repository should be cloned into a workspace | `npx workspai import https://github.com/acme/orders-api.git --git --workspace /path/to/workspace --json` |
|
|
462
|
+
| Connect workspace | An existing workspace should stay in place | `npx workspai workspace connect /path/to/workspace --json` |
|
|
463
|
+
| Import workspace | A portable workspace archive should become active | `npx workspai workspace import team.workspai-archive.zip --output ./team --json` |
|
|
464
|
+
| Create workspace | You need a new governed boundary | `npx workspai create workspace my-workspace --profile polyglot --yes` |
|
|
465
|
+
| Create project | You need a supported new scaffold | `npx workspai create project nextjs web --yes` |
|
|
466
|
+
| Interactive | You want Workspai to guide the choice | `npx workspai create` |
|
|
467
|
+
|
|
468
|
+
Adopt and workspace connect never move or copy source. Project import copies or
|
|
469
|
+
clones; workspace import verifies and materializes a portable archive before
|
|
470
|
+
registration. `workspace hydrate` only extracts an archive and intentionally
|
|
471
|
+
does not register it. Create can use a Workspai-managed kit or an available
|
|
472
|
+
official ecosystem generator. Unsupported native create requests are directed
|
|
473
|
+
toward official tooling followed by adoption.
|
|
398
474
|
|
|
399
475
|
Detailed onboarding behavior:
|
|
400
476
|
|
|
@@ -483,7 +559,7 @@ For command-specific behavior, use the
|
|
|
483
559
|
|
|
484
560
|
Workspai is MIT-licensed and developed in the open. Contributions to runtime
|
|
485
561
|
support, contracts, documentation, tests, and Workspace Intelligence workflows
|
|
486
|
-
are welcome.
|
|
562
|
+
are welcome. Workspai is built by [Chistiq](https://chistiq.com/).
|
|
487
563
|
|
|
488
564
|
From a source checkout:
|
|
489
565
|
|
|
@@ -499,12 +575,12 @@ Go, Java, and .NET are required only for workflows that exercise those runtimes.
|
|
|
499
575
|
To validate only this package, run `npm --workspace workspai run validate` from
|
|
500
576
|
the monorepo root.
|
|
501
577
|
|
|
502
|
-
- Read [CONTRIBUTING.md](https://github.com/
|
|
503
|
-
- Use [GitHub Issues](https://github.com/
|
|
504
|
-
- Use [GitHub Discussions](https://github.com/
|
|
578
|
+
- Read [CONTRIBUTING.md](https://github.com/chistiq/workspai/blob/main/packages/cli/CONTRIBUTING.md) before submitting changes.
|
|
579
|
+
- Use [GitHub Issues](https://github.com/chistiq/workspai/issues) for reproducible bugs and feature requests.
|
|
580
|
+
- Use [GitHub Discussions](https://github.com/chistiq/workspai/discussions) for questions and design conversations.
|
|
505
581
|
- Read the [Development Guide](docs/DEVELOPMENT.md) for local workflows.
|
|
506
582
|
- Report vulnerabilities through the [Security Policy](docs/SECURITY.md), not a public issue.
|
|
507
|
-
- Review the [Changelog](https://github.com/
|
|
583
|
+
- Review the [Changelog](https://github.com/chistiq/workspai/blob/main/packages/cli/CHANGELOG.md) before upgrading.
|
|
508
584
|
|
|
509
585
|
## License
|
|
510
586
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://
|
|
4
|
-
"title": "
|
|
3
|
+
"$id": "https://workspai.dev/schemas/analyze-last-run.v1.json",
|
|
4
|
+
"title": "Workspai Analyze Last Run Evidence",
|
|
5
5
|
"type": "object",
|
|
6
6
|
"required": [
|
|
7
7
|
"schemaVersion",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://
|
|
4
|
-
"title": "
|
|
3
|
+
"$id": "https://workspai.dev/contracts/artifact-remediation-plan.v1.json",
|
|
4
|
+
"title": "Workspai Artifact Remediation Plan",
|
|
5
5
|
"type": "object",
|
|
6
6
|
"additionalProperties": false,
|
|
7
7
|
"required": ["schemaVersion", "generatedAt", "workspace", "source", "summary", "actions"],
|
|
@@ -35,13 +35,7 @@
|
|
|
35
35
|
"summary": {
|
|
36
36
|
"type": "object",
|
|
37
37
|
"additionalProperties": false,
|
|
38
|
-
"required": [
|
|
39
|
-
"artifactsScanned",
|
|
40
|
-
"cardsCovered",
|
|
41
|
-
"totalActions",
|
|
42
|
-
"executableActions",
|
|
43
|
-
"risk"
|
|
44
|
-
],
|
|
38
|
+
"required": ["artifactsScanned", "cardsCovered", "totalActions", "executableActions", "risk"],
|
|
45
39
|
"properties": {
|
|
46
40
|
"artifactsScanned": { "type": "integer", "minimum": 0 },
|
|
47
41
|
"cardsCovered": { "type": "integer", "minimum": 0 },
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://
|
|
3
|
+
"$id": "https://workspai.dev/schemas/bootstrap-compliance.v1.json",
|
|
4
|
+
"title": "Workspai Bootstrap Compliance Evidence",
|
|
4
5
|
"type": "object",
|
|
5
6
|
"required": ["schemaVersion", "command", "timestamp", "result", "checks"],
|
|
6
7
|
"properties": {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://
|
|
3
|
+
"$id": "https://workspai.dev/schemas/cli-log-event.v1.json",
|
|
4
4
|
"title": "Workspai CLI Log Event",
|
|
5
5
|
"description": "NDJSON stream events emitted on stderr when RAPIDKIT_LOG_FORMAT=json or --log-format json",
|
|
6
6
|
"type": "object",
|
|
@@ -31,6 +31,10 @@
|
|
|
31
31
|
"flags": "--enable-modules",
|
|
32
32
|
"attributeName": "enableModules"
|
|
33
33
|
},
|
|
34
|
+
{
|
|
35
|
+
"flags": "--project-grounding <mode>",
|
|
36
|
+
"attributeName": "projectGrounding"
|
|
37
|
+
},
|
|
34
38
|
{
|
|
35
39
|
"flags": "--dry-run",
|
|
36
40
|
"attributeName": "dryRun"
|
|
@@ -432,6 +436,10 @@
|
|
|
432
436
|
"flags": "--enable-modules",
|
|
433
437
|
"attributeName": "enableModules"
|
|
434
438
|
},
|
|
439
|
+
{
|
|
440
|
+
"flags": "--project-grounding <mode>",
|
|
441
|
+
"attributeName": "projectGrounding"
|
|
442
|
+
},
|
|
435
443
|
{
|
|
436
444
|
"flags": "--git",
|
|
437
445
|
"attributeName": "git"
|
|
@@ -836,6 +844,41 @@
|
|
|
836
844
|
}
|
|
837
845
|
]
|
|
838
846
|
},
|
|
847
|
+
{
|
|
848
|
+
"path": [
|
|
849
|
+
"project",
|
|
850
|
+
"coverage"
|
|
851
|
+
],
|
|
852
|
+
"command": "coverage",
|
|
853
|
+
"parent": "project",
|
|
854
|
+
"registrationKind": "commander",
|
|
855
|
+
"aliases": [],
|
|
856
|
+
"description": "Inspect or run runtime-native test coverage and publish normalized project evidence",
|
|
857
|
+
"hidden": false,
|
|
858
|
+
"arguments": [],
|
|
859
|
+
"options": [
|
|
860
|
+
{
|
|
861
|
+
"flags": "--project <path>",
|
|
862
|
+
"attributeName": "project"
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"flags": "--target <percent>",
|
|
866
|
+
"attributeName": "target"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"flags": "--run",
|
|
870
|
+
"attributeName": "run"
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"flags": "--strict",
|
|
874
|
+
"attributeName": "strict"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"flags": "--json",
|
|
878
|
+
"attributeName": "json"
|
|
879
|
+
}
|
|
880
|
+
]
|
|
881
|
+
},
|
|
839
882
|
{
|
|
840
883
|
"path": [
|
|
841
884
|
"project",
|
|
@@ -926,6 +969,39 @@
|
|
|
926
969
|
}
|
|
927
970
|
]
|
|
928
971
|
},
|
|
972
|
+
{
|
|
973
|
+
"path": [
|
|
974
|
+
"project",
|
|
975
|
+
"workspace"
|
|
976
|
+
],
|
|
977
|
+
"command": "workspace",
|
|
978
|
+
"parent": "project",
|
|
979
|
+
"registrationKind": "commander",
|
|
980
|
+
"aliases": [],
|
|
981
|
+
"description": "Show or repair the canonical workspace binding for the current Workspai project",
|
|
982
|
+
"hidden": false,
|
|
983
|
+
"arguments": [
|
|
984
|
+
{
|
|
985
|
+
"name": "action",
|
|
986
|
+
"required": false,
|
|
987
|
+
"variadic": false
|
|
988
|
+
}
|
|
989
|
+
],
|
|
990
|
+
"options": [
|
|
991
|
+
{
|
|
992
|
+
"flags": "--workspace <path>",
|
|
993
|
+
"attributeName": "workspace"
|
|
994
|
+
},
|
|
995
|
+
{
|
|
996
|
+
"flags": "--project <path>",
|
|
997
|
+
"attributeName": "project"
|
|
998
|
+
},
|
|
999
|
+
{
|
|
1000
|
+
"flags": "--json",
|
|
1001
|
+
"attributeName": "json"
|
|
1002
|
+
}
|
|
1003
|
+
]
|
|
1004
|
+
},
|
|
929
1005
|
{
|
|
930
1006
|
"path": [
|
|
931
1007
|
"readiness"
|
|
@@ -1216,6 +1292,10 @@
|
|
|
1216
1292
|
"flags": "--once",
|
|
1217
1293
|
"attributeName": "once"
|
|
1218
1294
|
},
|
|
1295
|
+
{
|
|
1296
|
+
"flags": "--graph-stream",
|
|
1297
|
+
"attributeName": "graphStream"
|
|
1298
|
+
},
|
|
1219
1299
|
{
|
|
1220
1300
|
"flags": "--for-agent [agent]",
|
|
1221
1301
|
"attributeName": "forAgent"
|
|
@@ -1236,6 +1316,10 @@
|
|
|
1236
1316
|
"flags": "--preset <preset>",
|
|
1237
1317
|
"attributeName": "preset"
|
|
1238
1318
|
},
|
|
1319
|
+
{
|
|
1320
|
+
"flags": "--project-grounding <mode>",
|
|
1321
|
+
"attributeName": "projectGrounding"
|
|
1322
|
+
},
|
|
1239
1323
|
{
|
|
1240
1324
|
"flags": "--refresh-context",
|
|
1241
1325
|
"attributeName": "refreshContext"
|