workspai 0.47.0 → 0.48.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 +214 -119
- package/contracts/agent-customization-pack.v1.json +5 -0
- package/contracts/extension-cli-compatibility.v1.json +7 -2
- package/contracts/published-contract-catalog.v1.json +28 -1
- package/contracts/runtime-command-surface.v1.json +145 -1
- package/contracts/workspace-intelligence/model-usage-event.v1.json +82 -0
- package/contracts/workspace-intelligence/workspace-intelligence-evaluation-comparison.v1.json +53 -0
- package/contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json +120 -0
- package/contracts/workspace-intelligence-architecture.v1.json +31 -2
- package/contracts/workspace-intelligence-chain.v1.json +44 -3
- package/dist/analyze-EEEU3MIF.js +1 -0
- package/dist/{artifact-remediation-plan-EPALZ2LC.js → artifact-remediation-plan-SPOUHMK5.js} +1 -1
- package/dist/autopilot-release-XGVXPOZI.js +1 -0
- package/dist/{chunk-2TEDAKP6.js → chunk-32OJDBIG.js} +1 -1
- package/dist/{chunk-ZDN7RHXJ.js → chunk-37CVKXBD.js} +1 -1
- package/dist/{chunk-YCL3I2JO.js → chunk-3NU32T4A.js} +1 -1
- package/dist/chunk-3VFA7D5T.js +1 -0
- package/dist/{chunk-CW7PGBIQ.js → chunk-4HDYADHT.js} +1 -1
- package/dist/{chunk-PBHP6JNY.js → chunk-54EP5CEV.js} +1 -1
- package/dist/{chunk-QDWYIRHR.js → chunk-5S3DJQEP.js} +1 -1
- package/dist/{chunk-NOFM7MNA.js → chunk-AFL3ACCR.js} +1 -1
- package/dist/{chunk-MEMHNE7Y.js → chunk-BFLJ2R4D.js} +1 -1
- package/dist/{chunk-6SWRNA47.js → chunk-BGPXQQNY.js} +1 -1
- package/dist/chunk-BMWFQXGW.js +1 -0
- package/dist/{chunk-2GHUZDYA.js → chunk-CRHYBQI3.js} +1 -1
- package/dist/{chunk-76YOPAOT.js → chunk-ESLPI3XZ.js} +1 -1
- package/dist/{chunk-DV6GJD4K.js → chunk-HDXNIN4N.js} +1 -1
- package/dist/{chunk-TNQI5VCW.js → chunk-HZDXO65G.js} +14 -14
- package/dist/{chunk-BSRVO52Y.js → chunk-I46XEIPL.js} +1 -1
- package/dist/{chunk-COARSXRC.js → chunk-J5ENLXDF.js} +1 -1
- package/dist/chunk-LHOZXC2M.js +2 -0
- package/dist/{chunk-RWRLFSKW.js → chunk-NAJCUQ4X.js} +1 -1
- package/dist/{chunk-ZM5NQ5Z2.js → chunk-OW42TZFB.js} +1 -1
- package/dist/{chunk-SK6XRKGG.js → chunk-P3D5YQB2.js} +1 -1
- package/dist/{chunk-TWNFECMN.js → chunk-PHXQR6PX.js} +1 -1
- package/dist/{chunk-ITCAMC2E.js → chunk-PRTR2DQ2.js} +1 -1
- package/dist/{chunk-KZZ36CK5.js → chunk-QNONOO4F.js} +1 -1
- package/dist/{chunk-7VLCK5JW.js → chunk-RHQW3DTP.js} +1 -1
- package/dist/{chunk-22NJ2ZMG.js → chunk-T4YR4RAI.js} +1 -1
- package/dist/{chunk-HSGFUKCN.js → chunk-VU7NZHPM.js} +1 -1
- package/dist/{chunk-VBSQ7MF6.js → chunk-Y5UJLPS4.js} +19 -19
- package/dist/{chunk-U5EZHZBX.js → chunk-YJZOMRAS.js} +1 -1
- package/dist/{create-7JKJDAQV.js → create-DBQNAMKP.js} +1 -1
- package/dist/{doctor-PGPNIS76.js → doctor-4NNUDNGZ.js} +1 -1
- package/dist/{dotnet-webapi-clean-6TVFBTVI.js → dotnet-webapi-clean-A6MVDYXX.js} +4 -4
- package/dist/{gofiber-standard-2BL7GWZB.js → gofiber-standard-I5YPQG5V.js} +1 -1
- package/dist/{gogin-standard-XGP3KBXA.js → gogin-standard-VY2L4QT5.js} +1 -1
- package/dist/index.d.ts +32 -11
- package/dist/index.js +127 -125
- package/dist/{pipeline-IB6ILJSV.js → pipeline-TQM43A3K.js} +1 -1
- package/dist/{springboot-standard-JJNUID6M.js → springboot-standard-55XKCBIZ.js} +4 -4
- package/dist/{workspace-H3QXBFGB.js → workspace-NCWRINEF.js} +1 -1
- package/dist/{workspace-agent-sync-C7SG2Z5W.js → workspace-agent-sync-662QHXGF.js} +1 -1
- package/dist/{workspace-context-BKQBKA4C.js → workspace-context-23YYCUCP.js} +1 -1
- package/dist/{workspace-contract-RPQQBQXR.js → workspace-contract-TU2I7GC2.js} +1 -1
- package/dist/{workspace-dependency-graph-23BI2HG7.js → workspace-dependency-graph-BP4EXYQ5.js} +1 -1
- package/dist/workspace-explain-MWUEN643.js +1 -0
- package/dist/workspace-explain-contract-ZPI3JXJU.js +1 -0
- package/dist/{workspace-feedback-WAID3IOE.js → workspace-feedback-SUVH2LUJ.js} +1 -1
- package/dist/{workspace-foundation-5OOJEO2D.js → workspace-foundation-WXJ6I7ES.js} +1 -1
- package/dist/{workspace-history-C6OP3IAQ.js → workspace-history-BANOJRQ2.js} +1 -1
- package/dist/{workspace-intelligence-VKDL3H2J.js → workspace-intelligence-MFJE7W67.js} +1 -1
- package/dist/workspace-intelligence-evaluation-IPH7M3WV.js +1 -0
- package/dist/{workspace-intelligence-runner-LVALAZY7.js → workspace-intelligence-runner-THYLHHMF.js} +1 -1
- package/dist/{workspace-knowledge-graph-FE2NTZKV.js → workspace-knowledge-graph-ARDC6HHG.js} +1 -1
- package/dist/workspace-knowledge-graph-export-UYAYFTWX.js +10 -0
- package/dist/workspace-mcp-serve-EZR6O76D.js +3 -0
- package/dist/{workspace-model-S33CIB2R.js → workspace-model-7OU2M3LE.js} +1 -1
- package/dist/{workspace-registry-summary-A3YDL63D.js → workspace-registry-summary-ORDK7A36.js} +1 -1
- package/dist/workspace-run-RLIYSOTN.js +1 -0
- package/dist/{workspace-verify-ZGH3NXAH.js → workspace-verify-EBVL7FWT.js} +1 -1
- package/dist/{workspace-watch-EVBJTMV7.js → workspace-watch-3BPGLFLB.js} +1 -1
- package/docs/GLOSSARY.md +28 -24
- package/docs/README.md +17 -10
- package/docs/README_CONTENT_CONTRACT.md +154 -0
- package/docs/commands-reference.md +14 -1
- package/docs/contracts/ARTIFACT_CATALOG.md +28 -19
- package/docs/contracts/README.md +3 -0
- package/docs/graph-benchmark-methodology.md +2 -2
- package/docs/workspace-intelligence-evaluation.md +147 -0
- package/docs/workspace-knowledge-graph.md +31 -10
- package/package.json +1 -1
- package/dist/analyze-UVXPRGYZ.js +0 -1
- package/dist/autopilot-release-5BQ6F5L2.js +0 -1
- package/dist/chunk-LNRAB7UY.js +0 -1
- package/dist/chunk-NRYS4CLR.js +0 -2
- package/dist/workspace-explain-WVN7JH3U.js +0 -1
- package/dist/workspace-explain-contract-SEFTVF6J.js +0 -1
- package/dist/workspace-mcp-serve-KT2I676Z.js +0 -3
- package/dist/workspace-run-M4LNJILC.js +0 -1
package/README.md
CHANGED
|
@@ -1,121 +1,121 @@
|
|
|
1
1
|
# Workspai CLI
|
|
2
2
|
|
|
3
|
-
## Open-Source Workspace Intelligence for Software Systems
|
|
4
|
-
|
|
5
3
|
[](https://www.npmjs.com/package/workspai)
|
|
6
4
|
[](https://www.npmjs.com/package/workspai)
|
|
7
5
|
[](LICENSE)
|
|
8
6
|
[](https://workspai.dev)
|
|
9
7
|
|
|
10
|
-
|
|
11
|
-
Not another agent framework.
|
|
12
|
-
Not another context engine.
|
|
8
|
+
## Workspace Intelligence for software systems
|
|
13
9
|
|
|
14
10
|
> One workspace. One truth. Humans and AI aligned.
|
|
15
11
|
|
|
16
|
-
Workspai turns
|
|
12
|
+
Workspai is an open-source CLI that turns one or many software projects into an
|
|
13
|
+
organized, evidence-backed view of the whole system. Developers, CI, IDEs,
|
|
14
|
+
MCP-compatible tools, and AI agents can use the same current model instead of
|
|
15
|
+
rebuilding a different picture from scattered files.
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
- **See the system:** projects, runtimes, APIs, dependencies, infrastructure,
|
|
18
|
+
documentation, policies, and release state in one model.
|
|
19
|
+
- **Ask with proof:** bounded graph answers linked to the files and facts that
|
|
20
|
+
support them.
|
|
21
|
+
- **Act with confidence:** change impact, health, verification, readiness, and
|
|
22
|
+
agent context from one defined and versioned intelligence chain.
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
[Quickstart](#start-in-two-minutes) ·
|
|
25
|
+
[Architecture](#from-code-to-shared-understanding) ·
|
|
26
|
+
[Commands](#core-workflows) ·
|
|
27
|
+
[Outputs](#outputs-and-consumers) ·
|
|
28
|
+
[Documentation](#documentation)
|
|
23
29
|
|
|
24
|
-
|
|
25
|
-
picture. With Workspai, it can ask a bounded question and receive the matching
|
|
26
|
-
entities, nearby relations, and source proofs:
|
|
30
|
+
## Understand Workspai in one minute
|
|
27
31
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
32
|
+
Your software system is more than a repository. It may include several
|
|
33
|
+
applications and services, shared packages, API contracts, deployment files,
|
|
34
|
+
documentation, tests, ownership, and CI evidence. Workspai connects those
|
|
35
|
+
surfaces without making AI the source of truth.
|
|
31
36
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
37
|
+
| Term | Plain-language meaning |
|
|
38
|
+
| ------------------- | ------------------------------------------------------------------------------------ |
|
|
39
|
+
| **Workspace** | The managed boundary containing registered projects, policy, contracts, and evidence |
|
|
40
|
+
| **Project** | An application, service, library, or existing source tree connected to the workspace |
|
|
41
|
+
| **Workspace Model** | The authoritative structured record used to generate the other views and artifacts |
|
|
42
|
+
| **Knowledge Graph** | A queryable representation derived from the model, with typed relations and proofs |
|
|
43
|
+
| **Evidence** | The source, observation, hash, or report that justifies a fact or decision |
|
|
44
|
+
| **Artifact** | A durable file under `.workspai/` that another tool can safely consume |
|
|
36
45
|
|
|
37
|
-
|
|
46
|
+
The Workspace Model is the canonical source of truth. The Knowledge Graph is a
|
|
47
|
+
derived, revision-bound representation—not a competing truth and not an
|
|
48
|
+
LLM-generated guess.
|
|
38
49
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
| Knowledge Graph entities | 1,738 |
|
|
43
|
-
| Knowledge Graph relations | 2,244 |
|
|
44
|
-
| Portable proofs | 2,106 |
|
|
45
|
-
| Readable proof-source artifacts | 392 |
|
|
46
|
-
| Corpus size (`characters / 4`) | 134,105 tokens |
|
|
47
|
-
| `api endpoint --limit 8` retrieval | 2,812 tokens |
|
|
48
|
-
| Observed retrieval payload reduction | 97.9% |
|
|
49
|
-
| Observed corpus/retrieval ratio | 47.69× |
|
|
50
|
-
|
|
51
|
-
This is a reproducible observation from one 16-project development workspace on
|
|
52
|
-
2026-07-21, not a universal token-cost or answer-quality claim. See
|
|
53
|
-
[Graph Benchmark Methodology](docs/graph-benchmark-methodology.md) for the source
|
|
54
|
-
hash, formulas, limitations, and publication gate.
|
|
50
|
+
The deterministic model, graph, contracts, and verification chain do not
|
|
51
|
+
require an AI API key. Optional AI-backed features declare that dependency
|
|
52
|
+
separately.
|
|
55
53
|
|
|
56
|
-
## Start
|
|
54
|
+
## Start in two minutes
|
|
57
55
|
|
|
58
|
-
### Install
|
|
56
|
+
### 1. Install or use `npx`
|
|
59
57
|
|
|
60
58
|
```bash
|
|
61
59
|
npm install -g workspai
|
|
62
60
|
workspai --help
|
|
63
61
|
```
|
|
64
62
|
|
|
65
|
-
|
|
63
|
+
Global installation is optional. Every example below also works with
|
|
64
|
+
`npx workspai`. The separate `wspai` package is only a short alias:
|
|
66
65
|
|
|
67
66
|
```bash
|
|
68
67
|
npx wspai --help
|
|
69
68
|
```
|
|
70
69
|
|
|
71
70
|
`workspai` is the canonical npm package and command. `wspai` is an optional
|
|
72
|
-
short alias for `npx` workflows.
|
|
73
|
-
used only by Python/Core-dependent workflows; it is not a replacement CLI.
|
|
74
|
-
This package is the active CLI boundary in the
|
|
71
|
+
short alias for `npx` workflows. This package is the active CLI boundary in the
|
|
75
72
|
[Workspai monorepo](../../README.md).
|
|
76
73
|
|
|
77
|
-
###
|
|
78
|
-
|
|
79
|
-
Browse all commands from the latest release without a global install:
|
|
74
|
+
### 2. Create a lightweight workspace and connect existing source
|
|
80
75
|
|
|
81
76
|
```bash
|
|
82
|
-
npx workspai
|
|
77
|
+
npx workspai create workspace platform --profile minimal --yes
|
|
78
|
+
npx workspai adopt /absolute/path/to/project \
|
|
79
|
+
--workspace ~/.workspai/workspaces/platform \
|
|
80
|
+
--json
|
|
81
|
+
cd ~/.workspai/workspaces/platform
|
|
83
82
|
```
|
|
84
83
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
starts when Workspai builds a durable model of the whole workspace and turns it
|
|
89
|
-
into evidence that different tools can consume.
|
|
90
|
-
|
|
91
|
-
Connect an existing project without moving or copying its source:
|
|
84
|
+
`adopt` registers the project without moving or copying it. To create new
|
|
85
|
+
software instead, start with `npx workspai create` or read
|
|
86
|
+
[Creating Workspaces and Projects](docs/creating-workspaces-and-projects.md).
|
|
92
87
|
|
|
93
|
-
|
|
94
|
-
npx workspai adopt /path/to/project --json
|
|
95
|
-
cd ~/.workspai/workspaces/workspai
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Execute the canonical chain and persist the shared model, evidence, and
|
|
99
|
-
agent-ready context:
|
|
88
|
+
### 3. Run the complete Workspace Intelligence chain
|
|
100
89
|
|
|
101
90
|
```bash
|
|
102
91
|
npx workspai workspace intelligence run --for-agent codex --strict --json
|
|
103
92
|
```
|
|
104
93
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
94
|
+
`codex` selects the generated agent-facing surface; use another supported agent
|
|
95
|
+
identifier when needed. The underlying intelligence chain and evidence remain
|
|
96
|
+
the same.
|
|
97
|
+
|
|
98
|
+
The run creates durable, discoverable output:
|
|
108
99
|
|
|
109
100
|
```text
|
|
110
|
-
.workspai/
|
|
111
|
-
|
|
112
|
-
.
|
|
113
|
-
|
|
101
|
+
.workspai/
|
|
102
|
+
├── workspace.json
|
|
103
|
+
├── workspace.contract.json
|
|
104
|
+
├── AGENT-GROUNDING.md
|
|
105
|
+
└── reports/
|
|
106
|
+
├── workspace-model.json
|
|
107
|
+
├── workspace-knowledge-graph.json
|
|
108
|
+
├── workspace-impact-last-run.json
|
|
109
|
+
├── workspace-verify-last-run.json
|
|
110
|
+
├── workspace-context-agent.json
|
|
111
|
+
├── workspace-intelligence-run-last-run.json
|
|
112
|
+
└── INDEX.json
|
|
114
113
|
AGENTS.md
|
|
115
114
|
```
|
|
116
115
|
|
|
117
|
-
|
|
118
|
-
|
|
116
|
+
Exit code `0` means passed, `1` means execution failed, and `2` means the run
|
|
117
|
+
completed but current evidence blocks the requested decision. A blocked result
|
|
118
|
+
is useful evidence, not a crashed command.
|
|
119
119
|
|
|
120
120
|
The broader governance and release pipeline is a separate gate when you are
|
|
121
121
|
ready; it is not a substitute for the canonical chain:
|
|
@@ -132,6 +132,24 @@ npx workspai pipeline --json --strict
|
|
|
132
132
|
|
|
133
133
|
Workspai is the deterministic layer between source code and its consumers:
|
|
134
134
|
|
|
135
|
+
```text
|
|
136
|
+
Code · packages · APIs · infrastructure · docs · CI · policies
|
|
137
|
+
│
|
|
138
|
+
deterministic providers
|
|
139
|
+
│
|
|
140
|
+
facts + proofs
|
|
141
|
+
│
|
|
142
|
+
Canonical Workspace Model
|
|
143
|
+
│ │
|
|
144
|
+
│ └── Evidence-backed Knowledge Graph
|
|
145
|
+
│ │
|
|
146
|
+
└──────────┬──────────────┘
|
|
147
|
+
│
|
|
148
|
+
diff · impact · verify · context · explain
|
|
149
|
+
│
|
|
150
|
+
Developers · CI · IDEs · MCP · AI agents
|
|
151
|
+
```
|
|
152
|
+
|
|
135
153
|
| Capability | What it answers |
|
|
136
154
|
| --------------------- | ------------------------------------------------------------------------------------------- |
|
|
137
155
|
| **Model** | What projects, runtimes, frameworks, commands, policies, contracts, and dependencies exist? |
|
|
@@ -147,6 +165,10 @@ Create, import, and adopt add software to this boundary. Workspace Intelligence
|
|
|
147
165
|
then models and governs every registered project, whether Workspai created it or
|
|
148
166
|
it already existed.
|
|
149
167
|
|
|
168
|
+
Unlike repository-only code intelligence, the workspace boundary can connect
|
|
169
|
+
evidence across multiple projects and repositories. A missing relationship
|
|
170
|
+
means **not proven by current evidence**, not "these projects are independent."
|
|
171
|
+
|
|
150
172
|
## One Intelligence Chain
|
|
151
173
|
|
|
152
174
|
The canonical execution order is versioned in
|
|
@@ -174,29 +196,81 @@ and enforce this exact contract-backed order. `pipeline --json --strict` remains
|
|
|
174
196
|
the broader governance/release orchestrator (`sync → doctor → analyze → readiness
|
|
175
197
|
→ autopilot`); it is not an alias for the canonical intelligence chain.
|
|
176
198
|
|
|
199
|
+
## Evidence and measurable context
|
|
200
|
+
|
|
201
|
+
Without bounded retrieval, a developer or agent often has to search and read a
|
|
202
|
+
large part of the workspace before answering a local question. Workspai can
|
|
203
|
+
return the matching entities, nearby relations, and source proofs first:
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
npx workspai workspace graph search "who implements the login API?" --limit 8 --json
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
Use the complete graph for interchange and audits; use bounded search for
|
|
210
|
+
normal questions and agent context. Workspai reports unknown or unproven
|
|
211
|
+
relationships instead of inventing an edge.
|
|
212
|
+
|
|
213
|
+
### Current measured fixture
|
|
214
|
+
|
|
215
|
+
| Measure | Observed value |
|
|
216
|
+
| ------------------------------------ | -------------: |
|
|
217
|
+
| Registered projects | 16 |
|
|
218
|
+
| Knowledge Graph entities | 1,738 |
|
|
219
|
+
| Knowledge Graph relations | 2,244 |
|
|
220
|
+
| Portable proofs | 2,106 |
|
|
221
|
+
| Readable proof-source artifacts | 392 |
|
|
222
|
+
| Corpus size (`characters / 4`) | 134,105 tokens |
|
|
223
|
+
| `api endpoint --limit 8` retrieval | 2,812 tokens |
|
|
224
|
+
| Observed retrieval payload reduction | 97.9% |
|
|
225
|
+
| Observed corpus/retrieval ratio | 47.69× |
|
|
226
|
+
|
|
227
|
+
This is a reproducible observation from one 16-project development workspace on
|
|
228
|
+
2026-07-22, not a universal token-cost, answer-quality, or task-success claim.
|
|
229
|
+
See [Graph Benchmark Methodology](docs/graph-benchmark-methodology.md) for the
|
|
230
|
+
source hash, formulas, limitations, and publication gate. Use
|
|
231
|
+
`workspace eval` when measuring provider-reported tokens, latency, cost, and a
|
|
232
|
+
verified execution outcome.
|
|
233
|
+
|
|
177
234
|
## Core Workflows
|
|
178
235
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
|
197
|
-
|
|
|
198
|
-
|
|
|
199
|
-
|
|
|
236
|
+
Use the complete intelligence runner for the normal end-to-end path. The
|
|
237
|
+
individual commands below are useful for inspection, automation, and targeted
|
|
238
|
+
reruns.
|
|
239
|
+
|
|
240
|
+
### Model, change, and decisions
|
|
241
|
+
|
|
242
|
+
| What you need | Command |
|
|
243
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------- |
|
|
244
|
+
| Build and persist the current system model | `npx workspai workspace model --json --write` |
|
|
245
|
+
| Save a model baseline | `npx workspai workspace snapshot --json` |
|
|
246
|
+
| Compare with a baseline or Git state | `npx workspai workspace diff --from <snapshot-or-git-ref> --json` |
|
|
247
|
+
| Calculate transitive blast radius | `npx workspai workspace impact --from <diff-report> --json` |
|
|
248
|
+
| Verify affected projects and evidence | `npx workspai workspace verify --from-impact <impact-report> --json --strict` |
|
|
249
|
+
| Explain a blocker | `npx workspai workspace explain release-blocked --json --write` |
|
|
250
|
+
|
|
251
|
+
### Graph, agents, and interoperability
|
|
252
|
+
|
|
253
|
+
| What you need | Command |
|
|
254
|
+
| ----------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
255
|
+
| Inspect a project in the dependency graph | `npx workspai workspace graph explain <project> --json` |
|
|
256
|
+
| Query proof-backed workspace entities | `npx workspai workspace graph entities endpoint --json` |
|
|
257
|
+
| Retrieve bounded context for an agent | `npx workspai workspace graph search "authentication endpoint" --limit 12 --json` |
|
|
258
|
+
| Measure retrieval payload reduction | `npx workspai workspace graph benchmark "authentication endpoint" --limit 12 --json` |
|
|
259
|
+
| Start a model-usage evaluation | `npx workspai workspace eval init repair-readiness workspace-intelligence --json` |
|
|
260
|
+
| Export graph for semantic/visual tools | `npx workspai workspace graph graphml --output workspace-graph.graphml` |
|
|
261
|
+
| Trace a relationship and its evidence | `npx workspai workspace graph path <from> <to> --json` |
|
|
262
|
+
| Compare two knowledge-graph revisions | `npx workspai workspace graph overlay --from <graph.json> --json` |
|
|
263
|
+
| Generate agent-ready context | `npx workspai workspace context --for-agent --json --write` |
|
|
264
|
+
| Generate portable agent and IDE surfaces | `npx workspai workspace agent-sync --write --refresh-context --preset enterprise --json` |
|
|
265
|
+
| Expose current evidence to MCP clients | `npx workspai workspace mcp serve` |
|
|
266
|
+
|
|
267
|
+
### Governance and operations
|
|
268
|
+
|
|
269
|
+
| What you need | Command |
|
|
270
|
+
| ------------------------------------ | --------------------------------------------------------------------------- |
|
|
271
|
+
| Run affected project tests | `npx workspai workspace run test --affected --blast-radius --json` |
|
|
272
|
+
| Run the release/governance gate | `npx workspai pipeline --json --strict` |
|
|
273
|
+
| Run the canonical intelligence chain | `npx workspai workspace intelligence run --for-agent codex --strict --json` |
|
|
200
274
|
|
|
201
275
|
`workspace verify` consumes current impact, doctor, contract, analysis, and
|
|
202
276
|
readiness evidence. Use `workspace intelligence run` for the canonical chain,
|
|
@@ -272,22 +346,39 @@ Workspai separates human output, machine output, and durable cross-tool state:
|
|
|
272
346
|
|
|
273
347
|
Important durable outputs:
|
|
274
348
|
|
|
275
|
-
| Artifact
|
|
276
|
-
|
|
|
277
|
-
| `.workspai/reports/workspace-model.json`
|
|
278
|
-
| `.workspai/reports/workspace-knowledge-graph.json`
|
|
279
|
-
| `.workspai/reports/workspace-model-diff-last-run.json`
|
|
280
|
-
| `.workspai/reports/workspace-impact-last-run.json`
|
|
281
|
-
| `.workspai/reports/workspace-verify-last-run.json`
|
|
282
|
-
| `.workspai/reports/workspace-context-agent.json`
|
|
283
|
-
| `.workspai/reports/INDEX.json`
|
|
284
|
-
| `.workspai/reports/workspace-explain-last-run.json`
|
|
285
|
-
| `.workspai/reports/workspace-intelligence-history.json`
|
|
286
|
-
| `.workspai/reports/
|
|
349
|
+
| Artifact | Producer | Used for |
|
|
350
|
+
| ------------------------------------------------------------------- | ------------------------------ | ------------------------------------------------ |
|
|
351
|
+
| `.workspai/reports/workspace-model.json` | `workspace model --write` | Canonical system structure |
|
|
352
|
+
| `.workspai/reports/workspace-knowledge-graph.json` | `workspace model --write` | Proof-backed retrieval and MCP |
|
|
353
|
+
| `.workspai/reports/workspace-model-diff-last-run.json` | `workspace diff` | Structural change evidence |
|
|
354
|
+
| `.workspai/reports/workspace-impact-last-run.json` | `workspace impact` | Blast radius and affected scope |
|
|
355
|
+
| `.workspai/reports/workspace-verify-last-run.json` | `workspace verify` | Structured verification gate |
|
|
356
|
+
| `.workspai/reports/workspace-context-agent.json` | `workspace context --write` | Canonical agent context |
|
|
357
|
+
| `.workspai/reports/INDEX.json` | `workspace agent-sync --write` | Agent read order and report discovery |
|
|
358
|
+
| `.workspai/reports/workspace-explain-last-run.json` | `workspace explain --write` | Evidence-backed narrative |
|
|
359
|
+
| `.workspai/reports/workspace-intelligence-history.json` | Verify and feedback flows | Trends and audit history |
|
|
360
|
+
| `.workspai/reports/workspace-intelligence-evaluation-live.json` | `workspace eval init/record` | Live provider/tokenizer usage and activity |
|
|
361
|
+
| `.workspai/reports/workspace-intelligence-evaluation-last-run.json` | `workspace eval report` | Final usage, cost, and verified outcome evidence |
|
|
362
|
+
| `.workspai/reports/pipeline-last-run.json` | `pipeline --json` | CI and release workflow result |
|
|
287
363
|
|
|
288
364
|
See the [Artifact Catalog](docs/contracts/ARTIFACT_CATALOG.md) for the complete
|
|
289
365
|
writer, schema, and consumer map.
|
|
290
366
|
|
|
367
|
+
### Graph interchange formats
|
|
368
|
+
|
|
369
|
+
The canonical persisted graph is JSON. Explicit projections make the same
|
|
370
|
+
governed data usable in documentation, semantic systems, and visualization
|
|
371
|
+
tools without changing the source of truth:
|
|
372
|
+
|
|
373
|
+
| Format | Typical use | Command selector |
|
|
374
|
+
| ------- | --------------------------------------- | ----------------------------- |
|
|
375
|
+
| JSON | Canonical artifact and programmatic use | `workspace graph emit --json` |
|
|
376
|
+
| JSON-LD | Semantic-web and linked-data tools | `workspace graph jsonld` |
|
|
377
|
+
| Mermaid | Markdown documentation and diagrams | `workspace graph mermaid` |
|
|
378
|
+
| DOT | Graphviz rendering | `workspace graph dot` |
|
|
379
|
+
| GraphML | General graph analysis tools | `workspace graph graphml` |
|
|
380
|
+
| GEXF | Exploration and visualization tools | `workspace graph gexf` |
|
|
381
|
+
|
|
291
382
|
## Onboard Software
|
|
292
383
|
|
|
293
384
|
All onboarding routes feed the same Workspace Intelligence model.
|
|
@@ -337,23 +428,27 @@ Python is not required for Python-free workspace profiles, npm-owned backend
|
|
|
337
428
|
generators, frontend generators, or workspaces created with
|
|
338
429
|
`--skip-python-engine`.
|
|
339
430
|
|
|
431
|
+
RapidKit Core is the optional Python engine used only by Python/Core-dependent
|
|
432
|
+
workflows; it is not a replacement CLI.
|
|
433
|
+
|
|
340
434
|
## Documentation
|
|
341
435
|
|
|
342
|
-
| Documentation
|
|
343
|
-
|
|
|
344
|
-
| [Documentation index](docs/README.md)
|
|
345
|
-
| [Command reference](docs/commands-reference.md)
|
|
346
|
-
| [Creating workspaces and projects](docs/creating-workspaces-and-projects.md)
|
|
347
|
-
| [Workspace operations](docs/workspace-operations.md)
|
|
348
|
-
| [Workspace run](docs/workspace-run.md)
|
|
349
|
-
| [Workspace Knowledge Graph](docs/workspace-knowledge-graph.md)
|
|
350
|
-
| [Graph benchmark methodology](docs/graph-benchmark-methodology.md)
|
|
351
|
-
| [
|
|
352
|
-
| [
|
|
353
|
-
| [
|
|
354
|
-
| [
|
|
355
|
-
| [
|
|
356
|
-
| [
|
|
436
|
+
| Documentation | Purpose |
|
|
437
|
+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------- |
|
|
438
|
+
| [Documentation index](docs/README.md) | All user, operator, contract, and contributor docs |
|
|
439
|
+
| [Command reference](docs/commands-reference.md) | Complete command syntax and flags |
|
|
440
|
+
| [Creating workspaces and projects](docs/creating-workspaces-and-projects.md) | Interactive, automated, location, and linking behavior |
|
|
441
|
+
| [Workspace operations](docs/workspace-operations.md) | Adopt, import, snapshots, archives, contracts, and infra |
|
|
442
|
+
| [Workspace run](docs/workspace-run.md) | Polyglot and affected-project execution |
|
|
443
|
+
| [Workspace Knowledge Graph](docs/workspace-knowledge-graph.md) | Proof-backed queries, AI/MCP retrieval, and graph outputs |
|
|
444
|
+
| [Graph benchmark methodology](docs/graph-benchmark-methodology.md) | Reproducible payload-reduction measurements and claim limits |
|
|
445
|
+
| [Workspace Intelligence Evaluation](docs/workspace-intelligence-evaluation.md) | Live token, cost, activity, and verified-outcome measurements |
|
|
446
|
+
| [Glossary](docs/GLOSSARY.md) | Plain-language meanings for model, graph, evidence, and gates |
|
|
447
|
+
| [Doctor command](docs/doctor-command.md) | Health checks, evidence, fixes, and exit codes |
|
|
448
|
+
| [CI workflows](docs/ci-workflows.md) | CI examples and repository validation |
|
|
449
|
+
| [Configuration](docs/config-file-guide.md) | User configuration and precedence |
|
|
450
|
+
| [Open-source scenarios](docs/OPEN_SOURCE_USER_SCENARIOS.md) | Role-oriented examples |
|
|
451
|
+
| [Artifact Catalog](docs/contracts/ARTIFACT_CATALOG.md) | Canonical files, writers, schemas, and readers |
|
|
357
452
|
|
|
358
453
|
Repository workflows include
|
|
359
454
|
[`.github/workflows/ci.yml`](../../.github/workflows/ci.yml),
|
|
@@ -376,7 +471,7 @@ contributor-automation map.
|
|
|
376
471
|
| Python/Core workflow cannot start | `python3 --version` | Install Python 3.10+ or use a Python-free profile where supported |
|
|
377
472
|
| Workspace is not detected | Look for `.workspai-workspace` | Run from the workspace or pass `--workspace <path>` |
|
|
378
473
|
| Strict policy blocks a command | `.workspai/policies.yml` | Inspect `workspace policy show` before changing policy |
|
|
379
|
-
| Reports are stale | Report timestamps | Re-run `
|
|
474
|
+
| Reports are stale | Report timestamps | Re-run `workspace intelligence run` or the documented producing command |
|
|
380
475
|
| AI tools ignore workspace evidence | `AGENTS.md` and `.workspai/reports/INDEX.json` | Run `workspace agent-sync --write --refresh-context` |
|
|
381
476
|
| Project generator fails | Runtime and network output | Fix the reported prerequisite, then retry or create officially and adopt |
|
|
382
477
|
|
|
@@ -115,6 +115,11 @@
|
|
|
115
115
|
"label": "Workspace knowledge graph",
|
|
116
116
|
"required": false
|
|
117
117
|
},
|
|
118
|
+
{
|
|
119
|
+
"path": ".workspai/reports/workspace-intelligence-evaluation-last-run.json",
|
|
120
|
+
"label": "Workspace Intelligence evaluation",
|
|
121
|
+
"required": false
|
|
122
|
+
},
|
|
118
123
|
{
|
|
119
124
|
"path": ".workspai/reports/doctor-last-run.json",
|
|
120
125
|
"label": "Workspace doctor",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": "rapidkit-extension-cli-compatibility.v1",
|
|
3
3
|
"cli": "workspai",
|
|
4
|
-
"minimumVerifiedCliVersion": "0.
|
|
4
|
+
"minimumVerifiedCliVersion": "0.48.0",
|
|
5
5
|
"publishedContractSchemas": {
|
|
6
6
|
"workspaceContract": 1,
|
|
7
7
|
"runtimeCommandSurface": "rapidkit-runtime-command-surface-v1",
|
|
@@ -32,7 +32,9 @@
|
|
|
32
32
|
"skillsIndex": "workspace-skills-index.v1",
|
|
33
33
|
"agents": null,
|
|
34
34
|
"explain": "workspace-explain.v1",
|
|
35
|
-
"intelligenceRun": "workspace-intelligence-run.v1"
|
|
35
|
+
"intelligenceRun": "workspace-intelligence-run.v1",
|
|
36
|
+
"evaluationLive": "workspace-intelligence-evaluation.v1",
|
|
37
|
+
"evaluationLastRun": "workspace-intelligence-evaluation.v1"
|
|
36
38
|
},
|
|
37
39
|
"cliLogEvent": "cli-log-event-v1",
|
|
38
40
|
"freshnessMetadata": "rapidkit-freshness-metadata-v1",
|
|
@@ -47,6 +49,9 @@
|
|
|
47
49
|
"workspaceKnowledgeGraphChangeOverlay": "workspace-knowledge-graph-change-overlay.v1",
|
|
48
50
|
"workspaceKnowledgeSearch": "workspace-knowledge-search.v1",
|
|
49
51
|
"workspaceGraphTokenEfficiency": "workspace-graph-token-efficiency.v1",
|
|
52
|
+
"modelUsageEvent": "model-usage-event.v1",
|
|
53
|
+
"workspaceIntelligenceEvaluation": "workspace-intelligence-evaluation.v1",
|
|
54
|
+
"workspaceIntelligenceEvaluationComparison": "workspace-intelligence-evaluation-comparison.v1",
|
|
50
55
|
"workspaceIntelligenceHistory": "workspace-intelligence-history.v1",
|
|
51
56
|
"agentCustomizationPackCapabilities": "workspai-agent-customization-pack-capabilities.v1",
|
|
52
57
|
"agentCustomizationPackReport": "rapidkit-agent-customization-pack.v1",
|
|
@@ -75,7 +75,9 @@
|
|
|
75
75
|
"skillsIndex": "workspace-skills-index.v1",
|
|
76
76
|
"agents": null,
|
|
77
77
|
"explain": "workspace-explain.v1",
|
|
78
|
-
"intelligenceRun": "workspace-intelligence-run.v1"
|
|
78
|
+
"intelligenceRun": "workspace-intelligence-run.v1",
|
|
79
|
+
"evaluationLive": "workspace-intelligence-evaluation.v1",
|
|
80
|
+
"evaluationLastRun": "workspace-intelligence-evaluation.v1"
|
|
79
81
|
},
|
|
80
82
|
"contractPath": null,
|
|
81
83
|
"publication": "embedded-type",
|
|
@@ -169,6 +171,16 @@
|
|
|
169
171
|
"path": ".workspai/reports/workspace-intelligence-run-last-run.json",
|
|
170
172
|
"schemaVersion": "workspace-intelligence-run.v1",
|
|
171
173
|
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-run.v1.json"
|
|
174
|
+
},
|
|
175
|
+
"evaluationLive": {
|
|
176
|
+
"path": ".workspai/reports/workspace-intelligence-evaluation-live.json",
|
|
177
|
+
"schemaVersion": "workspace-intelligence-evaluation.v1",
|
|
178
|
+
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json"
|
|
179
|
+
},
|
|
180
|
+
"evaluationLastRun": {
|
|
181
|
+
"path": ".workspai/reports/workspace-intelligence-evaluation-last-run.json",
|
|
182
|
+
"schemaVersion": "workspace-intelligence-evaluation.v1",
|
|
183
|
+
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json"
|
|
172
184
|
}
|
|
173
185
|
}
|
|
174
186
|
},
|
|
@@ -237,6 +249,21 @@
|
|
|
237
249
|
"contractPath": "contracts/workspace-intelligence/workspace-graph-token-efficiency.v1.json",
|
|
238
250
|
"publication": "json-schema"
|
|
239
251
|
},
|
|
252
|
+
"modelUsageEvent": {
|
|
253
|
+
"schemaVersion": "model-usage-event.v1",
|
|
254
|
+
"contractPath": "contracts/workspace-intelligence/model-usage-event.v1.json",
|
|
255
|
+
"publication": "json-schema"
|
|
256
|
+
},
|
|
257
|
+
"workspaceIntelligenceEvaluation": {
|
|
258
|
+
"schemaVersion": "workspace-intelligence-evaluation.v1",
|
|
259
|
+
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-evaluation.v1.json",
|
|
260
|
+
"publication": "json-schema"
|
|
261
|
+
},
|
|
262
|
+
"workspaceIntelligenceEvaluationComparison": {
|
|
263
|
+
"schemaVersion": "workspace-intelligence-evaluation-comparison.v1",
|
|
264
|
+
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-evaluation-comparison.v1.json",
|
|
265
|
+
"publication": "json-schema"
|
|
266
|
+
},
|
|
240
267
|
"workspaceIntelligenceHistory": {
|
|
241
268
|
"schemaVersion": "workspace-intelligence-history.v1",
|
|
242
269
|
"contractPath": "contracts/workspace-intelligence/workspace-intelligence-history.v1.json",
|