rapidkit 0.36.0 → 0.37.1
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 +195 -24
- package/contracts/analyze-last-run.v1.json +106 -0
- package/contracts/cli-log-event.v1.json +51 -0
- package/contracts/doctor-project-evidence.v1.json +46 -0
- package/contracts/doctor-workspace-evidence.v1.json +57 -0
- package/contracts/release-readiness.v1.json +60 -0
- package/contracts/workspace-registry.v1.json +83 -0
- package/contracts/workspace-run-last.v1.json +112 -0
- package/dist/analyze-6RFG7C7Z.js +1 -0
- package/dist/autopilot-release-QNZ2IL7K.js +1 -0
- package/dist/chunk-3SWQKRXH.js +2 -0
- package/dist/chunk-6P5DCHBQ.js +4 -0
- package/dist/chunk-7RBZGQ7T.js +7 -0
- package/dist/chunk-B2KOIORF.js +1 -0
- package/dist/{chunk-VPNHGQIV.js → chunk-C7OVQQXT.js} +1 -1
- package/dist/chunk-C7WILE56.js +1 -0
- package/dist/chunk-FV5A3N3I.js +2 -0
- package/dist/chunk-GDGATWR5.js +2 -0
- package/dist/chunk-HEG6DIGW.js +2 -0
- package/dist/chunk-IOIWVHRO.js +883 -0
- package/dist/chunk-JBDQADHY.js +50 -0
- package/dist/{chunk-AC6KIKII.js → chunk-PPQYTYQG.js} +4 -4
- package/dist/chunk-RELR4O5E.js +2 -0
- package/dist/{chunk-DC44JPI3.js → chunk-RUUDLAKJ.js} +12 -12
- package/dist/chunk-T5LN7EO5.js +9 -0
- package/dist/chunk-TRXYRHD7.js +2 -0
- package/dist/chunk-U6QUN6V2.js +2 -0
- package/dist/chunk-UXKB4KGZ.js +13 -0
- package/dist/{create-7R4CGABE.js → create-HN5HOGQ4.js} +1 -1
- package/dist/{demo-kit-KTRITRWH.js → demo-kit-3VTLJBP7.js} +1 -1
- package/dist/{doctor-DG3TBPZN.js → doctor-QC662YLH.js} +1 -1
- package/dist/{dotnet-webapi-clean-TPQMNFSD.js → dotnet-webapi-clean-FX533F5U.js} +1 -1
- package/dist/{gofiber-standard-NDCBY6OM.js → gofiber-standard-35CJZ7S3.js} +1 -1
- package/dist/{gogin-standard-WUOMIHDR.js → gogin-standard-SAX6C4ZK.js} +1 -1
- package/dist/index.js +214 -213
- package/dist/managed-agent-markers-AXUM75OE.js +8 -0
- package/dist/pipeline-IMB3C3JY.js +5 -0
- package/dist/{springboot-standard-WQWB5E24.js → springboot-standard-SFMSLTX4.js} +1 -1
- package/dist/{workspace-ZDL5IQU4.js → workspace-2AL5C3QZ.js} +1 -1
- package/dist/workspace-agent-sync-4R7S3F6T.js +17 -0
- package/dist/workspace-context-CKACDTVE.js +1 -0
- package/dist/{workspace-contract-A6QP7FPA.js → workspace-contract-D5O4OZD5.js} +1 -1
- package/dist/workspace-foundation-L6ZBGMVE.js +1 -0
- package/dist/{workspace-intelligence-VLA2RILM.js → workspace-intelligence-3TWXJQ7Y.js} +1 -1
- package/dist/{workspace-model-OO4WOBJS.js → workspace-model-NQVZN5W4.js} +1 -1
- package/dist/workspace-registry-summary-MIPHVB56.js +1 -0
- package/dist/workspace-run-PNMZJNDC.js +1 -0
- package/dist/workspace-verify-EO435PS4.js +1 -0
- package/docs/AI_DYNAMIC_INTEGRATION.md +440 -0
- package/docs/AI_EXAMPLES.md +419 -0
- package/docs/AI_FEATURES.md +460 -0
- package/docs/AI_QUICKSTART.md +245 -0
- package/docs/DEVELOPMENT.md +88 -0
- package/docs/From Code to Shared Understanding.png +0 -0
- package/docs/OPEN_SOURCE_USER_SCENARIOS.md +170 -0
- package/docs/OPTIMIZATION_GUIDE.md +504 -0
- package/docs/PACKAGE_MANAGER_POLICY.md +25 -0
- package/docs/README.md +120 -0
- package/docs/SECURITY.md +63 -0
- package/docs/SETUP.md +107 -0
- package/docs/UTILITIES.md +221 -0
- package/docs/WORKSPACE_MARKER_SPEC.md +276 -0
- package/docs/ci-workflows.md +56 -0
- package/docs/commands-reference.md +136 -0
- package/docs/config-file-guide.md +295 -0
- package/docs/contracts/ARTIFACT_CATALOG.md +104 -0
- package/docs/contracts/COMMAND_OWNERSHIP_MATRIX.md +138 -0
- package/docs/contracts/README.md +70 -0
- package/docs/contracts/RUNTIME_ACCEPTANCE_MATRIX.md +98 -0
- package/docs/contracts/RUNTIME_SUPPORT_MATRIX.md +74 -0
- package/docs/contracts/rapidkit-cli-contracts.json +239 -0
- package/docs/doctor-command.md +263 -0
- package/docs/examples/ci-agent-grounding.yml +62 -0
- package/docs/from-code-to-shared-understanding.md +46 -0
- package/docs/governance-policy.enterprise.example.json +40 -0
- package/docs/mirror-config.enterprise.example.json +60 -0
- package/docs/policies.workspace.example.yml +23 -0
- package/docs/workspace-operations.md +160 -0
- package/docs/workspace-run.md +80 -0
- package/package.json +4 -2
- package/dist/analyze-HXO6R656.js +0 -1
- package/dist/autopilot-release-FMQ5KND5.js +0 -1
- package/dist/chunk-45KNNNAB.js +0 -2
- package/dist/chunk-7ZSURMR2.js +0 -4
- package/dist/chunk-HUQ5WRUF.js +0 -883
- package/dist/chunk-IATULVMR.js +0 -11
- package/dist/chunk-KIB4KHBF.js +0 -3
- package/dist/chunk-MCLLP6MW.js +0 -2
- package/dist/chunk-TC2PSHT6.js +0 -50
- package/dist/chunk-UY4LZEXK.js +0 -7
- package/dist/chunk-VM2TOHNX.js +0 -2
- package/dist/chunk-Y2ZPG7KN.js +0 -9
- package/dist/pipeline-23AEXNF2.js +0 -5
- package/dist/workspace-context-YFQQROOZ.js +0 -2
- package/dist/workspace-foundation-QVWALXMP.js +0 -1
- package/dist/workspace-run-NIKH2IKF.js +0 -1
- package/dist/workspace-verify-XEXRCET7.js +0 -1
package/README.md
CHANGED
|
@@ -1,24 +1,120 @@
|
|
|
1
|
-
# RapidKit
|
|
1
|
+
# RapidKit
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
### Open-Source Workspace Intelligence for Software Systems
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
> AI agents understand files.
|
|
6
|
+
> RapidKit helps developers, CI, IDEs, and AI agents share the same understanding of the workspace.
|
|
7
|
+
|
|
8
|
+
**One workspace. One truth. Humans and AI aligned.**
|
|
9
|
+
|
|
10
|
+
RapidKit is the open-source workspace intelligence engine that turns scattered projects into a governed, agent-ready software system.
|
|
11
|
+
|
|
12
|
+
Build, adopt, and operate polyglot software systems with a shared, evidence-backed understanding for developers, CI pipelines, IDEs, and AI agents.
|
|
13
|
+
|
|
14
|
+
Instead of every tool rebuilding its own view of your system from files alone, RapidKit provides a shared source of truth: a workspace model, agent context, impact analysis, verification evidence, and release gates that all surfaces can consume.
|
|
15
|
+
|
|
16
|
+
## Quick start in 5 minutes
|
|
17
|
+
|
|
18
|
+
### Install the CLI
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install -g rapidkit
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Create a new workspace and project
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx rapidkit create workspace platform --yes --profile polyglot
|
|
28
|
+
|
|
29
|
+
cd platform
|
|
30
|
+
|
|
31
|
+
npx rapidkit bootstrap --profile polyglot
|
|
32
|
+
|
|
33
|
+
npx rapidkit create project
|
|
34
|
+
npx rapidkit create frontend nextjs my-web --yes
|
|
35
|
+
|
|
36
|
+
npx rapidkit workspace model
|
|
37
|
+
npx rapidkit workspace context --for-agent --write
|
|
38
|
+
npx rapidkit pipeline --strict
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Adopt an existing project
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx rapidkit adopt /path/to/project --workspace /path/to/workspace
|
|
45
|
+
|
|
46
|
+
npx rapidkit workspace model
|
|
47
|
+
npx rapidkit workspace context --for-agent --write
|
|
48
|
+
npx rapidkit pipeline --strict
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### What RapidKit gives you
|
|
52
|
+
|
|
53
|
+
* Adopt existing projects without migration
|
|
54
|
+
* Create and manage polyglot workspaces
|
|
55
|
+
* Generate canonical workspace models and agent-ready context
|
|
56
|
+
* Analyze impact before changes ship
|
|
57
|
+
* Verify release readiness with evidence-backed gates
|
|
58
|
+
* Keep developers, CI, IDEs, and AI agents aligned on the same workspace truth
|
|
59
|
+
|
|
60
|
+
### Workspace Intelligence
|
|
61
|
+
|
|
62
|
+
Most AI tools understand:
|
|
63
|
+
|
|
64
|
+
* Files
|
|
65
|
+
* Functions
|
|
66
|
+
* Repositories
|
|
67
|
+
|
|
68
|
+
Production systems require understanding:
|
|
69
|
+
|
|
70
|
+
* Ownership
|
|
71
|
+
* Architecture
|
|
72
|
+
* Dependencies
|
|
73
|
+
* Operational context
|
|
74
|
+
* Verification requirements
|
|
75
|
+
* Change impact
|
|
76
|
+
|
|
77
|
+
RapidKit adds the missing layer:
|
|
78
|
+
|
|
79
|
+
**Workspace Intelligence.**
|
|
80
|
+
|
|
81
|
+
**One workspace. One truth. Humans and AI aligned.**
|
|
82
|
+
|
|
83
|
+
A shared, evidence-backed understanding of software systems for developers, CI pipelines, IDEs, and AI agents.
|
|
84
|
+
|
|
85
|
+
In RapidKit, Workspace Intelligence is not a chat feature. It is the deterministic workspace layer behind the CLI:
|
|
86
|
+
|
|
87
|
+
* **Model** — what projects, runtimes, frameworks, commands, policies, contracts, and evidence exist
|
|
88
|
+
* **Context** — what AI agents and IDEs should know before giving advice
|
|
89
|
+
* **Impact** — what changed and which projects, commands, and release gates are affected
|
|
90
|
+
* **Verify** — which evidence proves the workspace is ready, blocked, or needs attention
|
|
91
|
+
* **Sync** — how developers, CI, Workspai, and AI agents stay grounded in the same truth
|
|
92
|
+
|
|
93
|
+
### From Code to Shared Understanding
|
|
94
|
+
How RapidKit transforms projects and repositories into workspace intelligence for developers, CI, and AI agents.
|
|
95
|
+
|
|
96
|
+

|
|
97
|
+
|
|
98
|
+
Mermaid source for GitHub docs: [from-code-to-shared-understanding.md](docs/from-code-to-shared-understanding.md).
|
|
99
|
+
|
|
100
|
+
RapidKit provides the workspace intelligence engine: model, context, impact, verification, evidence, contracts, and governance.
|
|
101
|
+
|
|
102
|
+
Workspai provides the VS Code experience on top of that foundation.
|
|
103
|
+
|
|
104
|
+
For the visual experience, install the [Workspai VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode).
|
|
6
105
|
|
|
7
106
|
[](https://www.npmjs.com/package/rapidkit)
|
|
8
107
|
[](https://www.npmjs.com/package/rapidkit)
|
|
9
108
|
[](https://opensource.org/licenses/MIT)
|
|
10
|
-
[](https://github.com/rapidkitlabs/rapidkit-npm/stargazers)
|
|
11
109
|
[](https://www.getrapidkit.com)
|
|
12
110
|
|
|
13
|
-
For the visual experience, install the [Workspai VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode). The extension calls this CLI for discovery, commands, evidence, and AI context — install `rapidkit@latest` globally or link locally for scaffold/adopt flows.
|
|
14
|
-
|
|
15
111
|
## Table of contents
|
|
16
112
|
|
|
17
|
-
- [
|
|
113
|
+
- [Typical workflows](#typical-workflows)
|
|
18
114
|
- [Mental model](#mental-model)
|
|
19
|
-
- [Workspace
|
|
115
|
+
- [Workspace Intelligence Commands](#workspace-intelligence-commands)
|
|
20
116
|
- [Requirements & install](#requirements)
|
|
21
|
-
- [
|
|
117
|
+
- [Project workflows](#project-workflows)
|
|
22
118
|
- [CI & evidence](#ci--evidence)
|
|
23
119
|
- [Workspai ecosystem](#workspai-ecosystem)
|
|
24
120
|
- [VS Code extension](#vs-code-extension)
|
|
@@ -27,15 +123,39 @@ For the visual experience, install the [Workspai VS Code extension](https://mark
|
|
|
27
123
|
- [Troubleshooting](#troubleshooting)
|
|
28
124
|
- [License](#license)
|
|
29
125
|
|
|
30
|
-
##
|
|
126
|
+
## Typical workflows
|
|
127
|
+
|
|
128
|
+
| Question | Command |
|
|
129
|
+
| --------------------------------------------- | ---------------------------------------------- |
|
|
130
|
+
| What projects exist in this workspace? | `workspace model --json` |
|
|
131
|
+
| What context should AI agents receive? | `workspace context --for-agent --json --write` |
|
|
132
|
+
| What breaks if I change this? | `workspace impact --from <snapshot>` |
|
|
133
|
+
| Can I safely release? | `pipeline --json --strict` |
|
|
134
|
+
| How do I align AI tools and CI? | `workspace agent-sync --write` |
|
|
135
|
+
| How do I onboard an existing project? | `adopt` |
|
|
136
|
+
| How do I bring repositories into a workspace? | `import` |
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
### Existing project
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
npx rapidkit adopt /path/to/project --workspace /path/to/workspace
|
|
143
|
+
npx rapidkit workspace model --json
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Agent-ready workspace
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
npx rapidkit workspace context --for-agent --json --write
|
|
150
|
+
npx rapidkit workspace agent-sync --write --refresh-context
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Release verification
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
npx rapidkit pipeline --json --strict
|
|
157
|
+
```
|
|
31
158
|
|
|
32
|
-
| If you have... | Use | What you get |
|
|
33
|
-
| --- | --- | --- |
|
|
34
|
-
| An existing project to keep in place | [`adopt`](docs/workspace-operations.md#import-and-adoption) | Links project, detects stack, writes metadata |
|
|
35
|
-
| A folder or repo to copy into a workspace | [`import`](docs/workspace-operations.md#import-and-adoption) | Copy/clone with rollback-safe sync |
|
|
36
|
-
| A new project from a kit | `create workspace` + `create project` / `create frontend` | Scaffold + governance evidence |
|
|
37
|
-
| CI or release gates | `pipeline --json --strict` | Full governance loop in one command |
|
|
38
|
-
| Agent-ready context | `workspace model` + `workspace context` | Canonical facts and context packs |
|
|
39
159
|
|
|
40
160
|
### Adopt in place
|
|
41
161
|
|
|
@@ -55,6 +175,9 @@ npx rapidkit adopt --json # from inside the project folder
|
|
|
55
175
|
|
|
56
176
|
New workspaces go under `~/rapidkit/workspaces/<name>`. Legacy `~/Workspai/rapidkits/*` paths remain registered. Use `--output <parent-dir>` for a custom parent.
|
|
57
177
|
|
|
178
|
+
|
|
179
|
+
## Mental model
|
|
180
|
+
|
|
58
181
|
### Two-layer model
|
|
59
182
|
|
|
60
183
|
```text
|
|
@@ -62,8 +185,6 @@ First-class engine kits → FastAPI and NestJS (modules + deep generation)
|
|
|
62
185
|
Workspace intelligence → frontend apps, Go, Spring, .NET, adopted/imported repos
|
|
63
186
|
```
|
|
64
187
|
|
|
65
|
-
## Mental model
|
|
66
|
-
|
|
67
188
|
RapidKit treats the **workspace** as the operating boundary: policy, registry, evidence, contracts, and release readiness. Projects can live inside the workspace or be **adopted** from outside.
|
|
68
189
|
|
|
69
190
|
```text
|
|
@@ -79,12 +200,14 @@ external-project/
|
|
|
79
200
|
|
|
80
201
|
Every tool gets the same answers: what projects exist, what stack they use, which commands are safe, what evidence exists, and what context agents should receive.
|
|
81
202
|
|
|
82
|
-
## Workspace
|
|
203
|
+
## Workspace Intelligence Commands
|
|
204
|
+
Workspace Intelligence provides a shared understanding of projects, dependencies, operational context, and release readiness for developers, CI pipelines, and AI agents.
|
|
83
205
|
|
|
84
206
|
| Command | Purpose |
|
|
85
207
|
| --- | --- |
|
|
86
208
|
| `workspace model --json` | Canonical workspace model |
|
|
87
|
-
| `workspace context --for-agent --json` | Agent-ready context pack |
|
|
209
|
+
| `workspace context --for-agent --json --write` | Agent-ready context pack + auto agent grounding sync |
|
|
210
|
+
| `workspace agent-sync --write` | Cross-tool grounding (AGENTS.md, Copilot, Cursor, Claude, INDEX) |
|
|
88
211
|
| `workspace snapshot --json` | Persist model snapshot |
|
|
89
212
|
| `workspace diff --from <file\|git[:ref]> --json` | Diff against snapshot or git |
|
|
90
213
|
| `workspace impact --from <file> --json` | Blast-radius evidence |
|
|
@@ -92,6 +215,43 @@ Every tool gets the same answers: what projects exist, what stack they use, whic
|
|
|
92
215
|
|
|
93
216
|
JSON schemas: `contracts/workspace-intelligence/`. Details: [commands-reference.md](docs/commands-reference.md).
|
|
94
217
|
|
|
218
|
+
### Agent grounding (CLI-only, no extension required)
|
|
219
|
+
|
|
220
|
+
RapidKit can sync **cross-tool instruction files** so Copilot, Cursor, Claude Code, Codex, Grok, and other agents read the same evidence before guessing:
|
|
221
|
+
|
|
222
|
+
```bash
|
|
223
|
+
# Full sync: refresh context pack + INDEX + AGENTS.md + Copilot/Cursor/Claude hooks
|
|
224
|
+
npx rapidkit workspace agent-sync --write --refresh-context
|
|
225
|
+
|
|
226
|
+
# Context pack write also syncs grounding by default
|
|
227
|
+
npx rapidkit workspace context --for-agent --json --write
|
|
228
|
+
|
|
229
|
+
# CI strict gate (fail if required reports missing/stale)
|
|
230
|
+
npx rapidkit workspace agent-sync --write --strict --json
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
| Artifact / file | Purpose |
|
|
234
|
+
| --- | --- |
|
|
235
|
+
| `.rapidkit/reports/INDEX.json` | Read order, blockers, report timestamps |
|
|
236
|
+
| `.rapidkit/reports/workspace-context-agent.json` | Canonical agent context pack |
|
|
237
|
+
| `.rapidkit/AGENT-GROUNDING.md` | Tool-agnostic grounding doc |
|
|
238
|
+
| `AGENTS.md` | Open standard for all agents (managed RapidKit section) |
|
|
239
|
+
| `.github/copilot-instructions.md` | GitHub Copilot / VS Code Chat always-on rules |
|
|
240
|
+
| `.github/instructions/rapidkit-evidence.instructions.md` | Copilot scoped rules for `.rapidkit/**` |
|
|
241
|
+
| `.github/prompts/rapidkit-diagnose.prompt.md` | Copilot reusable diagnose prompt |
|
|
242
|
+
| `.github/skills/rapidkit-grounding/SKILL.md` | Copilot agent skill workflow |
|
|
243
|
+
| `.cursor/rules/rapidkit-grounding.mdc` | Cursor always-on project rule |
|
|
244
|
+
| `CLAUDE.md` | Claude Code entry (`@AGENTS.md` + managed notes) |
|
|
245
|
+
| `.claude/rules/rapidkit-evidence.md` | Claude Code scoped evidence rules |
|
|
246
|
+
|
|
247
|
+
Agents cannot be **forced** probabilistically — but this stack maximizes the chance they read reports first, even when the user talks to Copilot directly without Workspai.
|
|
248
|
+
|
|
249
|
+
Skip auto-sync after context write: `--no-agent-sync`. Target specific ecosystems: `--target copilot,cursor,claude`.
|
|
250
|
+
|
|
251
|
+
After `pipeline`, grounding syncs automatically (refresh context + INDEX + hooks). Disable with `--no-agent-sync` or `RAPIDKIT_NO_AGENT_SYNC=1`.
|
|
252
|
+
|
|
253
|
+
CI template: [docs/examples/ci-agent-grounding.yml](docs/examples/ci-agent-grounding.yml).
|
|
254
|
+
|
|
95
255
|
## Requirements
|
|
96
256
|
|
|
97
257
|
- Node.js `>= 20.19.6`
|
|
@@ -106,7 +266,7 @@ npm install -g rapidkit
|
|
|
106
266
|
npx rapidkit --help
|
|
107
267
|
```
|
|
108
268
|
|
|
109
|
-
##
|
|
269
|
+
## Project workflows
|
|
110
270
|
|
|
111
271
|
### I already have a project
|
|
112
272
|
|
|
@@ -155,6 +315,7 @@ Common workspace commands:
|
|
|
155
315
|
|
|
156
316
|
```bash
|
|
157
317
|
npx rapidkit doctor workspace
|
|
318
|
+
npx rapidkit workspace agent-sync --write --refresh-context
|
|
158
319
|
npx rapidkit setup <python|node|go|java|dotnet> [--warm-deps]
|
|
159
320
|
npx rapidkit workspace list
|
|
160
321
|
npx rapidkit cache <status|clear|prune|repair>
|
|
@@ -165,6 +326,12 @@ Full syntax: [docs/commands-reference.md](docs/commands-reference.md). CI workfl
|
|
|
165
326
|
|
|
166
327
|
## Workspai ecosystem
|
|
167
328
|
|
|
329
|
+
RapidKit and Workspai form a single workspace intelligence platform.
|
|
330
|
+
|
|
331
|
+
RapidKit provides the workspace intelligence engine: model, context, impact, verification, evidence, contracts, and governance.
|
|
332
|
+
|
|
333
|
+
Workspai — Workspace + Intelligence — provides the VS Code surface: dashboard, sidebar, Incident Studio, AI workflows, and developer-facing workspace operations.
|
|
334
|
+
|
|
168
335
|
| Component | Repository | Role |
|
|
169
336
|
| --- | --- | --- |
|
|
170
337
|
| CLI | [rapidkit-npm](https://github.com/rapidkitlabs/rapidkit-npm) | Commands, governance, adoption, CI evidence |
|
|
@@ -173,13 +340,16 @@ Full syntax: [docs/commands-reference.md](docs/commands-reference.md). CI workfl
|
|
|
173
340
|
| Examples | [rapidkit-examples](https://github.com/rapidkitlabs/rapidkit-examples) | Starter workspaces |
|
|
174
341
|
|
|
175
342
|
## VS Code extension
|
|
343
|
+
Workspai is the VS Code experience for RapidKit workspace intelligence.
|
|
176
344
|
|
|
177
|
-
Search **Workspai** in the marketplace or
|
|
345
|
+
Search **Workspai** in the marketplace or install via:
|
|
346
|
+
`ext install rapidkit.rapidkit-vscode`.
|
|
178
347
|
|
|
179
348
|
| Feature | CLI | Extension |
|
|
180
349
|
| --- | --- | --- |
|
|
181
350
|
| Create / adopt / import | Yes | Guided wizards |
|
|
182
351
|
| Workspace model / context | Yes | Dashboard + AI scope |
|
|
352
|
+
| Cross-tool agent grounding | Yes (`workspace agent-sync`) | Send-to-Copilot / Ask Studio UX |
|
|
183
353
|
| Enterprise evidence loop | Partial | Full dashboard |
|
|
184
354
|
| Module catalog (FastAPI/NestJS) | Limited | Browser UI |
|
|
185
355
|
|
|
@@ -198,7 +368,6 @@ The extension invokes this npm CLI. For the latest `adopt` and `create frontend`
|
|
|
198
368
|
| [docs/SETUP.md](docs/SETUP.md) | Maintainer setup |
|
|
199
369
|
| [docs/SECURITY.md](docs/SECURITY.md) | Security policy |
|
|
200
370
|
| [docs/config-file-guide.md](docs/config-file-guide.md) | User configuration |
|
|
201
|
-
| [docs/README.md](docs/README.md) | Full documentation index |
|
|
202
371
|
| [CHANGELOG.md](CHANGELOG.md) | Version history |
|
|
203
372
|
|
|
204
373
|
## Development
|
|
@@ -222,6 +391,8 @@ Contributors: [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md), [docs/ci-workflows.md]
|
|
|
222
391
|
| `npm audit fix --force` downgrades tsup | `package.json` | Do not use `--force`; keep `tsup@^8.5.1` |
|
|
223
392
|
| Security audit fails on esbuild | `npm audit --audit-level=moderate` | Keep `esbuild` override in `package.json` |
|
|
224
393
|
| Doctor output stale | Report timestamps | Re-run `doctor workspace` or `doctor project` |
|
|
394
|
+
| Copilot ignores workspace evidence | Missing grounding files | `workspace agent-sync --write --refresh-context` |
|
|
395
|
+
| Agent grounding strict CI failed | Stale/missing reports | Run governance chain then re-sync |
|
|
225
396
|
| Affected run scope wrong | Git ref | Use `--since <ref>` explicitly |
|
|
226
397
|
|
|
227
398
|
## License
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://getrapidkit.com/schemas/analyze-last-run.v1.json",
|
|
4
|
+
"title": "RapidKit Analyze Last Run Evidence",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": [
|
|
7
|
+
"schemaVersion",
|
|
8
|
+
"generatedAt",
|
|
9
|
+
"workspacePath",
|
|
10
|
+
"workspaceDetected",
|
|
11
|
+
"summary",
|
|
12
|
+
"projects",
|
|
13
|
+
"findings",
|
|
14
|
+
"enterpriseControls"
|
|
15
|
+
],
|
|
16
|
+
"properties": {
|
|
17
|
+
"schemaVersion": {
|
|
18
|
+
"const": "rapidkit-analyze-v1"
|
|
19
|
+
},
|
|
20
|
+
"generatedAt": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"format": "date-time"
|
|
23
|
+
},
|
|
24
|
+
"workspacePath": { "type": "string", "minLength": 1 },
|
|
25
|
+
"workspaceDetected": { "type": "boolean" },
|
|
26
|
+
"profile": { "type": ["string", "null"] },
|
|
27
|
+
"summary": {
|
|
28
|
+
"type": "object",
|
|
29
|
+
"required": ["score", "verdict", "projectCount", "runtimeCount", "findings"],
|
|
30
|
+
"properties": {
|
|
31
|
+
"score": { "type": "number" },
|
|
32
|
+
"verdict": {
|
|
33
|
+
"enum": ["ready", "needs-attention", "blocked"]
|
|
34
|
+
},
|
|
35
|
+
"projectCount": { "type": "integer", "minimum": 0 },
|
|
36
|
+
"runtimeCount": { "type": "integer", "minimum": 0 },
|
|
37
|
+
"findings": {
|
|
38
|
+
"type": "object",
|
|
39
|
+
"required": ["fail", "warn", "info"],
|
|
40
|
+
"properties": {
|
|
41
|
+
"fail": { "type": "integer", "minimum": 0 },
|
|
42
|
+
"warn": { "type": "integer", "minimum": 0 },
|
|
43
|
+
"info": { "type": "integer", "minimum": 0 }
|
|
44
|
+
},
|
|
45
|
+
"additionalProperties": true
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"additionalProperties": true
|
|
49
|
+
},
|
|
50
|
+
"runtimes": {
|
|
51
|
+
"type": "object",
|
|
52
|
+
"additionalProperties": { "type": "integer", "minimum": 0 }
|
|
53
|
+
},
|
|
54
|
+
"projects": {
|
|
55
|
+
"type": "array",
|
|
56
|
+
"items": { "type": "object", "additionalProperties": true }
|
|
57
|
+
},
|
|
58
|
+
"dependencyGraph": {
|
|
59
|
+
"type": "object",
|
|
60
|
+
"properties": {
|
|
61
|
+
"status": { "enum": ["generated", "empty"] },
|
|
62
|
+
"edges": {
|
|
63
|
+
"type": "array",
|
|
64
|
+
"items": { "type": "object", "additionalProperties": true }
|
|
65
|
+
},
|
|
66
|
+
"topImpactedProjects": {
|
|
67
|
+
"type": "array",
|
|
68
|
+
"items": { "type": "object", "additionalProperties": true }
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"additionalProperties": true
|
|
72
|
+
},
|
|
73
|
+
"findings": {
|
|
74
|
+
"type": "array",
|
|
75
|
+
"items": {
|
|
76
|
+
"type": "object",
|
|
77
|
+
"required": ["id", "severity", "title", "detail", "target", "remediation"],
|
|
78
|
+
"properties": {
|
|
79
|
+
"id": { "type": "string" },
|
|
80
|
+
"severity": { "enum": ["info", "warn", "fail"] },
|
|
81
|
+
"title": { "type": "string" },
|
|
82
|
+
"detail": { "type": "string" },
|
|
83
|
+
"target": { "type": "string" },
|
|
84
|
+
"remediation": { "type": "string" }
|
|
85
|
+
},
|
|
86
|
+
"additionalProperties": true
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
"nextActions": {
|
|
90
|
+
"type": "array",
|
|
91
|
+
"items": { "type": "string" }
|
|
92
|
+
},
|
|
93
|
+
"enterpriseControls": {
|
|
94
|
+
"type": "object",
|
|
95
|
+
"required": ["jsonReady", "ciGateCommand", "releaseGateCommand", "evidencePath"],
|
|
96
|
+
"properties": {
|
|
97
|
+
"jsonReady": { "type": "boolean" },
|
|
98
|
+
"ciGateCommand": { "type": "string" },
|
|
99
|
+
"releaseGateCommand": { "type": "string" },
|
|
100
|
+
"evidencePath": { "type": "string" }
|
|
101
|
+
},
|
|
102
|
+
"additionalProperties": true
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"additionalProperties": true
|
|
106
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://getrapidkit.com/schemas/cli-log-event.v1.json",
|
|
4
|
+
"title": "RapidKit CLI Log Event",
|
|
5
|
+
"description": "NDJSON stream events emitted on stderr when RAPIDKIT_LOG_FORMAT=json or --log-format json",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"required": [
|
|
8
|
+
"schemaVersion",
|
|
9
|
+
"runId",
|
|
10
|
+
"timestamp",
|
|
11
|
+
"level",
|
|
12
|
+
"event",
|
|
13
|
+
"component",
|
|
14
|
+
"message"
|
|
15
|
+
],
|
|
16
|
+
"properties": {
|
|
17
|
+
"schemaVersion": {
|
|
18
|
+
"const": "cli-log-event-v1"
|
|
19
|
+
},
|
|
20
|
+
"runId": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"minLength": 8
|
|
23
|
+
},
|
|
24
|
+
"timestamp": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"format": "date-time"
|
|
27
|
+
},
|
|
28
|
+
"level": {
|
|
29
|
+
"enum": ["debug", "info", "warn", "error"]
|
|
30
|
+
},
|
|
31
|
+
"event": {
|
|
32
|
+
"enum": ["log", "progress", "run.started", "run.completed", "run.failed"]
|
|
33
|
+
},
|
|
34
|
+
"component": {
|
|
35
|
+
"type": "string",
|
|
36
|
+
"minLength": 1
|
|
37
|
+
},
|
|
38
|
+
"message": {
|
|
39
|
+
"type": "string"
|
|
40
|
+
},
|
|
41
|
+
"command": {
|
|
42
|
+
"type": "array",
|
|
43
|
+
"items": { "type": "string" }
|
|
44
|
+
},
|
|
45
|
+
"metadata": {
|
|
46
|
+
"type": "object",
|
|
47
|
+
"additionalProperties": true
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"additionalProperties": false
|
|
51
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://getrapidkit.com/schemas/doctor-project-evidence.v1.json",
|
|
4
|
+
"title": "RapidKit Doctor Project Evidence",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": [
|
|
7
|
+
"schemaVersion",
|
|
8
|
+
"evidenceType",
|
|
9
|
+
"generatedAt",
|
|
10
|
+
"projectPath",
|
|
11
|
+
"projectName",
|
|
12
|
+
"summary"
|
|
13
|
+
],
|
|
14
|
+
"properties": {
|
|
15
|
+
"schemaVersion": {
|
|
16
|
+
"const": "doctor-project-evidence-v1"
|
|
17
|
+
},
|
|
18
|
+
"evidenceType": {
|
|
19
|
+
"const": "project"
|
|
20
|
+
},
|
|
21
|
+
"generatedAt": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"format": "date-time"
|
|
24
|
+
},
|
|
25
|
+
"workspacePath": { "type": ["string", "null"] },
|
|
26
|
+
"projectPath": { "type": "string", "minLength": 1 },
|
|
27
|
+
"projectName": { "type": "string", "minLength": 1 },
|
|
28
|
+
"healthScore": { "type": "object", "additionalProperties": true },
|
|
29
|
+
"system": { "type": "object", "additionalProperties": true },
|
|
30
|
+
"project": { "type": "object", "additionalProperties": true },
|
|
31
|
+
"summary": {
|
|
32
|
+
"type": "object",
|
|
33
|
+
"properties": {
|
|
34
|
+
"scopeProvenance": { "type": "object", "additionalProperties": true }
|
|
35
|
+
},
|
|
36
|
+
"additionalProperties": true
|
|
37
|
+
},
|
|
38
|
+
"driftDelta": { "type": "object", "additionalProperties": true },
|
|
39
|
+
"scoreBreakdown": {
|
|
40
|
+
"type": "array",
|
|
41
|
+
"items": { "type": "object", "additionalProperties": true }
|
|
42
|
+
},
|
|
43
|
+
"contract": { "type": "object", "additionalProperties": true }
|
|
44
|
+
},
|
|
45
|
+
"additionalProperties": true
|
|
46
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://getrapidkit.com/schemas/doctor-workspace-evidence.v1.json",
|
|
4
|
+
"title": "RapidKit Doctor Workspace Evidence",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": [
|
|
7
|
+
"schemaVersion",
|
|
8
|
+
"evidenceType",
|
|
9
|
+
"generatedAt",
|
|
10
|
+
"workspacePath",
|
|
11
|
+
"summary",
|
|
12
|
+
"projects"
|
|
13
|
+
],
|
|
14
|
+
"properties": {
|
|
15
|
+
"schemaVersion": {
|
|
16
|
+
"const": "doctor-workspace-evidence-v1"
|
|
17
|
+
},
|
|
18
|
+
"evidenceType": {
|
|
19
|
+
"const": "workspace"
|
|
20
|
+
},
|
|
21
|
+
"generatedAt": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"format": "date-time"
|
|
24
|
+
},
|
|
25
|
+
"workspacePath": { "type": "string", "minLength": 1 },
|
|
26
|
+
"workspaceName": { "type": "string" },
|
|
27
|
+
"projectScanCached": { "type": "boolean" },
|
|
28
|
+
"projectScanSignature": { "type": "string" },
|
|
29
|
+
"cachePath": { "type": ["string", "null"] },
|
|
30
|
+
"healthScore": { "type": "object", "additionalProperties": true },
|
|
31
|
+
"system": { "type": "object", "additionalProperties": true },
|
|
32
|
+
"projects": {
|
|
33
|
+
"type": "array",
|
|
34
|
+
"items": { "type": "object", "additionalProperties": true }
|
|
35
|
+
},
|
|
36
|
+
"summary": {
|
|
37
|
+
"type": "object",
|
|
38
|
+
"required": ["totalProjects", "totalIssues", "hasSystemErrors"],
|
|
39
|
+
"properties": {
|
|
40
|
+
"totalProjects": { "type": "integer", "minimum": 0 },
|
|
41
|
+
"totalIssues": { "type": "integer", "minimum": 0 },
|
|
42
|
+
"projectAdvisoryWarningProjects": { "type": "integer", "minimum": 0 },
|
|
43
|
+
"projectAdvisoryWarnings": { "type": "integer", "minimum": 0 },
|
|
44
|
+
"hasSystemErrors": { "type": "boolean" },
|
|
45
|
+
"scopeProvenance": { "type": "object", "additionalProperties": true }
|
|
46
|
+
},
|
|
47
|
+
"additionalProperties": true
|
|
48
|
+
},
|
|
49
|
+
"driftDelta": { "type": "object", "additionalProperties": true },
|
|
50
|
+
"scoreBreakdown": {
|
|
51
|
+
"type": "array",
|
|
52
|
+
"items": { "type": "object", "additionalProperties": true }
|
|
53
|
+
},
|
|
54
|
+
"contract": { "type": "object", "additionalProperties": true }
|
|
55
|
+
},
|
|
56
|
+
"additionalProperties": true
|
|
57
|
+
}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://getrapidkit.com/schemas/release-readiness.v1.json",
|
|
4
|
+
"title": "RapidKit Release Readiness Evidence",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": [
|
|
7
|
+
"schemaVersion",
|
|
8
|
+
"generatedAt",
|
|
9
|
+
"workspacePath",
|
|
10
|
+
"projectPath",
|
|
11
|
+
"overallStatus",
|
|
12
|
+
"blocking",
|
|
13
|
+
"blockingReasons",
|
|
14
|
+
"gates"
|
|
15
|
+
],
|
|
16
|
+
"properties": {
|
|
17
|
+
"schemaVersion": {
|
|
18
|
+
"enum": ["release-readiness-v1", "v1"]
|
|
19
|
+
},
|
|
20
|
+
"generatedAt": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"format": "date-time"
|
|
23
|
+
},
|
|
24
|
+
"workspacePath": { "type": "string", "minLength": 1 },
|
|
25
|
+
"projectPath": { "type": "string", "minLength": 1 },
|
|
26
|
+
"action": {
|
|
27
|
+
"enum": ["dev", "test", "build", "start", "lint", "format"]
|
|
28
|
+
},
|
|
29
|
+
"overallStatus": {
|
|
30
|
+
"enum": ["pass", "warn", "fail"]
|
|
31
|
+
},
|
|
32
|
+
"blocking": { "type": "boolean" },
|
|
33
|
+
"blockingReasons": {
|
|
34
|
+
"type": "array",
|
|
35
|
+
"items": { "type": "string" }
|
|
36
|
+
},
|
|
37
|
+
"gates": {
|
|
38
|
+
"type": "array",
|
|
39
|
+
"items": {
|
|
40
|
+
"type": "object",
|
|
41
|
+
"required": ["gate", "status", "summary", "details"],
|
|
42
|
+
"properties": {
|
|
43
|
+
"gate": {
|
|
44
|
+
"enum": ["env", "doctor", "analyze", "verify", "dependency"]
|
|
45
|
+
},
|
|
46
|
+
"status": { "enum": ["pass", "warn", "fail"] },
|
|
47
|
+
"summary": { "type": "string" },
|
|
48
|
+
"details": {
|
|
49
|
+
"type": "array",
|
|
50
|
+
"items": { "type": "string" }
|
|
51
|
+
},
|
|
52
|
+
"evidencePath": { "type": "string" }
|
|
53
|
+
},
|
|
54
|
+
"additionalProperties": true
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"evidencePath": { "type": "string" }
|
|
58
|
+
},
|
|
59
|
+
"additionalProperties": true
|
|
60
|
+
}
|