rapidkit 0.37.1 → 0.38.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 +158 -118
- package/contracts/create-planner-capabilities.v1.json +251 -0
- package/contracts/runtime-command-surface.v1.json +52 -0
- package/dist/autopilot-release-SBPGNGAB.js +1 -0
- package/dist/chunk-2ED6SPXP.js +1 -0
- package/dist/chunk-3R7UJAX5.js +1 -0
- package/dist/{chunk-RUUDLAKJ.js → chunk-5NBYSXOZ.js} +1 -1
- package/dist/chunk-7XW2I6MP.js +13 -0
- package/dist/{chunk-U6QUN6V2.js → chunk-ABPDGFVD.js} +1 -1
- package/dist/chunk-IW3KLQXE.js +2 -0
- package/dist/{chunk-7RBZGQ7T.js → chunk-NKNMGWAZ.js} +1 -1
- package/dist/{chunk-IOIWVHRO.js → chunk-TVIOAZ6E.js} +13 -13
- package/dist/chunk-XESEBTPE.js +1 -0
- package/dist/{create-HN5HOGQ4.js → create-Y3XJOKL5.js} +1 -1
- package/dist/index.js +150 -144
- package/dist/{pipeline-IMB3C3JY.js → pipeline-C4UCLETO.js} +1 -1
- package/dist/{workspace-2AL5C3QZ.js → workspace-WBKFXH4Z.js} +1 -1
- package/dist/{workspace-agent-sync-4R7S3F6T.js → workspace-agent-sync-3FFFJYKF.js} +1 -1
- package/dist/{workspace-context-CKACDTVE.js → workspace-context-V4UGIHSC.js} +1 -1
- package/dist/{workspace-foundation-L6ZBGMVE.js → workspace-foundation-T45HAWKL.js} +1 -1
- package/dist/{workspace-intelligence-3TWXJQ7Y.js → workspace-intelligence-MGL3Z25K.js} +1 -1
- package/dist/{workspace-model-NQVZN5W4.js → workspace-model-IKMGY2BX.js} +1 -1
- package/dist/workspace-run-HOR56FON.js +1 -0
- package/dist/{workspace-verify-EO435PS4.js → workspace-verify-A3J6D7T2.js} +1 -1
- package/docs/README.md +1 -0
- package/docs/contracts/ARTIFACT_CATALOG.md +63 -56
- package/docs/contracts/README.md +15 -14
- package/docs/create-planner-capabilities.md +81 -0
- package/package.json +1 -1
- package/dist/autopilot-release-QNZ2IL7K.js +0 -1
- package/dist/chunk-3SWQKRXH.js +0 -2
- package/dist/chunk-C7OVQQXT.js +0 -1
- package/dist/chunk-UXKB4KGZ.js +0 -13
- package/dist/chunk-YJ24EV3P.js +0 -1
- package/dist/workspace-run-PNMZJNDC.js +0 -1
- /package/dist/{chunk-TRXYRHD7.js → chunk-6E5TBB2C.js} +0 -0
package/README.md
CHANGED
|
@@ -2,77 +2,112 @@
|
|
|
2
2
|
|
|
3
3
|
### Open-Source Workspace Intelligence for Software Systems
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
[](https://www.npmjs.com/package/rapidkit)
|
|
6
|
+
[](https://www.npmjs.com/package/rapidkit)
|
|
7
|
+
[](https://opensource.org/licenses/MIT)
|
|
8
|
+
[](https://www.getrapidkit.com)
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
> One workspace. One truth. Humans and AI aligned.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
RapidKit turns scattered projects into a governed, agent-ready workspace.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
It gives developers, CI, IDEs, and AI agents the same evidence-backed source of
|
|
15
|
+
truth: workspace model, agent context, impact analysis, verification evidence,
|
|
16
|
+
contracts, and release gates.
|
|
15
17
|
|
|
16
|
-
##
|
|
18
|
+
## Start here
|
|
17
19
|
|
|
18
|
-
### Install
|
|
20
|
+
### Install
|
|
19
21
|
|
|
20
22
|
```bash
|
|
21
23
|
npm install -g rapidkit
|
|
22
24
|
```
|
|
23
25
|
|
|
24
|
-
|
|
26
|
+
or run without installing:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx rapidkit --help
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Create a governed workspace
|
|
25
33
|
|
|
26
34
|
```bash
|
|
27
|
-
|
|
35
|
+
mkdir -p ~/rapidkit/workspaces
|
|
36
|
+
cd ~/rapidkit/workspaces
|
|
28
37
|
|
|
38
|
+
npx rapidkit create workspace platform --yes --profile polyglot --output .
|
|
29
39
|
cd platform
|
|
30
40
|
|
|
31
41
|
npx rapidkit bootstrap --profile polyglot
|
|
32
|
-
|
|
33
42
|
npx rapidkit create project
|
|
34
43
|
npx rapidkit create frontend nextjs my-web --yes
|
|
35
44
|
|
|
36
|
-
npx rapidkit workspace model
|
|
37
|
-
npx rapidkit workspace context --for-agent --write
|
|
38
|
-
npx rapidkit pipeline --strict
|
|
45
|
+
npx rapidkit workspace model --json
|
|
46
|
+
npx rapidkit workspace context --for-agent --json --write
|
|
47
|
+
npx rapidkit pipeline --json --strict
|
|
39
48
|
```
|
|
40
49
|
|
|
41
50
|
### Adopt an existing project
|
|
42
51
|
|
|
43
52
|
```bash
|
|
44
|
-
|
|
53
|
+
mkdir -p ~/rapidkit/workspaces
|
|
54
|
+
cd ~/rapidkit/workspaces
|
|
45
55
|
|
|
46
|
-
npx rapidkit workspace
|
|
47
|
-
npx rapidkit
|
|
48
|
-
|
|
56
|
+
npx rapidkit create workspace platform --yes --profile polyglot --output .
|
|
57
|
+
npx rapidkit adopt /path/to/project --workspace ~/rapidkit/workspaces/platform
|
|
58
|
+
|
|
59
|
+
cd ~/rapidkit/workspaces/platform
|
|
60
|
+
npx rapidkit workspace model --json
|
|
61
|
+
npx rapidkit workspace context --for-agent --json --write
|
|
62
|
+
npx rapidkit pipeline --json --strict
|
|
49
63
|
```
|
|
50
64
|
|
|
51
|
-
### What
|
|
65
|
+
### What you get
|
|
66
|
+
|
|
67
|
+
- A governed workspace boundary for projects, policies, reports, and contracts
|
|
68
|
+
- Native create for RapidKit-owned backend and frontend kits
|
|
69
|
+
- Adopt/import for existing repositories without moving source code
|
|
70
|
+
- Agent-ready context packs for Copilot, Cursor, Claude, Codex, and other tools
|
|
71
|
+
- Impact analysis and release gates backed by workspace evidence
|
|
72
|
+
- One shared truth for developers, CI, IDEs, and AI agents
|
|
52
73
|
|
|
53
|
-
|
|
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
|
|
74
|
+
## Create planner
|
|
59
75
|
|
|
60
|
-
|
|
76
|
+
RapidKit does not pretend every technology is a native scaffold. It uses a
|
|
77
|
+
create planner contract to choose the safest path:
|
|
78
|
+
|
|
79
|
+
| Lane | Use when | Result |
|
|
80
|
+
| ----------------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
81
|
+
| `native-create` | RapidKit owns the scaffold contract | Create the project with a first-class kit |
|
|
82
|
+
| `external-create-adopt` | The ecosystem has an official generator, but RapidKit does not own the post-create contract yet | Use the ecosystem generator, then adopt into Workspace Intelligence |
|
|
83
|
+
| `adopt-only` | The project already exists or native create is not supported | Register, model, verify, and govern the project without scaffolding it |
|
|
84
|
+
|
|
85
|
+
Native create includes FastAPI, NestJS, Go, Spring Boot, .NET, and official
|
|
86
|
+
frontend generators such as Next.js, Vite, Nuxt, Angular, Astro, Remix, and
|
|
87
|
+
SvelteKit.
|
|
88
|
+
|
|
89
|
+
External ecosystems such as WordPress, Laravel, Symfony, Rails, and generic PHP
|
|
90
|
+
projects can still enter RapidKit through adopt/import and receive workspace
|
|
91
|
+
model, context, impact, doctor, and release governance.
|
|
92
|
+
|
|
93
|
+
Details: [docs/create-planner-capabilities.md](docs/create-planner-capabilities.md).
|
|
94
|
+
|
|
95
|
+
## Workspace Intelligence
|
|
61
96
|
|
|
62
97
|
Most AI tools understand:
|
|
63
98
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
99
|
+
- Files
|
|
100
|
+
- Functions
|
|
101
|
+
- Repositories
|
|
67
102
|
|
|
68
103
|
Production systems require understanding:
|
|
69
104
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
105
|
+
- Ownership
|
|
106
|
+
- Architecture
|
|
107
|
+
- Dependencies
|
|
108
|
+
- Operational context
|
|
109
|
+
- Verification requirements
|
|
110
|
+
- Change impact
|
|
76
111
|
|
|
77
112
|
RapidKit adds the missing layer:
|
|
78
113
|
|
|
@@ -84,13 +119,14 @@ A shared, evidence-backed understanding of software systems for developers, CI p
|
|
|
84
119
|
|
|
85
120
|
In RapidKit, Workspace Intelligence is not a chat feature. It is the deterministic workspace layer behind the CLI:
|
|
86
121
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
122
|
+
- **Model** — what projects, runtimes, frameworks, commands, policies, contracts, and evidence exist
|
|
123
|
+
- **Context** — what AI agents and IDEs should know before giving advice
|
|
124
|
+
- **Impact** — what changed and which projects, commands, and release gates are affected
|
|
125
|
+
- **Verify** — which evidence proves the workspace is ready, blocked, or needs attention
|
|
126
|
+
- **Sync** — how developers, CI, Workspai, and AI agents stay grounded in the same truth
|
|
127
|
+
|
|
128
|
+
## From Code to Shared Understanding
|
|
92
129
|
|
|
93
|
-
### From Code to Shared Understanding
|
|
94
130
|
How RapidKit transforms projects and repositories into workspace intelligence for developers, CI, and AI agents.
|
|
95
131
|
|
|
96
132
|
|
|
@@ -101,19 +137,19 @@ RapidKit provides the workspace intelligence engine: model, context, impact, ver
|
|
|
101
137
|
|
|
102
138
|
Workspai provides the VS Code experience on top of that foundation.
|
|
103
139
|
|
|
104
|
-
For the visual experience, install the [Workspai VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode).
|
|
105
|
-
|
|
106
|
-
[](https://www.npmjs.com/package/rapidkit)
|
|
107
|
-
[](https://www.npmjs.com/package/rapidkit)
|
|
108
|
-
[](https://opensource.org/licenses/MIT)
|
|
109
|
-
[](https://www.getrapidkit.com)
|
|
140
|
+
For the visual experience, install the [Workspai VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode).
|
|
110
141
|
|
|
111
142
|
## Table of contents
|
|
112
143
|
|
|
144
|
+
- [Start here](#start-here)
|
|
145
|
+
- [Create planner](#create-planner)
|
|
146
|
+
- [Workspace Intelligence](#workspace-intelligence)
|
|
147
|
+
- [From Code to Shared Understanding](#from-code-to-shared-understanding)
|
|
113
148
|
- [Typical workflows](#typical-workflows)
|
|
114
149
|
- [Mental model](#mental-model)
|
|
115
150
|
- [Workspace Intelligence Commands](#workspace-intelligence-commands)
|
|
116
|
-
- [Requirements
|
|
151
|
+
- [Requirements](#requirements)
|
|
152
|
+
- [Install](#install)
|
|
117
153
|
- [Project workflows](#project-workflows)
|
|
118
154
|
- [CI & evidence](#ci--evidence)
|
|
119
155
|
- [Workspai ecosystem](#workspai-ecosystem)
|
|
@@ -135,7 +171,6 @@ For the visual experience, install the [Workspai VS Code extension](https://mark
|
|
|
135
171
|
| How do I onboard an existing project? | `adopt` |
|
|
136
172
|
| How do I bring repositories into a workspace? | `import` |
|
|
137
173
|
|
|
138
|
-
|
|
139
174
|
### Existing project
|
|
140
175
|
|
|
141
176
|
```bash
|
|
@@ -156,7 +191,6 @@ npx rapidkit workspace agent-sync --write --refresh-context
|
|
|
156
191
|
npx rapidkit pipeline --json --strict
|
|
157
192
|
```
|
|
158
193
|
|
|
159
|
-
|
|
160
194
|
### Adopt in place
|
|
161
195
|
|
|
162
196
|
```bash
|
|
@@ -169,13 +203,12 @@ npx rapidkit adopt --json # from inside the project folder
|
|
|
169
203
|
```text
|
|
170
204
|
~/.rapidkit/workspaces.json
|
|
171
205
|
~/rapidkit/workspaces/
|
|
172
|
-
workspai/ # managed default (import
|
|
206
|
+
workspai/ # managed default (standalone, import, and adopt fallback)
|
|
173
207
|
my-workspace/ # user-created workspaces
|
|
174
208
|
```
|
|
175
209
|
|
|
176
210
|
New workspaces go under `~/rapidkit/workspaces/<name>`. Legacy `~/Workspai/rapidkits/*` paths remain registered. Use `--output <parent-dir>` for a custom parent.
|
|
177
211
|
|
|
178
|
-
|
|
179
212
|
## Mental model
|
|
180
213
|
|
|
181
214
|
### Two-layer model
|
|
@@ -201,17 +234,18 @@ external-project/
|
|
|
201
234
|
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.
|
|
202
235
|
|
|
203
236
|
## Workspace Intelligence Commands
|
|
237
|
+
|
|
204
238
|
Workspace Intelligence provides a shared understanding of projects, dependencies, operational context, and release readiness for developers, CI pipelines, and AI agents.
|
|
205
239
|
|
|
206
|
-
| Command
|
|
207
|
-
|
|
|
208
|
-
| `workspace model --json`
|
|
209
|
-
| `workspace context --for-agent --json --write`
|
|
210
|
-
| `workspace agent-sync --write`
|
|
211
|
-
| `workspace snapshot --json`
|
|
212
|
-
| `workspace diff --from <file\|git[:ref]> --json` | Diff against snapshot or git
|
|
213
|
-
| `workspace impact --from <file> --json`
|
|
214
|
-
| `workspace verify [--strict] --json`
|
|
240
|
+
| Command | Purpose |
|
|
241
|
+
| ------------------------------------------------ | ---------------------------------------------------------------- |
|
|
242
|
+
| `workspace model --json` | Canonical workspace model |
|
|
243
|
+
| `workspace context --for-agent --json --write` | Agent-ready context pack + auto agent grounding sync |
|
|
244
|
+
| `workspace agent-sync --write` | Cross-tool grounding (AGENTS.md, Copilot, Cursor, Claude, INDEX) |
|
|
245
|
+
| `workspace snapshot --json` | Persist model snapshot |
|
|
246
|
+
| `workspace diff --from <file\|git[:ref]> --json` | Diff against snapshot or git |
|
|
247
|
+
| `workspace impact --from <file> --json` | Blast-radius evidence |
|
|
248
|
+
| `workspace verify [--strict] --json` | Impact verification gate |
|
|
215
249
|
|
|
216
250
|
JSON schemas: `contracts/workspace-intelligence/`. Details: [commands-reference.md](docs/commands-reference.md).
|
|
217
251
|
|
|
@@ -230,19 +264,19 @@ npx rapidkit workspace context --for-agent --json --write
|
|
|
230
264
|
npx rapidkit workspace agent-sync --write --strict --json
|
|
231
265
|
```
|
|
232
266
|
|
|
233
|
-
| Artifact / file
|
|
234
|
-
|
|
|
235
|
-
| `.rapidkit/reports/INDEX.json`
|
|
236
|
-
| `.rapidkit/reports/workspace-context-agent.json`
|
|
237
|
-
| `.rapidkit/AGENT-GROUNDING.md`
|
|
238
|
-
| `AGENTS.md`
|
|
239
|
-
| `.github/copilot-instructions.md`
|
|
240
|
-
| `.github/instructions/rapidkit-evidence.instructions.md` | Copilot scoped rules for `.rapidkit/**`
|
|
241
|
-
| `.github/prompts/rapidkit-diagnose.prompt.md`
|
|
242
|
-
| `.github/skills/rapidkit-grounding/SKILL.md`
|
|
243
|
-
| `.cursor/rules/rapidkit-grounding.mdc`
|
|
244
|
-
| `CLAUDE.md`
|
|
245
|
-
| `.claude/rules/rapidkit-evidence.md`
|
|
267
|
+
| Artifact / file | Purpose |
|
|
268
|
+
| -------------------------------------------------------- | ------------------------------------------------------- |
|
|
269
|
+
| `.rapidkit/reports/INDEX.json` | Read order, blockers, report timestamps |
|
|
270
|
+
| `.rapidkit/reports/workspace-context-agent.json` | Canonical agent context pack |
|
|
271
|
+
| `.rapidkit/AGENT-GROUNDING.md` | Tool-agnostic grounding doc |
|
|
272
|
+
| `AGENTS.md` | Open standard for all agents (managed RapidKit section) |
|
|
273
|
+
| `.github/copilot-instructions.md` | GitHub Copilot / VS Code Chat always-on rules |
|
|
274
|
+
| `.github/instructions/rapidkit-evidence.instructions.md` | Copilot scoped rules for `.rapidkit/**` |
|
|
275
|
+
| `.github/prompts/rapidkit-diagnose.prompt.md` | Copilot reusable diagnose prompt |
|
|
276
|
+
| `.github/skills/rapidkit-grounding/SKILL.md` | Copilot agent skill workflow |
|
|
277
|
+
| `.cursor/rules/rapidkit-grounding.mdc` | Cursor always-on project rule |
|
|
278
|
+
| `CLAUDE.md` | Claude Code entry (`@AGENTS.md` + managed notes) |
|
|
279
|
+
| `.claude/rules/rapidkit-evidence.md` | Claude Code scoped evidence rules |
|
|
246
280
|
|
|
247
281
|
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
282
|
|
|
@@ -280,8 +314,13 @@ npx rapidkit doctor workspace --json
|
|
|
280
314
|
### I want a new project
|
|
281
315
|
|
|
282
316
|
```bash
|
|
283
|
-
|
|
284
|
-
cd
|
|
317
|
+
mkdir -p ~/rapidkit/workspaces
|
|
318
|
+
cd ~/rapidkit/workspaces
|
|
319
|
+
|
|
320
|
+
npx rapidkit create workspace platform --yes --profile polyglot --output .
|
|
321
|
+
cd platform
|
|
322
|
+
|
|
323
|
+
npx rapidkit bootstrap --profile polyglot
|
|
285
324
|
npx rapidkit create project # interactive kit picker
|
|
286
325
|
npx rapidkit create frontend nextjs my-web --yes
|
|
287
326
|
cd <project-name> && npx rapidkit init && npx rapidkit dev
|
|
@@ -303,11 +342,11 @@ Stages individually: `workspace sync`, `doctor workspace --ci`, `analyze --stric
|
|
|
303
342
|
|
|
304
343
|
## CI & evidence
|
|
305
344
|
|
|
306
|
-
| Stage
|
|
307
|
-
|
|
|
308
|
-
| Pipeline
|
|
309
|
-
| Doctor
|
|
310
|
-
| Analyze
|
|
345
|
+
| Stage | Report |
|
|
346
|
+
| --------- | --------------------------------------------------- |
|
|
347
|
+
| Pipeline | `.rapidkit/reports/pipeline-last-run.json` |
|
|
348
|
+
| Doctor | `.rapidkit/reports/doctor-last-run.json` |
|
|
349
|
+
| Analyze | `.rapidkit/reports/analyze-last-run.json` |
|
|
311
350
|
| Readiness | `.rapidkit/reports/release-readiness-last-run.json` |
|
|
312
351
|
| Autopilot | `.rapidkit/reports/autopilot-release-last-run.json` |
|
|
313
352
|
|
|
@@ -332,43 +371,44 @@ RapidKit provides the workspace intelligence engine: model, context, impact, ver
|
|
|
332
371
|
|
|
333
372
|
Workspai — Workspace + Intelligence — provides the VS Code surface: dashboard, sidebar, Incident Studio, AI workflows, and developer-facing workspace operations.
|
|
334
373
|
|
|
335
|
-
| Component | Repository
|
|
336
|
-
|
|
|
337
|
-
| CLI
|
|
338
|
-
| VS Code
|
|
339
|
-
| Core
|
|
340
|
-
| Examples
|
|
374
|
+
| Component | Repository | Role |
|
|
375
|
+
| --------- | ---------------------------------------------------------------------- | ------------------------------------------- |
|
|
376
|
+
| CLI | [rapidkit-npm](https://github.com/rapidkitlabs/rapidkit-npm) | Commands, governance, adoption, CI evidence |
|
|
377
|
+
| VS Code | [rapidkit-vscode](https://github.com/rapidkitlabs/rapidkit-vscode) | Workspai dashboard, sidebar, AI studio |
|
|
378
|
+
| Core | [rapidkit-core](https://github.com/rapidkitlabs/rapidkit-core) | Python engine, modules, doctor |
|
|
379
|
+
| Examples | [rapidkit-examples](https://github.com/rapidkitlabs/rapidkit-examples) | Starter workspaces |
|
|
341
380
|
|
|
342
381
|
## VS Code extension
|
|
382
|
+
|
|
343
383
|
Workspai is the VS Code experience for RapidKit workspace intelligence.
|
|
344
384
|
|
|
345
385
|
Search **Workspai** in the marketplace or install via:
|
|
346
386
|
`ext install rapidkit.rapidkit-vscode`.
|
|
347
387
|
|
|
348
|
-
| Feature
|
|
349
|
-
|
|
|
350
|
-
| Create / adopt / import
|
|
351
|
-
| Workspace model / context
|
|
352
|
-
| Cross-tool agent grounding
|
|
353
|
-
| Enterprise evidence loop
|
|
354
|
-
| Module catalog (FastAPI/NestJS) | Limited
|
|
388
|
+
| Feature | CLI | Extension |
|
|
389
|
+
| ------------------------------- | ---------------------------- | ------------------------------- |
|
|
390
|
+
| Create / adopt / import | Yes | Guided wizards |
|
|
391
|
+
| Workspace model / context | Yes | Dashboard + AI scope |
|
|
392
|
+
| Cross-tool agent grounding | Yes (`workspace agent-sync`) | Send-to-Copilot / Ask Studio UX |
|
|
393
|
+
| Enterprise evidence loop | Partial | Full dashboard |
|
|
394
|
+
| Module catalog (FastAPI/NestJS) | Limited | Browser UI |
|
|
355
395
|
|
|
356
396
|
The extension invokes this npm CLI. For the latest `adopt` and `create frontend` features, install matching CLI version: `npm install -g rapidkit@latest` or `npm link` from this repo ([Development](#development)).
|
|
357
397
|
|
|
358
398
|
## Documentation
|
|
359
399
|
|
|
360
|
-
| Doc
|
|
361
|
-
|
|
|
362
|
-
| [docs/README.md](docs/README.md)
|
|
363
|
-
| [docs/commands-reference.md](docs/commands-reference.md)
|
|
364
|
-
| [docs/workspace-operations.md](docs/workspace-operations.md)
|
|
365
|
-
| [docs/workspace-run.md](docs/workspace-run.md)
|
|
366
|
-
| [docs/doctor-command.md](docs/doctor-command.md)
|
|
367
|
-
| [docs/OPEN_SOURCE_USER_SCENARIOS.md](docs/OPEN_SOURCE_USER_SCENARIOS.md) | Role-based workflows
|
|
368
|
-
| [docs/SETUP.md](docs/SETUP.md)
|
|
369
|
-
| [docs/SECURITY.md](docs/SECURITY.md)
|
|
370
|
-
| [docs/config-file-guide.md](docs/config-file-guide.md)
|
|
371
|
-
| [CHANGELOG.md](CHANGELOG.md)
|
|
400
|
+
| Doc | Description |
|
|
401
|
+
| ------------------------------------------------------------------------ | ------------------------------------------- |
|
|
402
|
+
| [docs/README.md](docs/README.md) | Documentation index |
|
|
403
|
+
| [docs/commands-reference.md](docs/commands-reference.md) | Full command syntax |
|
|
404
|
+
| [docs/workspace-operations.md](docs/workspace-operations.md) | Import, adopt, snapshots, archives, infra |
|
|
405
|
+
| [docs/workspace-run.md](docs/workspace-run.md) | Polyglot fleet orchestration |
|
|
406
|
+
| [docs/doctor-command.md](docs/doctor-command.md) | Doctor scopes, CI exit codes, JSON evidence |
|
|
407
|
+
| [docs/OPEN_SOURCE_USER_SCENARIOS.md](docs/OPEN_SOURCE_USER_SCENARIOS.md) | Role-based workflows |
|
|
408
|
+
| [docs/SETUP.md](docs/SETUP.md) | Maintainer setup |
|
|
409
|
+
| [docs/SECURITY.md](docs/SECURITY.md) | Security policy |
|
|
410
|
+
| [docs/config-file-guide.md](docs/config-file-guide.md) | User configuration |
|
|
411
|
+
| [CHANGELOG.md](CHANGELOG.md) | Version history |
|
|
372
412
|
|
|
373
413
|
## Development
|
|
374
414
|
|
|
@@ -383,17 +423,17 @@ Contributors: [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md), [docs/ci-workflows.md]
|
|
|
383
423
|
|
|
384
424
|
## Troubleshooting
|
|
385
425
|
|
|
386
|
-
| Problem
|
|
387
|
-
|
|
|
388
|
-
| `python3` not found
|
|
389
|
-
| `setup --warm-deps` skipped
|
|
390
|
-
| Strict policy blocks command
|
|
391
|
-
| `npm audit fix --force` downgrades tsup | `package.json`
|
|
392
|
-
| Security audit fails on esbuild
|
|
393
|
-
| Doctor output stale
|
|
394
|
-
| Copilot ignores workspace evidence
|
|
395
|
-
| Agent grounding strict CI failed
|
|
396
|
-
| Affected run scope wrong
|
|
426
|
+
| Problem | Quick check | Fix |
|
|
427
|
+
| --------------------------------------- | ---------------------------------- | ------------------------------------------------ |
|
|
428
|
+
| `python3` not found | `python3 --version` | Install Python 3.10+ |
|
|
429
|
+
| `setup --warm-deps` skipped | Project markers in cwd | Run from target project directory |
|
|
430
|
+
| Strict policy blocks command | `.rapidkit/policies.yml` | `workspace policy set …` |
|
|
431
|
+
| `npm audit fix --force` downgrades tsup | `package.json` | Do not use `--force`; keep `tsup@^8.5.1` |
|
|
432
|
+
| Security audit fails on esbuild | `npm audit --audit-level=moderate` | Keep `esbuild` override in `package.json` |
|
|
433
|
+
| Doctor output stale | Report timestamps | Re-run `doctor workspace` or `doctor project` |
|
|
434
|
+
| Copilot ignores workspace evidence | Missing grounding files | `workspace agent-sync --write --refresh-context` |
|
|
435
|
+
| Agent grounding strict CI failed | Stale/missing reports | Run governance chain then re-sync |
|
|
436
|
+
| Affected run scope wrong | Git ref | Use `--since <ref>` explicitly |
|
|
397
437
|
|
|
398
438
|
## License
|
|
399
439
|
|