rapidkit 0.35.0 → 0.37.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 +216 -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-AUXP2ZIF.js +1 -0
- package/dist/chunk-6P5DCHBQ.js +4 -0
- package/dist/chunk-7VSYTOOG.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-D23L2GFT.js +2 -0
- package/dist/{workspace-context-YFQQROOZ.js → chunk-EJGKBFV4.js} +2 -2
- package/dist/chunk-FV5A3N3I.js +2 -0
- package/dist/chunk-GDGATWR5.js +2 -0
- package/dist/chunk-HEG6DIGW.js +2 -0
- package/dist/{chunk-752X3YI3.js → chunk-IOIWVHRO.js} +81 -81
- 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-FNL34DKD.js → chunk-RUUDLAKJ.js} +12 -12
- package/dist/chunk-T5LN7EO5.js +9 -0
- package/dist/chunk-U6QUN6V2.js +2 -0
- package/dist/chunk-UXKB4KGZ.js +13 -0
- package/dist/create-HN5HOGQ4.js +1 -0
- 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-BOU4KETN.js +5 -0
- package/dist/{springboot-standard-WQWB5E24.js → springboot-standard-SFMSLTX4.js} +1 -1
- package/dist/{workspace-ZXWYIZOR.js → workspace-2AL5C3QZ.js} +1 -1
- package/dist/workspace-agent-sync-V2H6NTGD.js +17 -0
- package/dist/workspace-context-KCKNV5VQ.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-NXIO55GJ.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-DEXI52KO.js +1 -0
- package/dist/workspace-verify-HBCQNNGU.js +1 -0
- package/package.json +2 -1
- package/dist/analyze-IIPDLLM2.js +0 -1
- package/dist/autopilot-release-EO7GQS4P.js +0 -1
- package/dist/chunk-5LLGW5TP.js +0 -9
- package/dist/chunk-B7NCBH5B.js +0 -2
- package/dist/chunk-DKVWFHZO.js +0 -4
- package/dist/chunk-IATULVMR.js +0 -11
- package/dist/chunk-KDUAZXEQ.js +0 -3
- package/dist/chunk-MCLLP6MW.js +0 -2
- package/dist/chunk-R4RPUW7I.js +0 -7
- package/dist/chunk-TC2PSHT6.js +0 -50
- package/dist/chunk-VM2TOHNX.js +0 -2
- package/dist/create-LUXJGSNL.js +0 -1
- package/dist/pipeline-7OTUIB6D.js +0 -5
- package/dist/workspace-foundation-TYLH5SAU.js +0 -1
- package/dist/workspace-run-AZ63D75J.js +0 -1
- package/dist/workspace-verify-K56NI3AI.js +0 -1
package/README.md
CHANGED
|
@@ -1,24 +1,141 @@
|
|
|
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, and AI agents share the same understanding of the workspace.
|
|
7
|
+
|
|
8
|
+
RapidKit is an open-source workspace platform that turns scattered projects into a governed, agent-ready workspace.
|
|
9
|
+
|
|
10
|
+
Build, adopt, and operate polyglot software systems with a shared understanding for developers, CI pipelines, and AI agents.
|
|
11
|
+
|
|
12
|
+
Instead of every tool rebuilding its own understanding of your system, RapidKit provides a shared source of truth.
|
|
13
|
+
|
|
14
|
+
## Quick start in 5 minutes
|
|
15
|
+
|
|
16
|
+
### Install the CLI
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install -g rapidkit
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Create a new workspace and project
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx rapidkit create workspace platform --yes --profile polyglot
|
|
26
|
+
|
|
27
|
+
cd platform
|
|
28
|
+
|
|
29
|
+
npx rapidkit bootstrap --profile polyglot
|
|
30
|
+
|
|
31
|
+
npx rapidkit create project
|
|
32
|
+
npx rapidkit create frontend nextjs my-web --yes
|
|
33
|
+
|
|
34
|
+
npx rapidkit workspace model
|
|
35
|
+
npx rapidkit workspace context --for-agent --write
|
|
36
|
+
npx rapidkit pipeline --strict
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Adopt an existing project
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx rapidkit adopt /path/to/project --workspace /path/to/workspace
|
|
43
|
+
|
|
44
|
+
npx rapidkit workspace model
|
|
45
|
+
npx rapidkit workspace context --for-agent --write
|
|
46
|
+
npx rapidkit pipeline --strict
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### What RapidKit gives you
|
|
50
|
+
|
|
51
|
+
* Adopt existing projects without migration
|
|
52
|
+
* Create and manage polyglot workspaces
|
|
53
|
+
* Generate agent-ready context and workspace models
|
|
54
|
+
* Analyze impact before changes ship
|
|
55
|
+
* Verify release readiness with evidence-backed gates
|
|
56
|
+
* Keep developers, CI, and AI agents aligned
|
|
57
|
+
|
|
58
|
+
### Workspace Intelligence
|
|
59
|
+
|
|
60
|
+
Most AI tools understand:
|
|
61
|
+
|
|
62
|
+
* Files
|
|
63
|
+
* Functions
|
|
64
|
+
* Repositories
|
|
65
|
+
|
|
66
|
+
Production systems require understanding:
|
|
67
|
+
|
|
68
|
+
* Ownership
|
|
69
|
+
* Architecture
|
|
70
|
+
* Dependencies
|
|
71
|
+
* Operational context
|
|
72
|
+
* Verification requirements
|
|
73
|
+
* Change impact
|
|
74
|
+
|
|
75
|
+
RapidKit adds the missing layer:
|
|
76
|
+
|
|
77
|
+
**Workspace Intelligence.**
|
|
78
|
+
|
|
79
|
+
**One workspace. One truth.**
|
|
80
|
+
|
|
81
|
+
A shared understanding of software systems for developers, CI pipelines, IDEs, and AI agents.
|
|
82
|
+
|
|
83
|
+
### From Code to Shared Understanding
|
|
84
|
+
How RapidKit transforms projects and repositories into workspace intelligence for developers, CI, and AI agents.
|
|
85
|
+
|
|
86
|
+
```mermaid
|
|
87
|
+
flowchart TB
|
|
88
|
+
|
|
89
|
+
Code["Code & Repositories"]
|
|
90
|
+
Projects["Projects"]
|
|
91
|
+
Workspace["Workspace"]
|
|
92
|
+
|
|
93
|
+
Code --> Projects
|
|
94
|
+
Projects --> Workspace
|
|
95
|
+
|
|
96
|
+
subgraph Intelligence["Workspace Intelligence"]
|
|
97
|
+
Model["Workspace Model"]
|
|
98
|
+
Context["Agent Context"]
|
|
99
|
+
Impact["Impact Analysis"]
|
|
100
|
+
Verify["Verification"]
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
Workspace --> Model
|
|
104
|
+
Workspace --> Context
|
|
105
|
+
Workspace --> Impact
|
|
106
|
+
Workspace --> Verify
|
|
107
|
+
|
|
108
|
+
Model --> Dev["Developers"]
|
|
109
|
+
Model --> CI["CI"]
|
|
110
|
+
Model --> Agents["AI Agents"]
|
|
111
|
+
|
|
112
|
+
Context --> Agents
|
|
113
|
+
|
|
114
|
+
Impact --> Dev
|
|
115
|
+
Impact --> CI
|
|
116
|
+
|
|
117
|
+
Verify --> CI
|
|
118
|
+
Verify --> Agents
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
RapidKit provides the workspace engine, governance model, evidence chain, and operational intelligence.
|
|
122
|
+
|
|
123
|
+
Workspai provides the VS Code experience on top of that foundation.
|
|
124
|
+
|
|
125
|
+
For the visual experience, install the [Workspai VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode).
|
|
6
126
|
|
|
7
127
|
[](https://www.npmjs.com/package/rapidkit)
|
|
8
128
|
[](https://www.npmjs.com/package/rapidkit)
|
|
9
129
|
[](https://opensource.org/licenses/MIT)
|
|
10
|
-
[](https://github.com/rapidkitlabs/rapidkit-npm/stargazers)
|
|
11
130
|
[](https://www.getrapidkit.com)
|
|
12
131
|
|
|
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
132
|
## Table of contents
|
|
16
133
|
|
|
17
|
-
- [
|
|
134
|
+
- [Typical workflows](#typical-workflows)
|
|
18
135
|
- [Mental model](#mental-model)
|
|
19
|
-
- [Workspace
|
|
136
|
+
- [Workspace Intelligence Commands](#workspace-intelligence-commands)
|
|
20
137
|
- [Requirements & install](#requirements)
|
|
21
|
-
- [
|
|
138
|
+
- [Project workflows](#project-workflows)
|
|
22
139
|
- [CI & evidence](#ci--evidence)
|
|
23
140
|
- [Workspai ecosystem](#workspai-ecosystem)
|
|
24
141
|
- [VS Code extension](#vs-code-extension)
|
|
@@ -27,15 +144,39 @@ For the visual experience, install the [Workspai VS Code extension](https://mark
|
|
|
27
144
|
- [Troubleshooting](#troubleshooting)
|
|
28
145
|
- [License](#license)
|
|
29
146
|
|
|
30
|
-
##
|
|
147
|
+
## Typical workflows
|
|
148
|
+
|
|
149
|
+
| Question | Command |
|
|
150
|
+
| --------------------------------------------- | ---------------------------------------------- |
|
|
151
|
+
| What projects exist in this workspace? | `workspace model --json` |
|
|
152
|
+
| What context should AI agents receive? | `workspace context --for-agent --json --write` |
|
|
153
|
+
| What breaks if I change this? | `workspace impact --from <snapshot>` |
|
|
154
|
+
| Can I safely release? | `pipeline --json --strict` |
|
|
155
|
+
| How do I align AI tools and CI? | `workspace agent-sync --write` |
|
|
156
|
+
| How do I onboard an existing project? | `adopt` |
|
|
157
|
+
| How do I bring repositories into a workspace? | `import` |
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### Existing project
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
npx rapidkit adopt /path/to/project --workspace /path/to/workspace
|
|
164
|
+
npx rapidkit workspace model --json
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Agent-ready workspace
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
npx rapidkit workspace context --for-agent --json --write
|
|
171
|
+
npx rapidkit workspace agent-sync --write --refresh-context
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Release verification
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
npx rapidkit pipeline --json --strict
|
|
178
|
+
```
|
|
31
179
|
|
|
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
180
|
|
|
40
181
|
### Adopt in place
|
|
41
182
|
|
|
@@ -55,6 +196,9 @@ npx rapidkit adopt --json # from inside the project folder
|
|
|
55
196
|
|
|
56
197
|
New workspaces go under `~/rapidkit/workspaces/<name>`. Legacy `~/Workspai/rapidkits/*` paths remain registered. Use `--output <parent-dir>` for a custom parent.
|
|
57
198
|
|
|
199
|
+
|
|
200
|
+
## Mental model
|
|
201
|
+
|
|
58
202
|
### Two-layer model
|
|
59
203
|
|
|
60
204
|
```text
|
|
@@ -62,8 +206,6 @@ First-class engine kits → FastAPI and NestJS (modules + deep generation)
|
|
|
62
206
|
Workspace intelligence → frontend apps, Go, Spring, .NET, adopted/imported repos
|
|
63
207
|
```
|
|
64
208
|
|
|
65
|
-
## Mental model
|
|
66
|
-
|
|
67
209
|
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
210
|
|
|
69
211
|
```text
|
|
@@ -79,12 +221,14 @@ external-project/
|
|
|
79
221
|
|
|
80
222
|
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
223
|
|
|
82
|
-
## Workspace
|
|
224
|
+
## Workspace Intelligence Commands
|
|
225
|
+
Workspace Intelligence provides a shared understanding of projects, dependencies, operational context, and release readiness for developers, CI pipelines, and AI agents.
|
|
83
226
|
|
|
84
227
|
| Command | Purpose |
|
|
85
228
|
| --- | --- |
|
|
86
229
|
| `workspace model --json` | Canonical workspace model |
|
|
87
|
-
| `workspace context --for-agent --json` | Agent-ready context pack |
|
|
230
|
+
| `workspace context --for-agent --json --write` | Agent-ready context pack + auto agent grounding sync |
|
|
231
|
+
| `workspace agent-sync --write` | Cross-tool grounding (AGENTS.md, Copilot, Cursor, Claude, INDEX) |
|
|
88
232
|
| `workspace snapshot --json` | Persist model snapshot |
|
|
89
233
|
| `workspace diff --from <file\|git[:ref]> --json` | Diff against snapshot or git |
|
|
90
234
|
| `workspace impact --from <file> --json` | Blast-radius evidence |
|
|
@@ -92,6 +236,43 @@ Every tool gets the same answers: what projects exist, what stack they use, whic
|
|
|
92
236
|
|
|
93
237
|
JSON schemas: `contracts/workspace-intelligence/`. Details: [commands-reference.md](docs/commands-reference.md).
|
|
94
238
|
|
|
239
|
+
### Agent grounding (CLI-only, no extension required)
|
|
240
|
+
|
|
241
|
+
RapidKit can sync **cross-tool instruction files** so Copilot, Cursor, Claude Code, Codex, Grok, and other agents read the same evidence before guessing:
|
|
242
|
+
|
|
243
|
+
```bash
|
|
244
|
+
# Full sync: refresh context pack + INDEX + AGENTS.md + Copilot/Cursor/Claude hooks
|
|
245
|
+
npx rapidkit workspace agent-sync --write --refresh-context
|
|
246
|
+
|
|
247
|
+
# Context pack write also syncs grounding by default
|
|
248
|
+
npx rapidkit workspace context --for-agent --json --write
|
|
249
|
+
|
|
250
|
+
# CI strict gate (fail if required reports missing/stale)
|
|
251
|
+
npx rapidkit workspace agent-sync --write --strict --json
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
| Artifact / file | Purpose |
|
|
255
|
+
| --- | --- |
|
|
256
|
+
| `.rapidkit/reports/INDEX.json` | Read order, blockers, report timestamps |
|
|
257
|
+
| `.rapidkit/reports/workspace-context-agent.json` | Canonical agent context pack |
|
|
258
|
+
| `.rapidkit/AGENT-GROUNDING.md` | Tool-agnostic grounding doc |
|
|
259
|
+
| `AGENTS.md` | Open standard for all agents (managed RapidKit section) |
|
|
260
|
+
| `.github/copilot-instructions.md` | GitHub Copilot / VS Code Chat always-on rules |
|
|
261
|
+
| `.github/instructions/rapidkit-evidence.instructions.md` | Copilot scoped rules for `.rapidkit/**` |
|
|
262
|
+
| `.github/prompts/rapidkit-diagnose.prompt.md` | Copilot reusable diagnose prompt |
|
|
263
|
+
| `.github/skills/rapidkit-grounding/SKILL.md` | Copilot agent skill workflow |
|
|
264
|
+
| `.cursor/rules/rapidkit-grounding.mdc` | Cursor always-on project rule |
|
|
265
|
+
| `CLAUDE.md` | Claude Code entry (`@AGENTS.md` + managed notes) |
|
|
266
|
+
| `.claude/rules/rapidkit-evidence.md` | Claude Code scoped evidence rules |
|
|
267
|
+
|
|
268
|
+
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.
|
|
269
|
+
|
|
270
|
+
Skip auto-sync after context write: `--no-agent-sync`. Target specific ecosystems: `--target copilot,cursor,claude`.
|
|
271
|
+
|
|
272
|
+
After `pipeline`, grounding syncs automatically (refresh context + INDEX + hooks). Disable with `--no-agent-sync` or `RAPIDKIT_NO_AGENT_SYNC=1`.
|
|
273
|
+
|
|
274
|
+
CI template: [docs/examples/ci-agent-grounding.yml](docs/examples/ci-agent-grounding.yml).
|
|
275
|
+
|
|
95
276
|
## Requirements
|
|
96
277
|
|
|
97
278
|
- Node.js `>= 20.19.6`
|
|
@@ -106,7 +287,7 @@ npm install -g rapidkit
|
|
|
106
287
|
npx rapidkit --help
|
|
107
288
|
```
|
|
108
289
|
|
|
109
|
-
##
|
|
290
|
+
## Project workflows
|
|
110
291
|
|
|
111
292
|
### I already have a project
|
|
112
293
|
|
|
@@ -155,6 +336,7 @@ Common workspace commands:
|
|
|
155
336
|
|
|
156
337
|
```bash
|
|
157
338
|
npx rapidkit doctor workspace
|
|
339
|
+
npx rapidkit workspace agent-sync --write --refresh-context
|
|
158
340
|
npx rapidkit setup <python|node|go|java|dotnet> [--warm-deps]
|
|
159
341
|
npx rapidkit workspace list
|
|
160
342
|
npx rapidkit cache <status|clear|prune|repair>
|
|
@@ -165,6 +347,12 @@ Full syntax: [docs/commands-reference.md](docs/commands-reference.md). CI workfl
|
|
|
165
347
|
|
|
166
348
|
## Workspai ecosystem
|
|
167
349
|
|
|
350
|
+
RapidKit and Workspai form a single workspace intelligence platform.
|
|
351
|
+
|
|
352
|
+
RapidKit provides the workspace engine, governance model, evidence chain, and operational intelligence.
|
|
353
|
+
|
|
354
|
+
Workspai provides the VS Code experience, dashboards, AI workflows, and developer-facing workspace operations.
|
|
355
|
+
|
|
168
356
|
| Component | Repository | Role |
|
|
169
357
|
| --- | --- | --- |
|
|
170
358
|
| CLI | [rapidkit-npm](https://github.com/rapidkitlabs/rapidkit-npm) | Commands, governance, adoption, CI evidence |
|
|
@@ -173,13 +361,16 @@ Full syntax: [docs/commands-reference.md](docs/commands-reference.md). CI workfl
|
|
|
173
361
|
| Examples | [rapidkit-examples](https://github.com/rapidkitlabs/rapidkit-examples) | Starter workspaces |
|
|
174
362
|
|
|
175
363
|
## VS Code extension
|
|
364
|
+
Workspai is the VS Code experience for RapidKit workspace intelligence.
|
|
176
365
|
|
|
177
|
-
Search **Workspai** in the marketplace or
|
|
366
|
+
Search **Workspai** in the marketplace or install via:
|
|
367
|
+
`ext install rapidkit.rapidkit-vscode`.
|
|
178
368
|
|
|
179
369
|
| Feature | CLI | Extension |
|
|
180
370
|
| --- | --- | --- |
|
|
181
371
|
| Create / adopt / import | Yes | Guided wizards |
|
|
182
372
|
| Workspace model / context | Yes | Dashboard + AI scope |
|
|
373
|
+
| Cross-tool agent grounding | Yes (`workspace agent-sync`) | Send-to-Copilot / Ask Studio UX |
|
|
183
374
|
| Enterprise evidence loop | Partial | Full dashboard |
|
|
184
375
|
| Module catalog (FastAPI/NestJS) | Limited | Browser UI |
|
|
185
376
|
|
|
@@ -198,7 +389,6 @@ The extension invokes this npm CLI. For the latest `adopt` and `create frontend`
|
|
|
198
389
|
| [docs/SETUP.md](docs/SETUP.md) | Maintainer setup |
|
|
199
390
|
| [docs/SECURITY.md](docs/SECURITY.md) | Security policy |
|
|
200
391
|
| [docs/config-file-guide.md](docs/config-file-guide.md) | User configuration |
|
|
201
|
-
| [docs/README.md](docs/README.md) | Full documentation index |
|
|
202
392
|
| [CHANGELOG.md](CHANGELOG.md) | Version history |
|
|
203
393
|
|
|
204
394
|
## Development
|
|
@@ -222,6 +412,8 @@ Contributors: [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md), [docs/ci-workflows.md]
|
|
|
222
412
|
| `npm audit fix --force` downgrades tsup | `package.json` | Do not use `--force`; keep `tsup@^8.5.1` |
|
|
223
413
|
| Security audit fails on esbuild | `npm audit --audit-level=moderate` | Keep `esbuild` override in `package.json` |
|
|
224
414
|
| Doctor output stale | Report timestamps | Re-run `doctor workspace` or `doctor project` |
|
|
415
|
+
| Copilot ignores workspace evidence | Missing grounding files | `workspace agent-sync --write --refresh-context` |
|
|
416
|
+
| Agent grounding strict CI failed | Stale/missing reports | Run governance chain then re-sync |
|
|
225
417
|
| Affected run scope wrong | Git ref | Use `--since <ref>` explicitly |
|
|
226
418
|
|
|
227
419
|
## 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
|
+
}
|