rapidkit 0.30.0 → 0.32.0

package/README.md

@@ -2,8 +2,8 @@
 
 > RapidKit is an open-source workspace platform that standardizes how teams build, scale, and deploy backend services.
 
-Production-ready scaffolding for FastAPI, NestJS, Spring Boot, Go/Fiber, and Go/Gin.  
-**27+ plug-and-play modules** are available for FastAPI and NestJS projects. Spring Boot and Go kits run as npm-level generators.  
+Production-ready scaffolding for FastAPI, NestJS, Spring Boot, Go/Fiber, Go/Gin, and ASP.NET Core.  
+**50+ RapidKit Core modules** are available through the CLI for supported module-capable runtimes, with FastAPI and NestJS as first-class module installation targets. Spring Boot, Go, and ASP.NET Core kits run as npm-level generators.
 Built for clean architecture, minimal boilerplate, and fast deployment.
 
 > **💡 Recommended:** Install the [Workspai VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode) for AI-assisted project creation, workspace exploration, and context-aware coding — all backed by this CLI.
@@ -17,7 +17,7 @@ Built for clean architecture, minimal boilerplate, and fast deployment.
 The official RapidKit npm CLI for creating and operating workspaces and projects.
 
 - Workspace-first lifecycle (`create workspace` → `bootstrap` → `setup` → `create project`)
-- Multi-runtime support across Python, Node.js, Java, and Go
+- Multi-runtime support across Python, Node.js, Java, Go, and .NET
 - Policy enforcement with `warn` / `strict` modes
 - Cache and mirror lifecycle commands for stable environments
 
@@ -51,6 +51,7 @@ It works alongside Workspai, a product developed by RapidKit.
 - Python `>= 3.10` (for Python/Core workflows)
 - Java 21+ and Maven 3.9+ (optional, for Spring Boot projects)
 - Go (optional, for Go projects)
+- .NET SDK 8+ (optional, for ASP.NET Core projects)
 
 ## Install
 
@@ -109,6 +110,7 @@ npx rapidkit setup python
 npx rapidkit setup node --warm-deps
 npx rapidkit setup java --warm-deps
 npx rapidkit setup go --warm-deps
+npx rapidkit setup dotnet --warm-deps
 ```
 
 ### 3) Create projects
@@ -120,6 +122,8 @@ npx rapidkit create project fastapi.ddd my-api --yes --skip-install
 npx rapidkit create project nestjs.standard my-nest --yes --skip-install
 npx rapidkit create project springboot.standard my-spring --yes --skip-install
 npx rapidkit create project gofiber.standard my-fiber --yes --skip-install
+npx rapidkit create project gogin.standard my-gin --yes --skip-install
+npx rapidkit create project dotnet.webapi.clean my-dotnet --yes --skip-install
 ```
 
 ## Core Commands
@@ -130,7 +134,7 @@ npx rapidkit create project gofiber.standard my-fiber --yes --skip-install
 npx rapidkit create # Prompts: workspace | project
 npx rapidkit create workspace <name> [--profile <profile>] [--author <name>] [--yes]
 npx rapidkit bootstrap [--profile <profile>] [--json]
-npx rapidkit setup <python|node|go|java> [--warm-deps]
+npx rapidkit setup <python|node|go|java|dotnet> [--warm-deps]
 npx rapidkit analyze [--workspace <path>] [--json] [--strict] [--output <file>]
 npx rapidkit readiness [--json] [--strict]
 npx rapidkit autopilot release [--mode <audit|safe-fix|enforce>] [--json] [--output <file>] [--since <ref>] [--parallel] [--max-workers <n>]
@@ -146,6 +150,15 @@ npx rapidkit doctor workspace [--fix] [--plan] [--apply]
 npx rapidkit doctor project [--fix] [--plan] [--apply]
 npx rapidkit workspace list # Display all workspaces created on this system
 npx rapidkit workspace share [--output <file>] [--include-paths] [--no-doctor]
+npx rapidkit workspace contract init [--force] [--json]
+npx rapidkit workspace contract inspect [--json]
+npx rapidkit workspace contract verify [--strict] [--json]
+npx rapidkit workspace contract graph [--json]
+npx rapidkit workspace export --output team-workspace.rapidkit-archive.zip
+npx rapidkit workspace archive inspect team-workspace.rapidkit-archive.zip [--json]
+npx rapidkit workspace archive verify team-workspace.rapidkit-archive.zip [--strict] [--json]
+npx rapidkit workspace archive doctor team-workspace.rapidkit-archive.zip [--strict] [--json]
+npx rapidkit workspace hydrate team-workspace.rapidkit-archive.zip --output ./team-workspace
 npx rapidkit import <path|git-url> [--workspace <path>] [--name <project-name>] [--git] [--json]
 npx rapidkit snapshot create [name] [--include-projects] [--reason <text>] [--json]
 npx rapidkit snapshot list [--json]
@@ -190,7 +203,12 @@ JSON output (`--json`) includes:
 - `workspaceResolution` (`explicit` | `nearest` | `default-auto`)
 - `defaultWorkspaceCreated`
 - `suggestedCdCommand`
-- `importedProject` (`name`, `path`, `stack`, `confidence`, `source`)
+- `importedProject` (`name`, `path`, `stack`, `runtime`, `framework`, `supportTier`, `moduleSupport`, `confidence`, `source`)
+
+Imported projects also receive `.rapidkit/import-readiness.json`, which records framework detection,
+runtime command support, and module mutation policy. Existing projects from Laravel, Rails, Rust,
+Elixir, Kotlin, Deno, Bun, and other ecosystems are importable/governed even when RapidKit does not
+yet ship a first-class scaffold for that stack.
 
 ### Workspace snapshots and safe project operations
 
@@ -248,6 +266,53 @@ Bundle content includes:
 
 `--include-paths` is intended for internal teams only because it includes absolute filesystem paths.
 
+### Workspace contract registry
+
+Use `workspace contract` when multiple projects in one workspace need a shared source of truth for
+services, ports, APIs, events, owners, dependencies, and required environment variables.
+
+```bash
+npx rapidkit workspace contract init
+npx rapidkit workspace contract inspect
+npx rapidkit workspace contract verify --strict
+npx rapidkit workspace contract graph
+```
+
+The contract is written to `.rapidkit/workspace.contract.json`. It starts from discovered RapidKit
+projects and gives teams a stable place to declare cross-project service contracts. Verification
+checks schema validity, duplicate project slugs, invalid or colliding ports, and dependencies that
+point to unknown projects.
+
+RapidKit keeps this contract alive during normal workspace work:
+
+- `create project` syncs the contract after successful project creation inside a workspace.
+- `workspace sync` reconciles discovered projects into the contract without overwriting manually declared APIs, events, owners, dependencies, env vars, or custom ports.
+- New projects receive a framework-aware default HTTP port when possible, and the next free port is selected if the default is already claimed.
+- `workspace share` includes the contract snapshot so teammates can inspect service topology before reproducing or importing the workspace.
+- `workspace contract graph` renders the service/dependency/event topology for humans or returns a JSON graph for tools and UI surfaces.
+
+### Portable workspace archives
+
+Use `workspace export` when you need to send a full workspace to a teammate or move it to another machine.
+Export excludes dependency folders, build output, git history, logs, `.env` files, and private keys by default.
+
+```bash
+npx rapidkit workspace export --output team-workspace.rapidkit-archive.zip
+npx rapidkit workspace archive inspect team-workspace.rapidkit-archive.zip
+npx rapidkit workspace archive verify team-workspace.rapidkit-archive.zip --strict
+npx rapidkit workspace archive doctor team-workspace.rapidkit-archive.zip
+npx rapidkit workspace hydrate team-workspace.rapidkit-archive.zip --output ./team-workspace
+
+# Preview a hydrate without writing files
+npx rapidkit workspace hydrate team-workspace.rapidkit-archive.zip --output ./team-workspace --dry-run
+```
+
+Archives include a RapidKit/Workspai manifest with file sizes and SHA-256 checksums. `workspace hydrate`
+verifies the archive before writing files. Use `workspace archive verify --strict` as a handoff or CI gate,
+and `workspace archive doctor` when you want human-readable readiness/security guidance before a teammate
+imports the workspace. Use `--include-env` only for trusted internal handoffs when you intentionally need
+environment files inside the archive.
+
 ### Command ownership
 
 RapidKit keeps the wrapper boundary explicit so users know which layer owns each action.
@@ -338,6 +403,8 @@ Compatibility policy for automation consumers:
 
 ```bash
 npx rapidkit create project <kit> <name> [--yes] [--skip-install]
+npx rapidkit project commands [--json]
+npx rapidkit commands --scope project [--json]
 npx rapidkit init
 npx rapidkit dev
 npx rapidkit test
@@ -345,6 +412,13 @@ npx rapidkit build
 npx rapidkit start
 ```
 
+`project commands` shows the effective command contract for the current project. Core-backed
+FastAPI/NestJS projects can use module commands such as `add` and `modules`. npm-backed Go, Spring
+Boot, and ASP.NET Core projects use runtime lifecycle commands and workspace governance while Core
+module mutation remains disabled. Imported observed projects are safe to inspect, share, and govern;
+they expose help-level lifecycle support until a runtime adapter or project-local command mapping is
+available.
+
 ### Operations
 
 ```bash
@@ -476,13 +550,17 @@ npx rapidkit workspace run test --parallel
 # Test only affected projects since last commit
 npx rapidkit workspace run test --affected --since HEAD~1
 
-# Test affected + their dependents (requires dependency graph)
+# Test affected + downstream dependents from workspace.contract.json
 npx rapidkit workspace run test --affected --blast-radius
 
 # Build specific projects with custom stages (if defined in .rapidkit/context.json)
 npx rapidkit workspace run build --json --max-workers 8
 ```
 
+`--blast-radius` uses `.rapidkit/workspace.contract.json` when available. It expands direct
+`dependsOn` relationships and event relationships where one project `publishes` an event and another
+project `consumes` it. Legacy `.rapidkit/workspace-dependency-graph.json` remains supported as a fallback.
+
 ### Supported Runtimes & Frameworks
 
 | Runtime    | Frameworks                     | Status   |
@@ -491,11 +569,14 @@ npx rapidkit workspace run build --json --max-workers 8
 | **Go**     | Fiber, Gin, Echo, Chi          | Built-in |
 | **Java**   | Spring Boot, Quarkus, Gradle   | Built-in |
 | **Python** | FastAPI, Django, Flask, Poetry | Built-in |
-| **PHP**    | Laravel, Symfony, Slim         | Stable   |
-| **Rust**   | Actix, Axum, Rocket, Tokio     | Stable   |
-| **.NET**   | ASP.NET Core, Entity Framework | Stable   |
-| **Elixir** | Phoenix, Umbrella Projects     | Stable   |
-| **Ruby**   | Rails, Sinatra, RSpec          | Stable   |
+| **PHP**    | Laravel, Symfony, Slim         | Observed |
+| **Rust**   | Actix, Axum, Rocket, Tokio     | Observed |
+| **.NET**   | ASP.NET Core, Entity Framework | Built-in |
+| **Elixir** | Phoenix, Umbrella Projects     | Observed |
+| **Ruby**   | Rails, Sinatra, RSpec          | Observed |
+
+For the public scaffold/import/lifecycle/module support contract, see
+[docs/contracts/RUNTIME_SUPPORT_MATRIX.md](docs/contracts/RUNTIME_SUPPORT_MATRIX.md).
 
 ### Enterprise Features