rapidkit 0.37.0 → 0.38.0

package/docs/DEVELOPMENT.md

@@ -0,0 +1,88 @@
+# Development Guide
+
+Maintainer reference for the RapidKit npm CLI (Node/TypeScript bridge to Python Core).
+
+**End users:** [../README.md](../README.md) · [README.md](./README.md) · [OPEN_SOURCE_USER_SCENARIOS.md](./OPEN_SOURCE_USER_SCENARIOS.md)
+
+## Prerequisites
+
+- Node.js `>= 20`
+- npm — see [PACKAGE_MANAGER_POLICY.md](./PACKAGE_MANAGER_POLICY.md)
+
+```bash
+npm ci
+npm run build
+```
+
+## Quality checks
+
+```bash
+npm run validate
+npm run validate:contracts
+npm run test:drift
+```
+
+Focused suites: [ci-workflows.md](./ci-workflows.md) · [SETUP.md](./SETUP.md)
+
+## Configuration
+
+User defaults: [config-file-guide.md](./config-file-guide.md) (`$HOME/.rapidkitrc.json`, `rapidkit.config.*`).
+
+Priority: CLI flags > environment variables > config file > defaults.
+
+### Test mode (local Core)
+
+```bash
+export RAPIDKIT_DEV_PATH=/path/to/local/rapidkit-core
+npx rapidkit my-workspace --test-mode
+```
+
+## CLI workflows
+
+```bash
+# Direct project creation
+npx rapidkit create project fastapi.standard my-api --output .
+npx rapidkit create frontend nextjs my-web --yes
+
+# Workspace mode
+npx rapidkit create workspace my-workspace --yes --profile polyglot
+cd my-workspace
+npx rapidkit bootstrap --profile polyglot
+npx rapidkit create project
+```
+
+Full syntax: [commands-reference.md](./commands-reference.md)
+
+## Testing
+
+```bash
+npm test
+npm run test:e2e
+npm run test:scenarios:full
+npm run test:runtime-matrix:full
+```
+
+## Manual smoke
+
+```bash
+npm run build
+node dist/index.js --help
+node dist/index.js create project fastapi.standard test-fastapi --output . --yes --skip-install
+```
+
+## Debugging
+
+```bash
+npx rapidkit my-workspace --debug
+```
+
+## Environment variables
+
+See [SETUP.md](./SETUP.md#environment-variables) for bridge, scenario, and cache variables.
+
+## See also
+
+- [Documentation index](./README.md)
+- [contracts/README.md](./contracts/README.md)
+- [OPTIMIZATION_GUIDE.md](./OPTIMIZATION_GUIDE.md)
+- [UTILITIES.md](./UTILITIES.md)

package/docs/OPEN_SOURCE_USER_SCENARIOS.md

@@ -0,0 +1,170 @@
+# RapidKit Practical User Scenarios (Open Source Edition)
+
+Practical workflows for OSS teams using the npm CLI. Command syntax: [commands-reference.md](./commands-reference.md). Import/adopt details: [workspace-operations.md](./workspace-operations.md).
+
+## Scenario 0 — Existing project (adopt or import)
+
+Goal: connect code you already have without reshuffling repositories.
+
+### Adopt in place (keep source where it is)
+
+```bash
+npx rapidkit adopt /path/to/existing-app --workspace /path/to/workspace --json
+npx rapidkit workspace model --json
+npx rapidkit doctor project --json
+```
+
+Works for Next.js, Vite, NestJS, FastAPI, Go, Spring Boot, and other detected stacks. See [workspace-operations.md#import-and-adoption](./workspace-operations.md#import-and-adoption).
+
+### Import (copy or clone into workspace)
+
+```bash
+npx rapidkit import ../orders-api --workspace ./platform
+npx rapidkit import https://github.com/acme/orders-api.git --git --workspace ./platform
+```
+
+### New frontend in workspace
+
+```bash
+cd my-workspace
+npx rapidkit create frontend nextjs marketing-web --yes
+```
+
+## What changed from the old flow?
+
+Old flow (typical):
+- Create workspace/project
+- Run `init` / `dev`
+- Minimal governance and supply-chain controls
+
+Current flow (new baseline):
+- Same developer-friendly start
+- Plus optional mirror/offline controls, checksum/attestation verification, Sigstore governance, and auditable reports
+- Works for both small teams and enterprise adoption paths
+
+## Scenario 1 — Junior Developer
+
+Goal: get productive quickly with minimal complexity.
+
+### Steps
+
+```bash
+npx rapidkit my-workspace
+cd my-workspace
+npx rapidkit bootstrap --profile polyglot
+npx rapidkit setup python
+npx rapidkit setup node --warm-deps
+npx rapidkit create project fastapi.standard api --output .
+cd api
+npx rapidkit init
+npx rapidkit dev
+```
+
+### When manual vs automatic?
+
+- Manual: run commands directly in local dev.
+- Automatic: not required at this level.
+
+## Scenario 2 — Mid-level Developer / Team
+
+Goal: improve stability and repeatability using mirror artifacts.
+
+### Steps
+
+1) Define minimal mirror config (`.rapidkit/mirror-config.json`) with artifact sources and checksums.
+2) Run:
+
+```bash
+cd my-workspace
+npx rapidkit doctor workspace
+npx rapidkit workspace list
+npx rapidkit mirror status
+npx rapidkit cache status
+npx rapidkit mirror sync
+npx rapidkit mirror verify
+npx rapidkit init
+npx rapidkit dev
+```
+
+### When manual vs automatic?
+
+- Manual: initial mirror setup and local validation.
+- Automatic: in CI pipelines, run `mirror sync/verify` before build/test.
+
+## Scenario 3 — Senior Developer / Platform Engineer
+
+Goal: enforce stronger security controls (attestation + Sigstore governance) in stage/prod-like environments.
+
+### Steps
+
+1) Configure `mirror-config.json` with:
+- `security.requireAttestation: true`
+- `security.requireSigstore: true`
+- `security.requireTransparencyLog: true`
+- environment policy allowlists (`identity`, `issuer`, `rekorUrl`)
+
+2) Run:
+
+```bash
+RAPIDKIT_ENV=stage npx rapidkit mirror sync --json
+RAPIDKIT_ENV=stage npx rapidkit mirror verify --json
+npx rapidkit bootstrap --profile=enterprise --ci --offline --json
+```
+
+### When manual vs automatic?
+
+- Manual: initial policy authoring and first dry run.
+- Automatic: fully automated in CI/CD after policy is validated.
+
+## Scenario 4 — Enterprise Operator / SecOps
+
+Goal: enforce signed governance policy bundle, generate and export audit evidence.
+
+### Steps
+
+1) Add signed governance bundle:
+- `.rapidkit/governance-policy.json`
+- `.rapidkit/governance-policy.sig`
+- `.rapidkit/governance-public.pem`
+
+2) Configure in `mirror-config.json`:
+- `security.requireSignedGovernance: true`
+- `security.governanceBundle: { ... }`
+- `security.evidenceExport: { target: "file" | "http", ... }`
+
+3) Run:
+
+```bash
+RAPIDKIT_ENV=prod npx rapidkit mirror sync --json
+RAPIDKIT_ENV=prod npx rapidkit mirror verify --json
+RAPIDKIT_ENV=prod npx rapidkit bootstrap --profile=enterprise --ci --offline --json
+```
+
+### When manual vs automatic?
+
+- Manual: key management, policy signing, endpoint provisioning.
+- Automatic: all command execution in CI/CD and release pipelines.
+
+## Operational outputs (for automation and auditing)
+
+Generated reports:
+- `.rapidkit/reports/bootstrap-compliance.latest.json`
+- `.rapidkit/reports/mirror-ops.latest.json`
+- `.rapidkit/reports/transparency-evidence.latest.json`
+
+Optional exported evidence sinks:
+- file sink (NDJSON/JSON append strategy)
+- HTTP webhook sink (SIEM/GRC intake)
+
+## Practical recommendation
+
+- Individuals/small teams: start with Scenario 0 → 1 → 2.
+- Product teams/platform teams: adopt Scenario 3.
+- Regulated/high-compliance environments: run Scenario 4 by default.
+
+## See also
+
+- [Documentation index](./README.md)
+- [workspace-operations.md](./workspace-operations.md)
+- [doctor-command.md](./doctor-command.md)
+- [ci-workflows.md](./ci-workflows.md) (`pipeline --json --strict`)