workspai 0.47.0 → 0.49.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 +247 -136
- package/contracts/agent-customization-pack.v1.json +5 -0
- package/contracts/cli-runtime-command-inventory.v1.snapshot.json +4 -0
- package/contracts/extension-cli-compatibility.v1.json +8 -2
- package/contracts/published-contract-catalog.v1.json +33 -1
- package/contracts/runtime-command-surface.v1.json +163 -3
- package/contracts/workspace-intelligence/model-usage-event.v1.json +82 -0
- package/contracts/workspace-intelligence/workspace-graph-stream.v1.json +262 -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-R4XRTWEM.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-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-KZZ36CK5.js → chunk-E2KJ5QWY.js} +1 -1
- package/dist/{chunk-BSRVO52Y.js → chunk-EKZLUMCS.js} +2 -2
- 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-COARSXRC.js → chunk-J5ENLXDF.js} +1 -1
- package/dist/{chunk-QDWYIRHR.js → chunk-K4X3DM7R.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-7VLCK5JW.js → chunk-RHQW3DTP.js} +1 -1
- package/dist/{chunk-22NJ2ZMG.js → chunk-T4YR4RAI.js} +1 -1
- package/dist/{chunk-VBSQ7MF6.js → chunk-TIE2XMGH.js} +20 -20
- package/dist/{chunk-HSGFUKCN.js → chunk-VU7NZHPM.js} +1 -1
- package/dist/{chunk-U5EZHZBX.js → chunk-YJZOMRAS.js} +1 -1
- package/dist/{create-7JKJDAQV.js → create-S64IWHAP.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 +35 -11
- package/dist/index.js +138 -136
- package/dist/{pipeline-IB6ILJSV.js → pipeline-LHTPE3DR.js} +1 -1
- package/dist/{springboot-standard-JJNUID6M.js → springboot-standard-55XKCBIZ.js} +4 -4
- package/dist/{workspace-H3QXBFGB.js → workspace-PJPRBUMQ.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-WPLD7OEO.js} +1 -1
- package/dist/workspace-graph-stream-KAGGQPJT.js +1 -0
- 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-OTYTHV6B.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-QND2SIYA.js +1 -0
- package/dist/{workspace-verify-ZGH3NXAH.js → workspace-verify-EBVL7FWT.js} +1 -1
- package/dist/workspace-watch-7HWGA5TF.js +1 -0
- package/docs/GLOSSARY.md +28 -24
- package/docs/OPEN_SOURCE_USER_SCENARIOS.md +11 -8
- package/docs/README.md +62 -23
- package/docs/README_CONTENT_CONTRACT.md +154 -0
- package/docs/ci-workflows.md +3 -3
- package/docs/commands-reference.md +16 -3
- package/docs/contracts/ARTIFACT_CATALOG.md +35 -20
- package/docs/contracts/README.md +3 -0
- package/docs/creating-workspaces-and-projects.md +16 -12
- package/docs/doctor-command.md +30 -28
- package/docs/examples/ci-agent-grounding.yml +1 -1
- package/docs/from-code-to-shared-understanding.md +2 -2
- package/docs/graph-benchmark-methodology.md +2 -2
- package/docs/workspace-intelligence-evaluation.md +149 -0
- package/docs/workspace-intelligence-runner.md +17 -6
- package/docs/workspace-knowledge-graph.md +31 -10
- package/docs/workspace-operations.md +13 -5
- package/package.json +9 -4
- package/templates/kits/fastapi-ddd/README.md.j2 +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/dist/workspace-watch-EVBJTMV7.js +0 -1
package/README.md
CHANGED
|
@@ -1,137 +1,171 @@
|
|
|
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
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
45
|
-
|
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
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
|
+
|
|
17
|
+
- **See the system:** projects, runtimes, APIs, dependencies, infrastructure,
|
|
18
|
+
documentation, policies, and release state in one model.
|
|
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
|
+
|
|
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)
|
|
29
|
+
|
|
30
|
+
## Understand Workspai in one minute
|
|
31
|
+
|
|
32
|
+
Your software system is more than a repository. It may include several
|
|
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
|
+
|
|
37
|
+
| Term | Plain-language meaning |
|
|
38
|
+
| ------------------- | ------------------------------------------------------------------------------------ |
|
|
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.
|
|
51
|
+
|
|
52
|
+
The deterministic model, graph, contracts, and verification chain do not
|
|
53
|
+
require an AI API key. Optional AI-backed features declare that dependency
|
|
54
|
+
separately.
|
|
55
|
+
|
|
56
|
+
## Start in two minutes
|
|
57
|
+
|
|
58
|
+
### 1. Install or use `npx`
|
|
59
59
|
|
|
60
60
|
```bash
|
|
61
61
|
npm install -g workspai
|
|
62
62
|
workspai --help
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Global installation is optional. Every example below also works with
|
|
66
|
+
`npx workspai`. The separate `wspai` package is only a short alias:
|
|
66
67
|
|
|
67
68
|
```bash
|
|
68
69
|
npx wspai --help
|
|
69
70
|
```
|
|
70
71
|
|
|
71
|
-
`workspai` is the
|
|
72
|
-
|
|
73
|
-
used only by Python/Core-dependent workflows; it is not a replacement CLI.
|
|
74
|
-
This package is the active CLI boundary in the
|
|
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
|
|
75
74
|
[Workspai monorepo](../../README.md).
|
|
76
75
|
|
|
77
|
-
###
|
|
78
|
-
|
|
79
|
-
Browse all commands from the latest release without a global install:
|
|
76
|
+
### 2. Connect an existing project
|
|
80
77
|
|
|
81
78
|
```bash
|
|
82
|
-
|
|
79
|
+
cd /absolute/path/to/project
|
|
80
|
+
npx workspai adopt .
|
|
83
81
|
```
|
|
84
82
|
|
|
85
|
-
|
|
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 prints the
|
|
85
|
+
exact `Next shell step`.
|
|
86
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.
|
|
87
|
+
### 3. Continue from the workspace root
|
|
90
88
|
|
|
91
|
-
|
|
89
|
+
Without the VS Code extension, copy the printed `Next shell step` and continue
|
|
90
|
+
in that workspace terminal:
|
|
92
91
|
|
|
93
92
|
```bash
|
|
94
|
-
npx workspai adopt /path/to/project --json
|
|
95
93
|
cd ~/.workspai/workspaces/workspai
|
|
94
|
+
npx workspai workspace intelligence run --for-agent generic --strict --json
|
|
96
95
|
```
|
|
97
96
|
|
|
98
|
-
|
|
99
|
-
agent
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
npx workspai workspace intelligence run --for-agent codex --strict --json
|
|
103
|
-
```
|
|
97
|
+
`generic` creates vendor-neutral context. Use `codex`, `claude`, `cursor`, or
|
|
98
|
+
`orca` when you want context shaped for that agent. Agent Sync also writes the
|
|
99
|
+
shared files used by GitHub Copilot, VS Code, and `AGENTS.md` consumers without
|
|
100
|
+
changing the system information or the checks Workspai runs.
|
|
104
101
|
|
|
105
|
-
|
|
106
|
-
commands, policies, contracts, health, and release evidence. The first durable
|
|
107
|
-
outputs include:
|
|
102
|
+
The run saves its results so people and tools can inspect and reuse them:
|
|
108
103
|
|
|
109
104
|
```text
|
|
110
|
-
.workspai/
|
|
111
|
-
|
|
112
|
-
.
|
|
113
|
-
|
|
105
|
+
.workspai/
|
|
106
|
+
├── workspace.json
|
|
107
|
+
├── workspace.contract.json
|
|
108
|
+
├── AGENT-GROUNDING.md
|
|
109
|
+
└── reports/
|
|
110
|
+
├── workspace-model.json
|
|
111
|
+
├── workspace-knowledge-graph.json
|
|
112
|
+
├── workspace-impact-last-run.json
|
|
113
|
+
├── workspace-verify-last-run.json
|
|
114
|
+
├── workspace-context-agent.json
|
|
115
|
+
├── workspace-intelligence-run-last-run.json
|
|
116
|
+
└── INDEX.json
|
|
114
117
|
AGENTS.md
|
|
115
118
|
```
|
|
116
119
|
|
|
117
|
-
|
|
118
|
-
|
|
120
|
+
For automation details, including exit codes and blocked results, see the
|
|
121
|
+
[Unified runner guide](docs/workspace-intelligence-runner.md). A blocked result
|
|
122
|
+
is useful evidence, not a crashed command.
|
|
119
123
|
|
|
120
|
-
|
|
121
|
-
ready; it is not a substitute for the canonical chain:
|
|
124
|
+
When you are ready for the broader release workflow, run:
|
|
122
125
|
|
|
123
126
|
```bash
|
|
124
127
|
npx workspai pipeline --json --strict
|
|
125
128
|
```
|
|
126
129
|
|
|
130
|
+
Starting new software instead?
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
npx workspai create workspace my-workspace --profile minimal --yes
|
|
134
|
+
cd ~/.workspai/workspaces/my-workspace
|
|
135
|
+
npx workspai create project nextjs web --yes
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
From the `my-workspace` terminal, create a project, use `adopt` to link one in
|
|
139
|
+
place, or use `import` to copy or clone one into the workspace. See
|
|
140
|
+
[Creating Workspaces and Projects](docs/creating-workspaces-and-projects.md)
|
|
141
|
+
for supported starters.
|
|
142
|
+
|
|
127
143
|
## From Code to Shared Understanding
|
|
128
144
|
|
|
129
|
-

|
|
130
146
|
|
|
131
147
|
[View the Mermaid source and explanation](docs/from-code-to-shared-understanding.md).
|
|
132
148
|
|
|
133
149
|
Workspai is the deterministic layer between source code and its consumers:
|
|
134
150
|
|
|
151
|
+
```text
|
|
152
|
+
Code · packages · APIs · infrastructure · docs · CI · policies
|
|
153
|
+
│
|
|
154
|
+
deterministic providers
|
|
155
|
+
│
|
|
156
|
+
facts + proofs
|
|
157
|
+
│
|
|
158
|
+
Canonical Workspace Model
|
|
159
|
+
│ │
|
|
160
|
+
│ └── Evidence-backed Knowledge Graph
|
|
161
|
+
│ │
|
|
162
|
+
└──────────┬──────────────┘
|
|
163
|
+
│
|
|
164
|
+
diff · impact · verify · context · explain
|
|
165
|
+
│
|
|
166
|
+
Developers · CI · IDEs · MCP · AI agents
|
|
167
|
+
```
|
|
168
|
+
|
|
135
169
|
| Capability | What it answers |
|
|
136
170
|
| --------------------- | ------------------------------------------------------------------------------------------- |
|
|
137
171
|
| **Model** | What projects, runtimes, frameworks, commands, policies, contracts, and dependencies exist? |
|
|
@@ -147,6 +181,10 @@ Create, import, and adopt add software to this boundary. Workspace Intelligence
|
|
|
147
181
|
then models and governs every registered project, whether Workspai created it or
|
|
148
182
|
it already existed.
|
|
149
183
|
|
|
184
|
+
Unlike repository-only code intelligence, the workspace boundary can connect
|
|
185
|
+
evidence across multiple projects and repositories. A missing relationship
|
|
186
|
+
means **not proven by current evidence**, not "these projects are independent."
|
|
187
|
+
|
|
150
188
|
## One Intelligence Chain
|
|
151
189
|
|
|
152
190
|
The canonical execution order is versioned in
|
|
@@ -174,29 +212,81 @@ and enforce this exact contract-backed order. `pipeline --json --strict` remains
|
|
|
174
212
|
the broader governance/release orchestrator (`sync → doctor → analyze → readiness
|
|
175
213
|
→ autopilot`); it is not an alias for the canonical intelligence chain.
|
|
176
214
|
|
|
215
|
+
## Evidence and measurable context
|
|
216
|
+
|
|
217
|
+
Without bounded retrieval, a developer or agent often has to search and read a
|
|
218
|
+
large part of the workspace before answering a local question. Workspai can
|
|
219
|
+
return the matching entities, nearby relations, and source proofs first:
|
|
220
|
+
|
|
221
|
+
```bash
|
|
222
|
+
npx workspai workspace graph search "who implements the login API?" --limit 8 --json
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
Use the complete graph for interchange and audits; use bounded search for
|
|
226
|
+
normal questions and agent context. Workspai reports unknown or unproven
|
|
227
|
+
relationships instead of inventing an edge.
|
|
228
|
+
|
|
229
|
+
### Current measured fixture
|
|
230
|
+
|
|
231
|
+
| Measure | Observed value |
|
|
232
|
+
| ------------------------------------ | -------------: |
|
|
233
|
+
| Registered projects | 16 |
|
|
234
|
+
| Knowledge Graph entities | 1,738 |
|
|
235
|
+
| Knowledge Graph relations | 2,244 |
|
|
236
|
+
| Portable proofs | 2,106 |
|
|
237
|
+
| Readable proof-source artifacts | 392 |
|
|
238
|
+
| Corpus size (`characters / 4`) | 134,105 tokens |
|
|
239
|
+
| `api endpoint --limit 8` retrieval | 2,812 tokens |
|
|
240
|
+
| Observed retrieval payload reduction | 97.9% |
|
|
241
|
+
| Observed corpus/retrieval ratio | 47.69× |
|
|
242
|
+
|
|
243
|
+
This is a reproducible observation from one 16-project development workspace on
|
|
244
|
+
2026-07-22, not a universal token-cost, answer-quality, or task-success claim.
|
|
245
|
+
See [Graph Benchmark Methodology](docs/graph-benchmark-methodology.md) for the
|
|
246
|
+
source hash, formulas, limitations, and publication gate. Use
|
|
247
|
+
`workspace eval` when measuring provider-reported tokens, latency, cost, and a
|
|
248
|
+
verified execution outcome.
|
|
249
|
+
|
|
177
250
|
## Core Workflows
|
|
178
251
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
|
197
|
-
|
|
|
198
|
-
|
|
|
199
|
-
|
|
|
252
|
+
Use the complete intelligence runner for the normal end-to-end path. The
|
|
253
|
+
individual commands below are useful for inspection, automation, and targeted
|
|
254
|
+
reruns.
|
|
255
|
+
|
|
256
|
+
### Model, change, and decisions
|
|
257
|
+
|
|
258
|
+
| What you need | Command |
|
|
259
|
+
| ------------------------------------------ | ----------------------------------------------------------------------------- |
|
|
260
|
+
| Build and persist the current system model | `npx workspai workspace model --json --write` |
|
|
261
|
+
| Save a model baseline | `npx workspai workspace snapshot --json` |
|
|
262
|
+
| Compare with a baseline or Git state | `npx workspai workspace diff --from <snapshot-or-git-ref> --json` |
|
|
263
|
+
| Calculate transitive blast radius | `npx workspai workspace impact --from <diff-report> --json` |
|
|
264
|
+
| Verify affected projects and evidence | `npx workspai workspace verify --from-impact <impact-report> --json --strict` |
|
|
265
|
+
| Explain a blocker | `npx workspai workspace explain release-blocked --json --write` |
|
|
266
|
+
|
|
267
|
+
### Graph, agents, and interoperability
|
|
268
|
+
|
|
269
|
+
| What you need | Command |
|
|
270
|
+
| ----------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
271
|
+
| Inspect a project in the dependency graph | `npx workspai workspace graph explain <project> --json` |
|
|
272
|
+
| Query proof-backed workspace entities | `npx workspai workspace graph entities endpoint --json` |
|
|
273
|
+
| Retrieve bounded context for an agent | `npx workspai workspace graph search "authentication endpoint" --limit 12 --json` |
|
|
274
|
+
| Measure retrieval payload reduction | `npx workspai workspace graph benchmark "authentication endpoint" --limit 12 --json` |
|
|
275
|
+
| Start a model-usage evaluation | `npx workspai workspace eval init repair-readiness workspace-intelligence --json` |
|
|
276
|
+
| Export graph for semantic/visual tools | `npx workspai workspace graph graphml --output workspace-graph.graphml` |
|
|
277
|
+
| Trace a relationship and its evidence | `npx workspai workspace graph path <from> <to> --json` |
|
|
278
|
+
| Compare two knowledge-graph revisions | `npx workspai workspace graph overlay --from <graph.json> --json` |
|
|
279
|
+
| Generate agent-ready context | `npx workspai workspace context --for-agent --json --write` |
|
|
280
|
+
| Generate portable agent and IDE surfaces | `npx workspai workspace agent-sync --write --refresh-context --preset enterprise --json` |
|
|
281
|
+
| Expose current evidence to MCP clients | `npx workspai workspace mcp serve` |
|
|
282
|
+
|
|
283
|
+
### Governance and operations
|
|
284
|
+
|
|
285
|
+
| What you need | Command |
|
|
286
|
+
| ------------------------------------ | ----------------------------------------------------------------------------- |
|
|
287
|
+
| Run affected project tests | `npx workspai workspace run test --affected --blast-radius --json` |
|
|
288
|
+
| Run the release/governance gate | `npx workspai pipeline --json --strict` |
|
|
289
|
+
| Run the canonical intelligence chain | `npx workspai workspace intelligence run --for-agent generic --strict --json` |
|
|
200
290
|
|
|
201
291
|
`workspace verify` consumes current impact, doctor, contract, analysis, and
|
|
202
292
|
readiness evidence. Use `workspace intelligence run` for the canonical chain,
|
|
@@ -272,22 +362,39 @@ Workspai separates human output, machine output, and durable cross-tool state:
|
|
|
272
362
|
|
|
273
363
|
Important durable outputs:
|
|
274
364
|
|
|
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/
|
|
365
|
+
| Artifact | Producer | Used for |
|
|
366
|
+
| ------------------------------------------------------------------- | ------------------------------ | ------------------------------------------------ |
|
|
367
|
+
| `.workspai/reports/workspace-model.json` | `workspace model --write` | Canonical system structure |
|
|
368
|
+
| `.workspai/reports/workspace-knowledge-graph.json` | `workspace model --write` | Proof-backed retrieval and MCP |
|
|
369
|
+
| `.workspai/reports/workspace-model-diff-last-run.json` | `workspace diff` | Structural change evidence |
|
|
370
|
+
| `.workspai/reports/workspace-impact-last-run.json` | `workspace impact` | Blast radius and affected scope |
|
|
371
|
+
| `.workspai/reports/workspace-verify-last-run.json` | `workspace verify` | Structured verification gate |
|
|
372
|
+
| `.workspai/reports/workspace-context-agent.json` | `workspace context --write` | Canonical agent context |
|
|
373
|
+
| `.workspai/reports/INDEX.json` | `workspace agent-sync --write` | Agent read order and report discovery |
|
|
374
|
+
| `.workspai/reports/workspace-explain-last-run.json` | `workspace explain --write` | Evidence-backed narrative |
|
|
375
|
+
| `.workspai/reports/workspace-intelligence-history.json` | Verify and feedback flows | Trends and audit history |
|
|
376
|
+
| `.workspai/reports/workspace-intelligence-evaluation-live.json` | `workspace eval init/record` | Live provider/tokenizer usage and activity |
|
|
377
|
+
| `.workspai/reports/workspace-intelligence-evaluation-last-run.json` | `workspace eval report` | Final usage, cost, and verified outcome evidence |
|
|
378
|
+
| `.workspai/reports/pipeline-last-run.json` | `pipeline --json` | CI and release workflow result |
|
|
287
379
|
|
|
288
380
|
See the [Artifact Catalog](docs/contracts/ARTIFACT_CATALOG.md) for the complete
|
|
289
381
|
writer, schema, and consumer map.
|
|
290
382
|
|
|
383
|
+
### Graph interchange formats
|
|
384
|
+
|
|
385
|
+
The canonical persisted graph is JSON. Explicit projections make the same
|
|
386
|
+
governed data usable in documentation, semantic systems, and visualization
|
|
387
|
+
tools without changing the source of truth:
|
|
388
|
+
|
|
389
|
+
| Format | Typical use | Command selector |
|
|
390
|
+
| ------- | --------------------------------------- | ----------------------------- |
|
|
391
|
+
| JSON | Canonical artifact and programmatic use | `workspace graph emit --json` |
|
|
392
|
+
| JSON-LD | Semantic-web and linked-data tools | `workspace graph jsonld` |
|
|
393
|
+
| Mermaid | Markdown documentation and diagrams | `workspace graph mermaid` |
|
|
394
|
+
| DOT | Graphviz rendering | `workspace graph dot` |
|
|
395
|
+
| GraphML | General graph analysis tools | `workspace graph graphml` |
|
|
396
|
+
| GEXF | Exploration and visualization tools | `workspace graph gexf` |
|
|
397
|
+
|
|
291
398
|
## Onboard Software
|
|
292
399
|
|
|
293
400
|
All onboarding routes feed the same Workspace Intelligence model.
|
|
@@ -297,7 +404,7 @@ All onboarding routes feed the same Workspace Intelligence model.
|
|
|
297
404
|
| Adopt | Existing source should stay in place | `npx workspai adopt /path/to/project --json` |
|
|
298
405
|
| Import local | Existing source should be copied into a workspace | `npx workspai import ../orders-api --workspace /path/to/workspace --json` |
|
|
299
406
|
| 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` |
|
|
300
|
-
| Create workspace | You need a new governed boundary | `npx workspai create workspace
|
|
407
|
+
| Create workspace | You need a new governed boundary | `npx workspai create workspace my-workspace --profile polyglot --yes` |
|
|
301
408
|
| Create project | You need a supported new scaffold | `npx workspai create project nextjs web --yes` |
|
|
302
409
|
| Interactive | You want Workspai to guide the choice | `npx workspai create` |
|
|
303
410
|
|
|
@@ -337,23 +444,27 @@ Python is not required for Python-free workspace profiles, npm-owned backend
|
|
|
337
444
|
generators, frontend generators, or workspaces created with
|
|
338
445
|
`--skip-python-engine`.
|
|
339
446
|
|
|
447
|
+
RapidKit Core is the optional Python engine used only by Python/Core-dependent
|
|
448
|
+
workflows; it is not a replacement CLI.
|
|
449
|
+
|
|
340
450
|
## Documentation
|
|
341
451
|
|
|
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
|
-
| [
|
|
452
|
+
| Documentation | Purpose |
|
|
453
|
+
| ------------------------------------------------------------------------------ | ------------------------------------------------------------- |
|
|
454
|
+
| [Documentation index](docs/README.md) | All user, operator, contract, and contributor docs |
|
|
455
|
+
| [Command reference](docs/commands-reference.md) | Complete command syntax and flags |
|
|
456
|
+
| [Creating workspaces and projects](docs/creating-workspaces-and-projects.md) | Interactive, automated, location, and linking behavior |
|
|
457
|
+
| [Workspace operations](docs/workspace-operations.md) | Adopt, import, snapshots, archives, contracts, and infra |
|
|
458
|
+
| [Workspace run](docs/workspace-run.md) | Polyglot and affected-project execution |
|
|
459
|
+
| [Workspace Knowledge Graph](docs/workspace-knowledge-graph.md) | Proof-backed queries, AI/MCP retrieval, and graph outputs |
|
|
460
|
+
| [Graph benchmark methodology](docs/graph-benchmark-methodology.md) | Reproducible payload-reduction measurements and claim limits |
|
|
461
|
+
| [Workspace Intelligence Evaluation](docs/workspace-intelligence-evaluation.md) | Live token, cost, activity, and verified-outcome measurements |
|
|
462
|
+
| [Glossary](docs/GLOSSARY.md) | Plain-language meanings for model, graph, evidence, and gates |
|
|
463
|
+
| [Doctor command](docs/doctor-command.md) | Health checks, evidence, fixes, and exit codes |
|
|
464
|
+
| [CI workflows](docs/ci-workflows.md) | CI examples and repository validation |
|
|
465
|
+
| [Configuration](docs/config-file-guide.md) | User configuration and precedence |
|
|
466
|
+
| [Open-source scenarios](docs/OPEN_SOURCE_USER_SCENARIOS.md) | Role-oriented examples |
|
|
467
|
+
| [Artifact Catalog](docs/contracts/ARTIFACT_CATALOG.md) | Canonical files, writers, schemas, and readers |
|
|
357
468
|
|
|
358
469
|
Repository workflows include
|
|
359
470
|
[`.github/workflows/ci.yml`](../../.github/workflows/ci.yml),
|
|
@@ -376,7 +487,7 @@ contributor-automation map.
|
|
|
376
487
|
| Python/Core workflow cannot start | `python3 --version` | Install Python 3.10+ or use a Python-free profile where supported |
|
|
377
488
|
| Workspace is not detected | Look for `.workspai-workspace` | Run from the workspace or pass `--workspace <path>` |
|
|
378
489
|
| Strict policy blocks a command | `.workspai/policies.yml` | Inspect `workspace policy show` before changing policy |
|
|
379
|
-
| Reports are stale | Report timestamps | Re-run `
|
|
490
|
+
| Reports are stale | Report timestamps | Re-run `workspace intelligence run` or the documented producing command |
|
|
380
491
|
| AI tools ignore workspace evidence | `AGENTS.md` and `.workspai/reports/INDEX.json` | Run `workspace agent-sync --write --refresh-context` |
|
|
381
492
|
| Project generator fails | Runtime and network output | Fix the reported prerequisite, then retry or create officially and adopt |
|
|
382
493
|
|
|
@@ -388,7 +499,7 @@ For command-specific behavior, use the
|
|
|
388
499
|
|
|
389
500
|
Workspai is MIT-licensed and developed in the open. Contributions to runtime
|
|
390
501
|
support, contracts, documentation, tests, and Workspace Intelligence workflows
|
|
391
|
-
are welcome.
|
|
502
|
+
are welcome. Workspai is built by [Chistiq](https://chistiq.com/).
|
|
392
503
|
|
|
393
504
|
From a source checkout:
|
|
394
505
|
|
|
@@ -404,12 +515,12 @@ Go, Java, and .NET are required only for workflows that exercise those runtimes.
|
|
|
404
515
|
To validate only this package, run `npm --workspace workspai run validate` from
|
|
405
516
|
the monorepo root.
|
|
406
517
|
|
|
407
|
-
- Read [CONTRIBUTING.md](https://github.com/
|
|
408
|
-
- Use [GitHub Issues](https://github.com/
|
|
409
|
-
- Use [GitHub Discussions](https://github.com/
|
|
518
|
+
- Read [CONTRIBUTING.md](https://github.com/chistiq/workspai/blob/main/packages/cli/CONTRIBUTING.md) before submitting changes.
|
|
519
|
+
- Use [GitHub Issues](https://github.com/chistiq/workspai/issues) for reproducible bugs and feature requests.
|
|
520
|
+
- Use [GitHub Discussions](https://github.com/chistiq/workspai/discussions) for questions and design conversations.
|
|
410
521
|
- Read the [Development Guide](docs/DEVELOPMENT.md) for local workflows.
|
|
411
522
|
- Report vulnerabilities through the [Security Policy](docs/SECURITY.md), not a public issue.
|
|
412
|
-
- Review the [Changelog](https://github.com/
|
|
523
|
+
- Review the [Changelog](https://github.com/chistiq/workspai/blob/main/packages/cli/CHANGELOG.md) before upgrading.
|
|
413
524
|
|
|
414
525
|
## License
|
|
415
526
|
|
|
@@ -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.49.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",
|
|
@@ -44,9 +46,13 @@
|
|
|
44
46
|
"workspaceContext": "workspace-context.v1",
|
|
45
47
|
"workspaceDependencyGraph": "workspace-dependency-graph.v1",
|
|
46
48
|
"workspaceKnowledgeGraph": "workspace-knowledge-graph.v1",
|
|
49
|
+
"workspaceGraphStream": "workspace-graph-stream.v1",
|
|
47
50
|
"workspaceKnowledgeGraphChangeOverlay": "workspace-knowledge-graph-change-overlay.v1",
|
|
48
51
|
"workspaceKnowledgeSearch": "workspace-knowledge-search.v1",
|
|
49
52
|
"workspaceGraphTokenEfficiency": "workspace-graph-token-efficiency.v1",
|
|
53
|
+
"modelUsageEvent": "model-usage-event.v1",
|
|
54
|
+
"workspaceIntelligenceEvaluation": "workspace-intelligence-evaluation.v1",
|
|
55
|
+
"workspaceIntelligenceEvaluationComparison": "workspace-intelligence-evaluation-comparison.v1",
|
|
50
56
|
"workspaceIntelligenceHistory": "workspace-intelligence-history.v1",
|
|
51
57
|
"agentCustomizationPackCapabilities": "workspai-agent-customization-pack-capabilities.v1",
|
|
52
58
|
"agentCustomizationPackReport": "rapidkit-agent-customization-pack.v1",
|