workspai 0.43.0 → 0.44.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.
Files changed (173) hide show
  1. package/README.md +26 -13
  2. package/contracts/agent-customization-pack.v1.json +1 -1
  3. package/contracts/autopilot-release.v1.json +204 -0
  4. package/contracts/cli-operation-result.v1.json +119 -0
  5. package/contracts/command-capabilities.v1.json +138 -0
  6. package/contracts/compatibility-matrix.v1.json +37 -0
  7. package/contracts/create-planner-capabilities.v1.json +156 -65
  8. package/contracts/doctor-project-scan.v2.json +60 -0
  9. package/contracts/doctor-remediation-plan.v1.json +19 -4
  10. package/contracts/doctor-remediation-plan.v2.json +7 -0
  11. package/contracts/doctor-workspace-cache.v2.json +82 -0
  12. package/contracts/extension-cli-compatibility.v1.json +47 -3
  13. package/contracts/infra-plan.v1.json +189 -0
  14. package/contracts/private-product-manifest.v1.json +155 -0
  15. package/contracts/product-factory-plan.v1.json +200 -0
  16. package/contracts/project-archive.v1.json +40 -0
  17. package/contracts/project-entry-capability.v1.json +127 -0
  18. package/contracts/published-contract-catalog.v1.json +334 -0
  19. package/contracts/runtime-command-surface.v1.json +239 -10
  20. package/contracts/version.v1.json +48 -0
  21. package/contracts/workspace-archive-capabilities.v1.json +90 -0
  22. package/contracts/workspace-archive-manifest.v1.json +107 -0
  23. package/contracts/workspace-archive-operation-result.v1.json +565 -0
  24. package/contracts/workspace-intelligence/agent-customization-pack-report.v1.json +98 -0
  25. package/contracts/workspace-intelligence/agent-hooks.v1.json +38 -0
  26. package/contracts/workspace-intelligence/agent-reports-index.v1.json +56 -0
  27. package/contracts/workspace-intelligence/mcp-design.v1.json +42 -0
  28. package/contracts/workspace-intelligence/workspace-context.v1.json +12 -0
  29. package/contracts/workspace-intelligence/workspace-explain.v1.json +1 -0
  30. package/contracts/workspace-intelligence-architecture.v1.json +723 -0
  31. package/contracts/workspace-intelligence-chain.v1.json +1194 -0
  32. package/contracts/workspace-list.v1.json +56 -0
  33. package/contracts/workspace-model-cache.v1.json +55 -0
  34. package/contracts/workspace-snapshot.v1.json +58 -0
  35. package/contracts/workspace-snapshot.v2.json +97 -0
  36. package/contracts/workspace-sync.v1.json +30 -0
  37. package/contracts/workspace-watch-event.v1.json +112 -0
  38. package/dist/analyze-6OCBM4ID.js +1 -0
  39. package/dist/{artifact-remediation-plan-5GJWPPRS.js → artifact-remediation-plan-Z7OCSME3.js} +3 -3
  40. package/dist/autopilot-release-LI2WJCEW.js +1 -0
  41. package/dist/{chunk-LZQNVH7D.js → chunk-2K3GYCPS.js} +1 -1
  42. package/dist/chunk-2QN6BMM7.js +2 -0
  43. package/dist/chunk-2QOWRBQD.js +1 -0
  44. package/dist/chunk-5AKYMAIL.js +1 -0
  45. package/dist/{chunk-RE773WOX.js → chunk-5PVEQ6CZ.js} +5 -5
  46. package/dist/{chunk-AFSZHLQT.js → chunk-7EIMPQR3.js} +1 -1
  47. package/dist/{chunk-3KXW53QI.js → chunk-7IHLTPZ6.js} +1 -1
  48. package/dist/chunk-7RIWU5TZ.js +1 -0
  49. package/dist/{chunk-T6OR6YOI.js → chunk-7UZVOYF5.js} +1 -1
  50. package/dist/chunk-B66A4TVP.js +1 -0
  51. package/dist/chunk-CL6TGI4Q.js +8 -0
  52. package/dist/chunk-FWJV7CCI.js +2 -0
  53. package/dist/chunk-J4AICQFB.js +1 -0
  54. package/dist/chunk-JICOD2GI.js +1 -0
  55. package/dist/{chunk-OJEWQO3Z.js → chunk-JP25YL3J.js} +17 -17
  56. package/dist/chunk-L2Q7B2OJ.js +1 -0
  57. package/dist/chunk-L3E6IRUQ.js +8 -0
  58. package/dist/chunk-LG6RFLPZ.js +1 -0
  59. package/dist/chunk-LGP6WXS2.js +4 -0
  60. package/dist/{chunk-VRDF2J46.js → chunk-M4VITK6X.js} +52 -50
  61. package/dist/chunk-NTXO7BMH.js +4 -0
  62. package/dist/{chunk-LPZFK3Y6.js → chunk-OW4UNG27.js} +65 -66
  63. package/dist/{chunk-LUP4U6EE.js → chunk-P424XYHP.js} +1 -1
  64. package/dist/chunk-P4SWTY5X.js +33 -0
  65. package/dist/chunk-TQEMLBAG.js +1 -0
  66. package/dist/chunk-TRMDODFM.js +13 -0
  67. package/dist/chunk-UNF72FTB.js +1 -0
  68. package/dist/chunk-V5JN4TDX.js +2 -0
  69. package/dist/chunk-VA5MRHKM.js +2 -0
  70. package/dist/chunk-XIVFLY6G.js +1 -0
  71. package/dist/chunk-YUX4YFGL.js +78 -0
  72. package/dist/{create-WRZO4HK2.js → create-DFAWAS5C.js} +1 -1
  73. package/dist/demo-kit-DZ7TPG7K.js +149 -0
  74. package/dist/doctor-PVSWDBJL.js +1 -0
  75. package/dist/{dotnet-webapi-clean-IPY3MCGQ.js → dotnet-webapi-clean-BYUUHX5Y.js} +20 -20
  76. package/dist/{gofiber-standard-N5N3QGH3.js → gofiber-standard-B6UK5GR7.js} +31 -31
  77. package/dist/{gogin-standard-LAWQTBWL.js → gogin-standard-BXU44VEM.js} +31 -31
  78. package/dist/index.d.ts +250 -24
  79. package/dist/index.js +218 -182
  80. package/dist/pipeline-ND734AJM.js +5 -0
  81. package/dist/{platform-capabilities-XAVU4HSM.js → platform-capabilities-YICBF4FA.js} +1 -1
  82. package/dist/{pythonRapidkitExec-3L3XJBSY.js → pythonRapidkitExec-UJYIB6FL.js} +1 -1
  83. package/dist/{springboot-standard-OZYF7ZM7.js → springboot-standard-PEHDKH2L.js} +27 -27
  84. package/dist/{workspace-PR6VZRBG.js → workspace-FQT3QIRS.js} +1 -1
  85. package/dist/workspace-agent-sync-ZYCPXTU3.js +1 -0
  86. package/dist/workspace-archive-EEGLHZDW.js +10 -0
  87. package/dist/workspace-context-WAGGJCDL.js +1 -0
  88. package/dist/{workspace-contract-XUGMCUSQ.js → workspace-contract-SEI4SNSG.js} +1 -1
  89. package/dist/workspace-explain-MVGGRCDN.js +1 -0
  90. package/dist/workspace-explain-contract-KT757JGQ.js +1 -0
  91. package/dist/{workspace-feedback-R6H4UFZB.js → workspace-feedback-RCB25NFO.js} +1 -1
  92. package/dist/{workspace-foundation-KGSV4E6D.js → workspace-foundation-KXDL6P6X.js} +1 -1
  93. package/dist/{workspace-history-CGCK2DJI.js → workspace-history-M4QQBIPB.js} +1 -1
  94. package/dist/workspace-intelligence-QOGD2TZS.js +1 -0
  95. package/dist/workspace-mcp-serve-CEFKEMYG.js +3 -0
  96. package/dist/{workspace-model-PNXXOGPO.js → workspace-model-GMSRBICO.js} +1 -1
  97. package/dist/workspace-registry-summary-S52SEJAG.js +1 -0
  98. package/dist/workspace-run-VC4OUPRF.js +1 -0
  99. package/dist/{workspace-verify-WSDUUTR5.js → workspace-verify-NP4GMFSV.js} +1 -1
  100. package/dist/workspace-watch-IIBH3Y25.js +1 -0
  101. package/docs/AI_FEATURES.md +67 -34
  102. package/docs/README.md +2 -1
  103. package/docs/commands-reference.md +26 -14
  104. package/docs/contracts/ARTIFACT_CATALOG.md +60 -36
  105. package/docs/contracts/README.md +3 -2
  106. package/docs/create-planner-capabilities.md +36 -18
  107. package/docs/workspace-operations.md +25 -0
  108. package/package.json +35 -13
  109. package/scripts/enterprise-package-smoke.mjs +40 -8
  110. package/scripts/prepack-enterprise.mjs +8 -0
  111. package/templates/kits/fastapi-ddd/.gitignore.j2 +11 -0
  112. package/templates/kits/fastapi-ddd/README.md.j2 +23 -18
  113. package/templates/kits/fastapi-ddd/common/env.example.j2 +2 -2
  114. package/templates/kits/fastapi-ddd/pyproject.toml.j2 +7 -7
  115. package/templates/kits/fastapi-ddd/src/app/config/__init__.py.j2 +1 -1
  116. package/templates/kits/fastapi-ddd/src/cli.py.j2 +6 -9
  117. package/templates/kits/fastapi-ddd/src/main.py.j2 +1 -1
  118. package/templates/kits/fastapi-standard/.gitignore.j2 +11 -0
  119. package/templates/kits/fastapi-standard/README.md.j2 +35 -30
  120. package/templates/kits/fastapi-standard/common/env.example.j2 +2 -2
  121. package/templates/kits/fastapi-standard/pyproject.toml.j2 +7 -7
  122. package/templates/kits/fastapi-standard/src/cli.py.j2 +7 -10
  123. package/templates/kits/fastapi-standard/src/main.py.j2 +1 -1
  124. package/templates/kits/fastapi-standard/src/routing/examples.py.j2 +1 -1
  125. package/templates/kits/fastapi-standard/tests/test_examples.py.j2 +1 -1
  126. package/templates/kits/nestjs-standard/.dockerignore.j2 +11 -0
  127. package/templates/kits/nestjs-standard/.eslintrc.js.j2 +25 -0
  128. package/templates/kits/nestjs-standard/.gitignore.j2 +22 -0
  129. package/templates/kits/nestjs-standard/.node-version.j2 +1 -0
  130. package/templates/kits/nestjs-standard/.nvmrc.j2 +1 -0
  131. package/templates/kits/nestjs-standard/.prettierrc.j2 +7 -0
  132. package/templates/kits/nestjs-standard/README.md.j2 +23 -18
  133. package/templates/kits/nestjs-standard/docs/README.md.j2 +2 -2
  134. package/templates/kits/nestjs-standard/jest.config.ts.j2 +1 -7
  135. package/templates/kits/nestjs-standard/package.json.j2 +1 -1
  136. package/templates/kits/nestjs-standard/src/config/configuration.ts.j2 +4 -4
  137. package/templates/kits/nestjs-standard/src/main.ts.j2 +1 -1
  138. package/templates/kits/nestjs-standard/src/modules/index.ts.j2 +1 -1
  139. package/templates/kits/nestjs-standard/tsconfig.build.json.j2 +1 -1
  140. package/templates/kits/nestjs-standard/tsconfig.json.j2 +1 -1
  141. package/dist/analyze-5BU4QIPK.js +0 -1
  142. package/dist/autopilot-release-QYUOVB26.js +0 -1
  143. package/dist/chunk-54XJNLYC.js +0 -13
  144. package/dist/chunk-5SWNSJGW.js +0 -1
  145. package/dist/chunk-753LOKFZ.js +0 -2
  146. package/dist/chunk-AAKUNWPR.js +0 -78
  147. package/dist/chunk-AQ4XZZC6.js +0 -1
  148. package/dist/chunk-CVTCPPEF.js +0 -1
  149. package/dist/chunk-DNAY5ALC.js +0 -1
  150. package/dist/chunk-EWYYLJQY.js +0 -2
  151. package/dist/chunk-LO4C4VXR.js +0 -4
  152. package/dist/chunk-LYC6AIF2.js +0 -2
  153. package/dist/chunk-NAAQMSO3.js +0 -1
  154. package/dist/chunk-NFUXULIF.js +0 -1
  155. package/dist/chunk-OL64GWQC.js +0 -9
  156. package/dist/chunk-PI5KUXDA.js +0 -7
  157. package/dist/chunk-SI3AQKIP.js +0 -1
  158. package/dist/chunk-VZKSNUEE.js +0 -2
  159. package/dist/chunk-WU4ZRRA5.js +0 -4
  160. package/dist/chunk-XEJD4KCV.js +0 -33
  161. package/dist/demo-kit-AJ5LIM5G.js +0 -149
  162. package/dist/doctor-MF3M3FS3.js +0 -1
  163. package/dist/pipeline-QCUHFWDY.js +0 -5
  164. package/dist/workspace-agent-sync-KTYF3HQR.js +0 -1
  165. package/dist/workspace-archive-GCZNI44O.js +0 -3
  166. package/dist/workspace-context-QUTOP2XV.js +0 -1
  167. package/dist/workspace-explain-JEONEGZZ.js +0 -1
  168. package/dist/workspace-explain-contract-DNS2YEL7.js +0 -1
  169. package/dist/workspace-intelligence-QJGVL37U.js +0 -1
  170. package/dist/workspace-mcp-serve-AK4MYEHQ.js +0 -3
  171. package/dist/workspace-registry-summary-RUJE6RPH.js +0 -1
  172. package/dist/workspace-run-Y7YMUIHX.js +0 -1
  173. package/dist/workspace-watch-AGPOJ74Q.js +0 -1
@@ -29,6 +29,7 @@ npx workspai ai recommend "user authentication with social login"
29
29
  **Step 1:** Get OpenAI API key from [OpenAI Platform](https://platform.openai.com/api-keys)
30
30
 
31
31
  **Step 2:** Configure API key
32
+
32
33
  ```bash
33
34
  npx workspai config set-api-key
34
35
  # Or (non-interactive environments):
@@ -36,6 +37,7 @@ export OPENAI_API_KEY="<YOUR_OPENAI_API_KEY>"
36
37
  ```
37
38
 
38
39
  **Step 3:** Generate embeddings (one-time, provider-cost dependent)
40
+
39
41
  ```bash
40
42
  npx workspai ai generate-embeddings
41
43
 
@@ -53,6 +55,7 @@ npx workspai ai generate-embeddings
53
55
  ```
54
56
 
55
57
  **Step 4:** Use AI recommendations
58
+
56
59
  ```bash
57
60
  npx workspai ai recommend "user authentication"
58
61
  ```
@@ -82,6 +85,7 @@ Mock mode provides realistic (but not perfect) results for development and testi
82
85
  Get intelligent module suggestions based on natural language descriptions.
83
86
 
84
87
  **Example:**
88
+
85
89
  ```bash
86
90
  $ npx workspai ai recommend "I need user authentication with email"
87
91
 
@@ -106,18 +110,20 @@ $ npx workspai ai recommend "I need user authentication with email"
106
110
  ## 💰 Pricing
107
111
 
108
112
  ### One-Time Setup Cost (Estimates)
109
- | Item | Cost | Notes |
110
- |------|------|-------|
113
+
114
+ | Item | Cost | Notes |
115
+ | ------------------- | ------ | ------------------------------------------------ |
111
116
  | Generate embeddings | Varies | One-time only, depends on model and module count |
112
- | Update embeddings | Varies | Only when catalog changes |
117
+ | Update embeddings | Varies | Only when catalog changes |
113
118
 
114
119
  ### Per-Query Cost (After Setup, Estimates)
115
- | Usage | Cost | Notes |
116
- |-------|------|-------|
117
- | Single query | Very low | Depends on provider/model |
118
- | 100 queries | Low | Depends on provider/model |
119
- | 1,000 queries | Moderate | Depends on provider/model |
120
- | 10,000 queries | Higher | Depends on provider/model |
120
+
121
+ | Usage | Cost | Notes |
122
+ | -------------- | -------- | ------------------------- |
123
+ | Single query | Very low | Depends on provider/model |
124
+ | 100 queries | Low | Depends on provider/model |
125
+ | 1,000 queries | Moderate | Depends on provider/model |
126
+ | 10,000 queries | Higher | Depends on provider/model |
121
127
 
122
128
  **Important:** Provider pricing and limits change over time. Always validate current pricing/limits in the provider dashboard before budgeting.
123
129
 
@@ -126,21 +132,25 @@ $ npx workspai ai recommend "I need user authentication with email"
126
132
  ## 🔧 Configuration
127
133
 
128
134
  ### View Current Config
135
+
129
136
  ```bash
130
137
  npx workspai config show
131
138
  ```
132
139
 
133
140
  ### Set API Key
141
+
134
142
  ```bash
135
143
  npx workspai config set-api-key
136
144
  ```
137
145
 
138
146
  ### Remove API Key
147
+
139
148
  ```bash
140
149
  npx workspai config remove-api-key
141
150
  ```
142
151
 
143
152
  ### Enable/Disable AI
153
+
144
154
  ```bash
145
155
  npx workspai config ai enable
146
156
  npx workspai config ai disable
@@ -180,17 +190,17 @@ npx workspai config ai disable
180
190
 
181
191
  ### Technical Details
182
192
 
183
- 1. **Module Catalog**:
193
+ 1. **Module Catalog**:
184
194
  - 27+ production-ready modules (dynamic from Python Core)
185
195
  - Fallback to 11 hardcoded modules if Python unavailable
186
196
  - 5-minute cache for performance
187
197
 
188
- 2. **Embeddings**:
198
+ 2. **Embeddings**:
189
199
  - AI converts module descriptions to 1536-dimensional vectors
190
200
  - Generated once, reused for all queries
191
201
  - Stored in `data/modules-embeddings.json` (508KB)
192
202
 
193
- 3. **Semantic Search**:
203
+ 3. **Semantic Search**:
194
204
  - User query → embedding vector
195
205
  - Cosine similarity with all modules
196
206
  - Results sorted by relevance score (0-100%)
@@ -202,12 +212,14 @@ npx workspai config ai disable
202
212
  - Installation order calculation
203
213
 
204
214
  **Technology Stack:**
215
+
205
216
  - Model: `text-embedding-3-small` (OpenAI)
206
217
  - Dimension: 1536 vectors
207
218
  - Accuracy: 92%+ match scores
208
219
  - Cost: provider-dependent (check current provider pricing)
209
220
 
210
221
  **Performance:**
222
+
211
223
  - First query: ~200ms (embedding generation)
212
224
  - Subsequent queries: ~50ms (cached embeddings)
213
225
  - Catalog refresh: Every 5 minutes
@@ -215,21 +227,25 @@ npx workspai config ai disable
215
227
  ## 🎯 Use Cases
216
228
 
217
229
  ### E-commerce Platform
230
+
218
231
  ```bash
219
232
  workspai ai recommend "e-commerce with payments and inventory"
220
233
  ```
221
234
 
222
235
  ### SaaS Application
236
+
223
237
  ```bash
224
238
  workspai ai recommend "SaaS platform with subscriptions"
225
239
  ```
226
240
 
227
241
  ### Real-time Chat
242
+
228
243
  ```bash
229
244
  workspai ai recommend "real-time chat application"
230
245
  ```
231
246
 
232
247
  ### API Gateway
248
+
233
249
  ```bash
234
250
  workspai ai recommend "API gateway with rate limiting"
235
251
  ```
@@ -259,6 +275,7 @@ npx workspai ai recommend "auth"
259
275
  ```
260
276
 
261
277
  Or generate manually:
278
+
262
279
  ```bash
263
280
  npx workspai ai generate-embeddings
264
281
  ```
@@ -266,12 +283,14 @@ npx workspai ai generate-embeddings
266
283
  ### "OpenAI API key not configured"
267
284
 
268
285
  **Option 1:** Mock mode (no key needed, for testing)
286
+
269
287
  ```bash
270
288
  # Just use it! Mock mode activates automatically
271
289
  npx workspai ai recommend "database"
272
290
  ```
273
291
 
274
292
  **Option 2:** Get a real API key
293
+
275
294
  ```bash
276
295
  # 1. Get key: https://platform.openai.com/api-keys
277
296
  # 2. Configure it:
@@ -286,6 +305,7 @@ export OPENAI_API_KEY="<YOUR_OPENAI_API_KEY>"
286
305
  **Cause:** API key is incorrect or expired
287
306
 
288
307
  **Solution:**
308
+
289
309
  ```bash
290
310
  # Update your API key
291
311
  npx workspai config set-api-key
@@ -299,12 +319,14 @@ npx workspai config show
299
319
  **Cause:** OpenAI API quota or rate limit reached
300
320
 
301
321
  **Solutions:**
322
+
302
323
  1. **Check billing:** https://platform.openai.com/account/billing
303
324
  2. **Check limits:** https://platform.openai.com/account/limits
304
325
  3. **Upgrade tier:** Free tier has lower limits
305
326
  4. **Wait:** Rate limits reset automatically
306
327
 
307
328
  **Rate Limits:**
329
+
308
330
  - Limits vary by provider account tier and can change over time
309
331
  - Check your provider dashboard for current request/token limits
310
332
 
@@ -315,6 +337,7 @@ npx workspai config show
315
337
  **Impact:** Uses fallback catalog instead of the full runtime catalog
316
338
 
317
339
  **Solution (optional):**
340
+
318
341
  ```bash
319
342
  # Install RapidKit Python Core
320
343
  pip install -e /path/to/rapidkit-core
@@ -330,6 +353,7 @@ rapidkit modules list --json
330
353
  **Symptom:** New modules not appearing in recommendations
331
354
 
332
355
  **Solution:** Update embeddings with latest modules
356
+
333
357
  ```bash
334
358
  npx workspai ai update-embeddings
335
359
 
@@ -344,11 +368,13 @@ npx workspai ai update-embeddings
344
368
  **Symptom:** All results show <70% match
345
369
 
346
370
  **Possible Causes:**
371
+
347
372
  1. Query too vague: "build something"
348
373
  2. Query too specific: "blockchain NFT marketplace with AI"
349
374
  3. No matching modules exist
350
375
 
351
376
  **Solutions:**
377
+
352
378
  - Make query more specific: "authentication" → "user authentication with JWT"
353
379
  - Try different keywords: "storage" instead of "blockchain"
354
380
  - Check available modules: `npx workspai ai info`
@@ -358,6 +384,7 @@ npx workspai ai update-embeddings
358
384
  **Cause:** Mock embeddings are deterministic but not trained
359
385
 
360
386
  **Solution:** Use real OpenAI API for production
387
+
361
388
  ```bash
362
389
  # Get API key and generate real embeddings
363
390
  npx workspai config set-api-key
@@ -380,11 +407,13 @@ npx workspai config show
380
407
  ### Still Having Issues?
381
408
 
382
409
  1. **Enable debug logging:**
410
+
383
411
  ```bash
384
412
  DEBUG=rapidkit:* npx workspai ai recommend "auth"
385
413
  ```
386
414
 
387
415
  2. **Check for updates:**
416
+
388
417
  ```bash
389
418
  npm outdated workspai
390
419
  npm update workspai
@@ -398,25 +427,25 @@ npx workspai config show
398
427
 
399
428
  ### AI Commands
400
429
 
401
- | Command | Description | Example |
402
- |---------|-------------|---------|
403
- | `workspai ai recommend [query]` | Get module recommendations | `workspai ai recommend "auth"` |
404
- | `workspai ai recommend [query] -n <N>` | Get top N recommendations | `workspai ai recommend "database" -n 3` |
405
- | `workspai ai recommend [query] --json` | Get JSON output | `workspai ai recommend "auth" --json` |
406
- | `workspai ai generate-embeddings` | Generate embeddings (one-time) | `workspai ai generate-embeddings` |
407
- | `workspai ai generate-embeddings --force` | Force regenerate embeddings | `workspai ai generate-embeddings --force` |
408
- | `workspai ai update-embeddings` | Update with latest modules | `workspai ai update-embeddings` |
409
- | `workspai ai info` | Show AI features info | `workspai ai info` |
430
+ | Command | Description | Example |
431
+ | ----------------------------------------- | ------------------------------ | ----------------------------------------- |
432
+ | `workspai ai recommend [query]` | Get module recommendations | `workspai ai recommend "auth"` |
433
+ | `workspai ai recommend [query] -n <N>` | Get top N recommendations | `workspai ai recommend "database" -n 3` |
434
+ | `workspai ai recommend [query] --json` | Get JSON output | `workspai ai recommend "auth" --json` |
435
+ | `workspai ai generate-embeddings` | Generate embeddings (one-time) | `workspai ai generate-embeddings` |
436
+ | `workspai ai generate-embeddings --force` | Force regenerate embeddings | `workspai ai generate-embeddings --force` |
437
+ | `workspai ai update-embeddings` | Update with latest modules | `workspai ai update-embeddings` |
438
+ | `workspai ai info` | Show AI features info | `workspai ai info` |
410
439
 
411
440
  ### Configuration Commands
412
441
 
413
- | Command | Description | Example |
414
- |---------|-------------|---------|
415
- | `workspai config set-api-key` | Set OpenAI API key (interactive) | `workspai config set-api-key` |
416
- | `workspai config show` | Show current config | `workspai config show` |
417
- | `workspai config remove-api-key` | Remove API key | `workspai config remove-api-key` |
418
- | `workspai config ai enable` | Enable AI features | `workspai config ai enable` |
419
- | `workspai config ai disable` | Disable AI features | `workspai config ai disable` |
442
+ | Command | Description | Example |
443
+ | -------------------------------- | -------------------------------- | -------------------------------- |
444
+ | `workspai config set-api-key` | Set OpenAI API key (interactive) | `workspai config set-api-key` |
445
+ | `workspai config show` | Show current config | `workspai config show` |
446
+ | `workspai config remove-api-key` | Remove API key | `workspai config remove-api-key` |
447
+ | `workspai config ai enable` | Enable AI features | `workspai config ai enable` |
448
+ | `workspai config ai disable` | Disable AI features | `workspai config ai disable` |
420
449
 
421
450
  ### Recommend Command Options
422
451
 
@@ -439,13 +468,17 @@ Options:
439
468
  -h, --help Display help
440
469
  ```
441
470
 
442
- ## 🚀 Coming Soon
471
+ ## 🚀 Planned Workspace Intelligence Extensions
472
+
473
+ These are roadmap ideas, not current CLI claims. New AI-facing surfaces must be
474
+ grounded in `contracts/workspace-intelligence-architecture.v1.json` before they
475
+ are documented as available features.
443
476
 
444
- - [ ] Code completion (GPT-4)
445
- - [ ] Codebase chat
446
- - [ ] Bug detection
447
- - [ ] Test generation
448
- - [ ] Architecture suggestions
477
+ - [ ] Workspace Atlas generated from Workspace Intelligence evidence
478
+ - [ ] Repository/project chat over generated evidence artifacts
479
+ - [ ] Bug detection grounded in doctor, verify, and impact reports
480
+ - [ ] Test generation informed by workspace model, runtime signals, and affected subgraphs
481
+ - [ ] Architecture suggestions with evidence/freshness labels
449
482
 
450
483
  ## 🤝 Contributing
451
484
 
package/docs/README.md CHANGED
@@ -18,7 +18,8 @@ Hub for user and contributor documentation. Start with the [main README](../READ
18
18
  | [commands-reference.md](./commands-reference.md) | Full CLI syntax, profiles, and policy keys |
19
19
  | [workspace-operations.md](./workspace-operations.md) | Import, adopt, snapshots, archives, contracts, infra |
20
20
  | [workspace-run.md](./workspace-run.md) | Polyglot fleet orchestration (`workspace run`) |
21
- | [create-planner-capabilities.md](./create-planner-capabilities.md) | Native create, external-create-adopt, and adopt-only lanes |
21
+ | [create-planner-capabilities.md](./create-planner-capabilities.md) | Native create, official, and existing lanes |
22
+ | [../contracts/project-entry-capability.v1.json](../contracts/project-entry-capability.v1.json) | Contract: any readable project can enter through adopt/import when it can be registered |
22
23
  | [from-code-to-shared-understanding.md](./from-code-to-shared-understanding.md) | GitHub-rendered Workspace Intelligence diagram |
23
24
  | [OPEN_SOURCE_USER_SCENARIOS.md](./OPEN_SOURCE_USER_SCENARIOS.md) | Role-based workflows (junior → enterprise) |
24
25
  | [doctor-command.md](./doctor-command.md) | Doctor scopes, CI exit codes, JSON evidence |
@@ -9,9 +9,9 @@ npx workspai create # Prompts: workspace | project
9
9
  npx workspai create workspace <name> [--profile <profile>] [--author <name>] [--yes] [--here|--output <parent-dir>] [--skip-python-engine]
10
10
  npx workspai bootstrap [--profile <profile>] [--ci] [--json] [--compliance-only]
11
11
  npx workspai setup <python|node|go|java|dotnet> [--warm-deps]
12
- npx workspai pipeline [--json] [--strict] [--skip-verify] [--skip-analyze] [--skip-autopilot] [--autopilot-mode <audit|safe-fix|enforce>]
12
+ npx workspai pipeline [--json] [--strict] [--skip-verify] [--skip-analyze] [--skip-autopilot] [--autopilot-mode <audit|safe-fix|enforce>] [--agent-sync|--no-agent-sync]
13
13
  npx workspai analyze [--workspace <path>] [--json] [--strict] [--output <file>]
14
- npx workspai readiness [--json] [--strict] [--skip-verify]
14
+ npx workspai readiness [--workspace <path>] [--json] [--strict] [--skip-verify]
15
15
  npx workspai autopilot release [--mode <audit|safe-fix|enforce>] [--json] [--output <file>] [--since <ref>] [--parallel] [--max-workers <n>]
16
16
  ```
17
17
 
@@ -49,19 +49,25 @@ npx workspai workspace contract init [--force] [--json]
49
49
  npx workspai workspace contract inspect [--json]
50
50
  npx workspai workspace contract verify [--strict] [--json]
51
51
  npx workspai workspace contract graph [--json]
52
- npx workspai workspace model [--json] [--write] [--strict]
53
- npx workspai workspace context --for-agent [codex|claude|cursor|orca] [--json] [--write] [--no-agent-sync]
54
- npx workspai workspace agent-sync [--write] [--refresh-context] [--strict] [--json] [--preset minimal|enterprise] [--target all|vscode|copilot,cursor,claude] [--experimental-hooks]
52
+ npx workspai workspace model [--workspace <path>] [--json] [--write] [--strict] [--cache] [--incremental] [--include-paths] [--include-evidence] [--scan-depth <count>]
53
+ npx workspai workspace context --for-agent [codex|claude|cursor|orca] [--workspace <path>] [--json] [--write] [--agent-sync|--no-agent-sync] [--target <targets>] [--preset minimal|enterprise] [--include-evidence] [--scan-depth <count>]
54
+ npx workspai workspace agent-sync [--workspace <path>] [--write] [--refresh-context] [--strict] [--json] [--preset minimal|enterprise] [--target all|vscode|agents,copilot,cursor,claude,codex,orca] [--experimental-hooks] [--hydrate-prompts]
55
55
  npx workspai workspace remediation-plan [--json] [--write] [--ci] [--include-paths]
56
- npx workspai workspace snapshot [--json]
57
- npx workspai workspace diff --from <snapshot-or-report|git[:ref]> [--json]
58
- npx workspai workspace impact --from <snapshot-or-report> [--scope project:<name>] [--json]
59
- npx workspai workspace verify [--from-impact <file>] [--scope project:<name>] [--strict] [--json]
60
- npx workspai workspace export --output team-workspace.workspai-archive.zip
61
- npx workspai workspace archive inspect team-workspace.workspai-archive.zip [--json]
62
- npx workspai workspace archive verify team-workspace.workspai-archive.zip [--strict] [--json]
63
- npx workspai workspace archive doctor team-workspace.workspai-archive.zip [--strict] [--json]
64
- npx workspai workspace hydrate team-workspace.workspai-archive.zip --output ./team-workspace
56
+ npx workspai workspace snapshot [--workspace <path>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>]
57
+ npx workspai workspace diff --from <snapshot-or-report|git[:ref]> [--workspace <path>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>] [--strict]
58
+ npx workspai workspace impact --from <workspace-diff-report> [--workspace <path>] [--scope project:<name>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>] [--strict]
59
+ npx workspai workspace verify [--from-impact <file>] [--workspace <path>] [--scope project:<name>] [--strict] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>]
60
+ npx workspai workspace graph [emit|explain|dot|mermaid] [key] [--workspace <path>] [--scope project:<name>] [--json] [--include-paths] [--include-evidence] [--scan-depth <count>]
61
+ npx workspai workspace watch [--workspace <path>] [--json] [--once] [--scan-depth <count>]
62
+ npx workspai workspace explain|why <target> [--workspace <path>] [--json] [--write]
63
+ npx workspai workspace trace --from <workspace-diff-report> [--workspace <path>] [--json] [--write]
64
+ npx workspai workspace feedback record [--workspace <path>] [--json]
65
+ npx workspai workspace mcp serve [--workspace <path>] [--json]
66
+ npx workspai workspace export --output team-workspace.workspai-archive.zip [--archive-compression store|deflate]
67
+ npx workspai workspace archive inspect team-workspace.workspai-archive.zip [--max-download-size <size>] [--max-expanded-size <size>] [--download-timeout-ms <ms>] [--json]
68
+ npx workspai workspace archive verify team-workspace.workspai-archive.zip [--max-download-size <size>] [--max-expanded-size <size>] [--download-timeout-ms <ms>] [--strict] [--json]
69
+ npx workspai workspace archive doctor team-workspace.workspai-archive.zip [--max-download-size <size>] [--max-expanded-size <size>] [--download-timeout-ms <ms>] [--strict] [--json]
70
+ npx workspai workspace hydrate team-workspace.workspai-archive.zip --output ./team-workspace [--max-download-size <size>] [--max-expanded-size <size>] [--download-timeout-ms <ms>]
65
71
  npx workspai import <path|git-url> [--workspace <path>] [--name <project-name>] [--git] [--json]
66
72
  npx workspai adopt [path] [--workspace <path>] [--name <project-name>] [--dry-run] [--json]
67
73
  npx workspai snapshot create [name] [--include-projects] [--reason <text>] [--json]
@@ -82,6 +88,12 @@ npx workspai infra status [--workspace <path>] [--json] [--strict]
82
88
 
83
89
  See [workspace-run.md](./workspace-run.md) for fleet orchestration semantics.
84
90
 
91
+ After cloning or moving an existing workspace, `workspace sync` repairs its
92
+ machine-local global registry entry before project discovery. For workspaces
93
+ that only have legacy `.rapidkit-workspace` metadata, run `workspace foundation
94
+ ensure` to add the canonical marker and foundation without deleting legacy
95
+ compatibility inputs.
96
+
85
97
  Workspace profile compatibility is enforced consistently across `create project`,
86
98
  `import`, `adopt`, and `bootstrap` compliance. In default `warn` policy mode,
87
99
  cross-runtime additions are allowed with a recommendation such as
@@ -9,13 +9,17 @@ Canonical map of **on-disk artifacts** produced by Workspai CLI commands. Dashbo
9
9
  | Workspace manifest | `.workspai/workspace.json` | `create workspace`, `foundation ensure`, `bootstrap` (profile) | Profile, engine, bootstrap metadata — **not** project list |
10
10
  | Workspace contract | `.workspai/workspace.contract.json` | `workspace sync`, `workspace contract *`, import/adopt | Operational project registry (ports, contracts) |
11
11
  | Registry summary | `.workspai/workspace-registry.v1.json` | `workspace sync`, contract sync, `registry status --refresh` | **Canonical** project count + authority for UI/CI |
12
- | Workspace marker | `.workspai-workspace` | `create workspace`, `foundation ensure` | Root detection |
12
+ | Workspace marker | `.workspai-workspace` | `create workspace`, `foundation ensure` | Portable root detection; commit with the workspace |
13
13
 
14
14
  Legacy `.rapidkit-workspace` and `.rapidkit/*` paths are read as fallback for
15
15
  older workspaces. New Workspai CLI writes target `.workspai-workspace` and
16
16
  `.workspai/*`. Workspace archive hydrate also normalizes legacy archive entries
17
17
  to canonical Workspai paths on restore.
18
18
 
19
+ The canonical `.workspai-workspace` marker must remain trackable. Generated
20
+ workspace `.gitignore` files exclude legacy/local engine state but do not
21
+ exclude the canonical marker.
22
+
19
23
  ## Naming conventions
20
24
 
21
25
  | Pattern | Meaning | Examples |
@@ -26,23 +30,23 @@ to canonical Workspai paths on restore.
26
30
 
27
31
  ## Governance evidence loop
28
32
 
29
- | Command | Primary artifact | Schema version | JSON Schema |
30
- | ------------------------ | --------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------ |
31
- | `doctor workspace` | `.workspai/reports/doctor-last-run.json` | `doctor-workspace-evidence-v1` | `contracts/doctor-workspace-evidence.v1.json` |
32
- | `doctor project` | `.workspai/reports/doctor-project-last-run.json` | `doctor-project-evidence-v1` | `contracts/doctor-project-evidence.v1.json` |
33
- | `doctor * --plan` | `.workspai/reports/doctor-remediation-plan-last-run.json` | `doctor-remediation-plan-v2` | `contracts/doctor-remediation-plan.v1.json` |
34
- | `doctor * --fix/--apply` | `.workspai/reports/doctor-fix-result-last-run.json` | `rapidkit-doctor-fix-result-v1` | `contracts/workspace-intelligence/doctor-fix-result.v1.json` |
35
- | `workspace remediation-plan --write` | `.workspai/reports/artifact-remediation-plan-last-run.json` | `artifact-remediation-plan-v1` | `contracts/artifact-remediation-plan.v1.json` |
36
- | `analyze` | `.workspai/reports/analyze-last-run.json` | `rapidkit-analyze-v1` | `contracts/analyze-last-run.v1.json` |
37
- | `readiness` | `.workspai/reports/release-readiness-last-run.json` | `release-readiness-v1` | `contracts/release-readiness.v1.json` |
38
- | `pipeline` | `.workspai/reports/pipeline-last-run.json` | `rapidkit-pipeline-v1` | `contracts/pipeline-last-run.v1.json` |
39
- | `autopilot release` | `.workspai/reports/autopilot-release-last-run.json` | `autopilot-release-v1` | |
40
- | | `.workspai/reports/autopilot-release.json` | (alias, same payload) | |
33
+ | Command | Primary artifact | Schema version | JSON Schema |
34
+ | ------------------------------------ | ----------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------ |
35
+ | `doctor workspace` | `.workspai/reports/doctor-last-run.json` | `doctor-workspace-evidence-v1` | `contracts/doctor-workspace-evidence.v1.json` |
36
+ | `doctor project` | `.workspai/reports/doctor-project-last-run.json` | `doctor-project-evidence-v1` | `contracts/doctor-project-evidence.v1.json` |
37
+ | `doctor * --plan` | `.workspai/reports/doctor-remediation-plan-last-run.json` | `doctor-remediation-plan-v2` | `contracts/doctor-remediation-plan.v2.json` |
38
+ | `doctor * --fix/--apply` | `.workspai/reports/doctor-fix-result-last-run.json` | `rapidkit-doctor-fix-result-v1` | `contracts/workspace-intelligence/doctor-fix-result.v1.json` |
39
+ | `workspace remediation-plan --write` | `.workspai/reports/artifact-remediation-plan-last-run.json` | `artifact-remediation-plan-v1` | `contracts/artifact-remediation-plan.v1.json` |
40
+ | `analyze` | `.workspai/reports/analyze-last-run.json` | `rapidkit-analyze-v1` | `contracts/analyze-last-run.v1.json` |
41
+ | `readiness` | `.workspai/reports/release-readiness-last-run.json` | `release-readiness-v1` | `contracts/release-readiness.v1.json` |
42
+ | `pipeline` | `.workspai/reports/pipeline-last-run.json` | `rapidkit-pipeline-v1` | `contracts/pipeline-last-run.v1.json` |
43
+ | `autopilot release` | `.workspai/reports/autopilot-release-last-run.json` | `autopilot-release-v1` | `contracts/autopilot-release.v1.json` |
44
+ | | `.workspai/reports/autopilot-release.json` | (alias, same payload) | `contracts/autopilot-release.v1.json` |
41
45
 
42
46
  Side/cache (not gates): `.workspai/reports/doctor-workspace-cache.json` (`doctor-workspace-cache-v2`).
43
47
 
44
48
  Doctor Studio handoff:
45
- `doctor-remediation-plan-v2` (`contracts/doctor-remediation-plan.v1.json`) is emitted in JSON
49
+ `doctor-remediation-plan-v2` (`contracts/doctor-remediation-plan.v2.json`) is emitted in JSON
46
50
  responses and persisted to `.workspai/reports/doctor-remediation-plan-last-run.json` by
47
51
  `doctor workspace|project --plan`, `--fix`, and `--apply` so IDEs can render approved commands,
48
52
  typed file edits, diff previews, ordered phases, step dependencies, rollback, and verification
@@ -71,16 +75,23 @@ the same evidence without losing the workspace source of truth.
71
75
  | Command | Artifact | Schema | Contract file |
72
76
  | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | ------------------------------------------------------------------------- |
73
77
  | `workspace model --write` | `workspace-model.json` | `workspace-model.v1` | `contracts/workspace-intelligence/workspace-model.v1.json` |
74
- | `workspace snapshot` | `workspace-model-snapshot.json` | `workspace-model-snapshot.v1` | `workspace-model-snapshot.v1.json` |
75
- | `workspace diff` | `workspace-model-diff-last-run.json` | `workspace-model-diff.v1` | `workspace-model-diff.v1.json` |
76
- | `workspace impact --from <diff>` | `workspace-impact-last-run.json` | `workspace-impact.v1` | `workspace-impact.v1.json` |
77
- | `workspace verify` | `workspace-verify-last-run.json` | `workspace-verify.v1` | `workspace-verify.v1.json` |
78
- | `workspace context --write` | `workspace-context-agent.json` | `workspace-context.v1` | `workspace-context.v1.json` |
79
- | `workspace agent-sync --write` | `reports/INDEX.json`, `reports/agent-customization-pack.json`, `reports/workspai-mcp-design.json`, `reports/workspace-skills-index.json`, `.workspai/skills/*.md`, `.workspai/AGENT-GROUNDING.md`, `AGENTS.md`, Copilot/Cursor/Claude/VS Code agent surfaces | `rapidkit-agent-customization-pack.v1` | `contracts/agent-customization-pack.v1.json` |
78
+ | `workspace snapshot` | `workspace-model-snapshot.json` | `workspace-model-snapshot.v1` | `contracts/workspace-intelligence/workspace-model-snapshot.v1.json` |
79
+ | `workspace diff` | `workspace-model-diff-last-run.json` | `workspace-model-diff.v1` | `contracts/workspace-intelligence/workspace-model-diff.v1.json` |
80
+ | `workspace impact --from <diff>` | `workspace-impact-last-run.json` | `workspace-impact.v1` | `contracts/workspace-intelligence/workspace-impact.v1.json` |
81
+ | `analyze --json` | `analyze-last-run.json` | `rapidkit-analyze-v1` | `contracts/analyze-last-run.v1.json` |
82
+ | `workspace verify` | `workspace-verify-last-run.json` | `workspace-verify.v1` | `contracts/workspace-intelligence/workspace-verify.v1.json` |
83
+ | `workspace context --write` | `workspace-context-agent.json` | `workspace-context.v1` | `contracts/workspace-intelligence/workspace-context.v1.json` |
84
+ | `workspace agent-sync --write` | `reports/agent-customization-pack.json` | `rapidkit-agent-customization-pack.v1` | `contracts/workspace-intelligence/agent-customization-pack-report.v1.json` |
85
+ | `workspace agent-sync --write` | `reports/INDEX.json` | `rapidkit-agent-reports-index.v1` | `contracts/workspace-intelligence/agent-reports-index.v1.json` |
86
+ | `workspace agent-sync --write` | `reports/workspace-skills-index.json` | `workspace-skills-index.v1` | `contracts/workspace-intelligence/workspace-skills-index.v1.json` |
87
+ | `workspace agent-sync --write` | `reports/workspai-mcp-design.json`, `.workspai/skills/*.md`, `.workspai/AGENT-GROUNDING.md`, `AGENTS.md`, IDE agent surfaces | Mixed generated surfaces | See customization pack output inventory |
80
88
  | `workspace explain --write` | `workspace-explain-last-run.json` | `workspace-explain.v1` | `contracts/workspace-intelligence/workspace-explain.v1.json` |
81
89
  | `workspace feedback record` / `doctor * --fix` | `workspace-intelligence-history.json` (`kind: agent-action`, `doctor-fix`) | `workspace-intelligence-history.v1` | `contracts/workspace-intelligence/workspace-intelligence-history.v1.json` |
82
90
 
83
91
  **CLI semantics:** `workspace diff --from` expects a **model or snapshot** baseline. `workspace impact --from` expects a **diff report**.
92
+ Persisted artifacts retain their artifact schema. JSON command projections that add operation metadata
93
+ such as `outputPath`, `status`, or structured errors use
94
+ `contracts/cli-operation-result.v1.json`; the canonical artifact is nested under `artifact`.
84
95
 
85
96
  ### Dependency graph (`workspace-dependency-graph.v1`)
86
97
 
@@ -240,25 +251,33 @@ Canonical source: `src/observability/run-correlation.ts` (`attachRunCorrelation`
240
251
 
241
252
  ## Operational / platform
242
253
 
243
- | Command | Artifact | Notes |
244
- | -------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------- |
245
- | `workspace run` | `workspace-run-last.json` | `workspace-run-v1` (multi-stage: `stages.test`, `stages.build`, …) | `contracts/workspace-run-last.v1.json` |
246
- | `autopilot release` (run stages) | same `workspace-run-last.json` | Autopilot publishes test/build into aggregate (no separate `autopilot-workspace-run-*.json`) | — |
247
- | `bootstrap` | `bootstrap-compliance-{ts}.json`, `bootstrap-compliance.latest.json` | |
248
- | `mirror status` | `mirror-ops-{ts}.json`, `mirror-ops.latest.json` | |
249
- | `mirror` (transparency) | `transparency-evidence-{ts}.json`, `transparency-evidence.latest.json` | |
250
- | `infra plan` | `infra-plan.json` | `rapidkit.infra-plan.v1` |
251
- | `workspace archive` | `archive-manifest.json` | Root `.workspai/`, handoff |
252
- | `workspace share` | `reports/share-bundle.json` (default) | Aggregation bundle |
253
- | `import` / `adopt` | `{project}/.workspai/import-readiness.json` | Per project |
254
- | `workspace contract verify` | `workspace-contract-verify-last-run.json` | CLI verify cache |
254
+ | Command | Artifact | Notes | Contract |
255
+ | -------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
256
+ | `workspace run` | `workspace-run-last.json` | `workspace-run-v1` (multi-stage: `stages.test`, `stages.build`, …) | `contracts/workspace-run-last.v1.json` |
257
+ | `autopilot release` (run stages) | same `workspace-run-last.json` | Autopilot publishes test/build into aggregate (no separate `autopilot-workspace-run-*.json`) | — |
258
+ | `bootstrap` | `bootstrap-compliance-{ts}.json`, `bootstrap-compliance.latest.json` | | — |
259
+ | `mirror status` | `mirror-ops-{ts}.json`, `mirror-ops.latest.json` | | — |
260
+ | `mirror` (transparency) | `transparency-evidence-{ts}.json`, `transparency-evidence.latest.json` | | — |
261
+ | `infra plan` | `infra-plan.json` | `rapidkit.infra-plan.v1` | — |
262
+ | `workspace archive` | `.workspai/archive-manifest.json` inside ZIP/ZIP64 | Streaming handoff; workspace payload is unlimited by default and safety budgets are opt-in | `contracts/workspace-archive-manifest.v1.json` |
263
+ | `workspace share` | `reports/share-bundle.json` (default) | Aggregation bundle | — |
264
+ | `import` / `adopt` | `{project}/.workspai/import-readiness.json` | Per project | — |
265
+ | `workspace contract verify` | `workspace-contract-verify-last-run.json` | CLI verify cache | `contracts/workspace-intelligence/workspace-contract-verify.v1.json` |
255
266
 
256
267
  ## Static capability contracts
257
268
 
258
- | Contract | Schema version | Consumer purpose |
259
- | ----------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------ |
260
- | `contracts/runtime-command-surface.v1.json` | `rapidkit-runtime-command-surface-v1` | Runtime commands, scaffold kits, and create planner summary |
261
- | `contracts/create-planner-capabilities.v1.json` | `rapidkit-create-planner-capabilities-v1` | Native create, external-create-adopt, and adopt-only lanes for CLI, CI, VS Code, and AI planners |
269
+ | Contract | Schema version | Consumer purpose |
270
+ | ------------------------------------------------------ | ------------------------------------------------ | ---------------------------------------------------------------------------------- |
271
+ | `contracts/runtime-command-surface.v1.json` | `rapidkit-runtime-command-surface-v1` | Runtime commands, scaffold kits, and create planner summary |
272
+ | `contracts/cli-operation-result.v1.json` | `workspai-cli-operation-result-v1` | Stable success/error envelope for JSON command projections |
273
+ | `contracts/command-capabilities.v1.json` | `rapidkit-command-capabilities-v1` | Effective command ownership and workspace command discovery |
274
+ | `contracts/version.v1.json` | `rapidkit-version-v1` | Version and published-contract discovery response |
275
+ | `contracts/published-contract-catalog.v1.json` | `workspai-published-contract-catalog-v1` | Schema versions plus resolvable contract paths |
276
+ | `contracts/project-entry-capability.v1.json` | `workspai-project-entry-capability-v1` | Open-ended adopt/import capability boundaries for readable projects |
277
+ | `contracts/create-planner-capabilities.v1.json` | `rapidkit-create-planner-capabilities-v1` | Native create, official, and existing lanes for CLI, CI, VS Code, and AI planners |
278
+ | `contracts/workspace-archive-capabilities.v1.json` | `workspai-workspace-archive-capabilities-v1` | ZIP64, streaming, compression, limits, commands, flags, and linked archive schemas |
279
+ | `contracts/workspace-archive-manifest.v1.json` | `workspai-workspace-archive-manifest-v1` | Runtime-validated archive manifest, file inventory, checksums, and security policy |
280
+ | `contracts/workspace-archive-operation-result.v1.json` | `workspai-workspace-archive-operation-result-v1` | Stable JSON results for export, inspect, verify, doctor, hydrate, and failures |
262
281
 
263
282
  ## Observability stream (not on-disk)
264
283
 
@@ -280,6 +299,11 @@ events go to stderr (`--log-format json`). The two never mix.
280
299
  | `workspace sync [--json]` | Updates contract + `workspace-registry.v1.json`; JSON includes `registrySummary` |
281
300
  | `workspace registry status [--refresh] [--json]` | Reads or publishes registry summary |
282
301
 
302
+ `workspace-registry.v1.json`, adoption records, and verification reports can
303
+ contain machine-local absolute paths. Regenerate them after cloning; do not use
304
+ them as portable repository contracts. The portable source is
305
+ `.workspai/workspace.contract.json` plus canonical workspace/project metadata.
306
+
283
307
  ## Project-scoped reports
284
308
 
285
309
  Under `{project}/.workspai/reports/` when commands run at project scope (e.g. project doctor). Workspace-level reports stay under `{workspace}/.workspai/reports/`.
@@ -36,11 +36,12 @@ Published under `../../contracts/` (not duplicated in this folder):
36
36
  - `release-readiness.v1.json` — release readiness gate evidence
37
37
  - `workspace-run-last.v1.json` — multi-stage workspace run evidence
38
38
  - `doctor-workspace-evidence.v1.json` / `doctor-project-evidence.v1.json` — doctor evidence
39
- - `doctor-remediation-plan.v1.json` — persisted Doctor fix/plan Studio handoff contract
39
+ - `doctor-remediation-plan.v2.json` — canonical persisted Doctor fix/plan Studio handoff contract (`v1` path is a deprecated compatibility alias)
40
40
  - `artifact-remediation-plan.v1.json` — cross-artifact Studio handoff for Bootstrap, Analyze, Readiness, Pipeline, Workspace Run, Workspace Verify, and Doctor plan bridging
41
41
  - `analyze-last-run.v1.json` — analyze evidence
42
42
  - `pipeline-last-run.v1.json` — governance pipeline orchestration
43
- - `create-planner-capabilities.v1.json` — native-create, external-create-adopt, and adopt-only capability lanes
43
+ - `project-entry-capability.v1.json` — open-ended adopt/import contract for readable projects
44
+ - `create-planner-capabilities.v1.json` — native, official, and existing capability lanes
44
45
  - `agent-customization-pack.v1.json` — generated instructions, prompts, skills, agents, optional hooks, MCP-ready design metadata, target matrix, and drift state for AI agent surfaces
45
46
 
46
47
  Workspace intelligence (`../../contracts/workspace-intelligence/`):