sdtk-design-kit 0.3.0 → 0.3.2

package/README.md

@@ -1,160 +1,102 @@
-# SDTK-DESIGN Kit
+# sdtk-design-kit
 
-`sdtk-design-kit` is the standalone SDTK-DESIGN Foundation Beta package.
+`sdtk-design-kit` is the public CLI package for SDTK-DESIGN.
 
-SDTK-DESIGN is a local-first MVP design planner and reviewer for solo founders. It turns a rough MVP idea into reviewable design artifacts and a deterministic handoff for SDTK-CODE.
+Package version in this source snapshot: `0.3.1`
+CLI command: `sdtk-design`
 
-It is not a Figma clone, Lovable clone, v0 clone, full app builder, or production code generator.
+SDTK-DESIGN is a local-first MVP design planner and reviewer. It turns either a rough MVP idea or explicit SDTK-SPEC design artifacts into reviewable design docs, a static prototype, visual review evidence, and an SDTK-CODE handoff.
 
-## Beginner Flow
+It is not a Figma clone, Lovable clone, v0 clone, full app builder, production code generator, or network service.
 
-Use this optimized flow for a clean project:
+## Install
 
-```powershell
+```bash
+npm install -g sdtk-design-kit
+sdtk-design --version
+sdtk-design --help
+```
+
+## Beginner Idea Flow
+
+```bash
 sdtk-design init
-sdtk-design start --idea "I want to build a lightweight CRM for solo consultants to track leads, follow-ups, notes, and simple revenue pipeline without using a complex enterprise CRM." --style premium-dashboard
+sdtk-design start --idea "I want to build a lightweight CRM for solo consultants to track leads." --style premium-dashboard
 sdtk-design prototype
 sdtk-design review --artifact docs/design/prototype/index.html
 sdtk-design handoff
 sdtk-design status
 ```
 
-What each command does:
-
-- `init`: creates the local design workspace.
-- `start`: creates the design brief, screen map, required wireframes, and design system.
-- `prototype`: creates a static visual preview from the generated design artifacts.
-- `review`: reviews a local markdown or static HTML design artifact with visual polish checks.
-- `handoff`: converts the generated design package into SDTK-CODE handoff guidance.
-- `status`: reports complete artifacts, missing artifacts, and the next recommended command.
+## SPEC-Driven Multi-Screen Flow
 
-## Available Commands
+Use this when SDTK-SPEC or an agent has produced explicit screen/design artifacts.
 
-```powershell
-sdtk-design --help
-sdtk-design --version
-sdtk-design init [--project-path <path>] [--force] [--no-state]
-sdtk-design start --idea "<idea>" [--style <preset>] [--project-path <path>] [--force]
-sdtk-design brief --idea "<idea>" [--project-path <path>] [--force]
-sdtk-design screens [--project-path <path>] [--force]
-sdtk-design wireframe --screen landing [--project-path <path>] [--force]
-sdtk-design wireframe --screen all [--project-path <path>] [--force]
-sdtk-design system [--style <preset>] [--project-path <path>] [--force]
-sdtk-design prototype [--style <preset>] [--project-path <path>] [--force]
-sdtk-design review --artifact docs/design/wireframes/LANDING.md [--project-path <path>] [--force]
-sdtk-design review --artifact docs/design/prototype/index.html [--project-path <path>] [--force]
-sdtk-design handoff [--project-path <path>] [--force]
-sdtk-design status [--project-path <path>]
+```bash
+sdtk-design init
+sdtk-design start --from-spec . --profile b2b-commerce
+sdtk-design prototype --force
+sdtk-design review --artifact docs/design/prototype/index.html
+sdtk-design handoff
+sdtk-design status
 ```
 
-## Generated Artifacts
+Optional read-only reference export mapping:
 
-Human-facing output is written under `docs/design/`:
-
-```text
-docs/design/
-  README.md
-  DESIGN_BRIEF.md
-  SCREEN_MAP.md
-  DESIGN_SYSTEM.md
-  DESIGN_HANDOFF.md
-  prototype/
-    index.html
-  wireframes/
-    LANDING.md
-    ONBOARDING.md
-    DASHBOARD.md
-  reviews/
-    DESIGN_REVIEW_YYYYMMDD.md
+```bash
+sdtk-design start --from-spec . --reference-dir ./docs/design/reference-export --profile b2b-commerce
 ```
 
-Internal state may live under `.sdtk/design/`. SDTK-DESIGN must not create or mutate `.sdtk/atlas`.
-
-## Visual Style Presets
-
-`start` and `system` accept `--style <preset>`. If omitted, SDTK-DESIGN uses `minimal-saas`.
-
-Available presets:
-
-- `minimal-saas`: clean solo-founder SaaS default.
-- `premium-dashboard`: dashboard-first MVP with stronger metrics, cards, and status surfaces.
-- `bold-founder`: high-contrast launch style for marketing-heavy MVPs.
-- `warm-editorial`: softer consultant/service-product style.
+`start --from-spec` consumes explicit design artifacts. It does not parse raw requirement prose or invent missing screens.
 
-## Command Details
-
-### `init`
-
-Creates `docs/design/`, `docs/design/wireframes/`, `docs/design/reviews/`, `docs/design/README.md`, and `.sdtk/design/manifest.json`.
-
-Existing managed init files are skipped by default. Use `--force` only when you explicitly want to refresh managed init files. Use `--no-state` to skip `.sdtk/design`.
-
-### `start`
-
-Runs:
+## Commands
 
 ```text
-brief -> screens -> wireframe --screen all -> system
-```
-
-This is the beginner facade for the core design package. It does not run review or handoff. Existing managed core outputs are not overwritten unless `--force` is explicit.
-
-Use `--style premium-dashboard` for dashboard-led MVPs such as ClientPulse.
-
-### `prototype`
-
-Creates a static visual preview at `docs/design/prototype/index.html`.
-
-```powershell
-sdtk-design prototype --style premium-dashboard
-```
-
-The prototype includes landing, onboarding, and dashboard sections with responsive CSS, selected visual preset tokens, and domain copy derived from the generated design artifacts. It is not production app code and does not create files outside `docs/design/prototype`.
-
-### `review`
-
-Reviews a local markdown or static HTML artifact. For the optimized workflow, review the generated prototype:
-
-```powershell
+sdtk-design init
+sdtk-design start --idea "<idea>" --style premium-dashboard
+sdtk-design start --from-spec . --reference-dir ./docs/design/reference-export --profile b2b-commerce
+sdtk-design brief --idea "<idea>"
+sdtk-design screens
+sdtk-design wireframe --screen landing
+sdtk-design system --style minimal-saas
+sdtk-design prototype
 sdtk-design review --artifact docs/design/prototype/index.html
+sdtk-design handoff
+sdtk-design status
 ```
 
-Markdown artifact review remains supported:
+Visual style presets:
 
-```powershell
-sdtk-design review --artifact docs/design/wireframes/LANDING.md
+```text
+minimal-saas
+premium-dashboard
+bold-founder
+warm-editorial
 ```
 
-The review report is written to `docs/design/reviews/DESIGN_REVIEW_YYYYMMDD.md`.
-
-Current review support is local artifact review only. The report includes visual polish checks for hierarchy, spacing/density, CTA clarity, dashboard information density, responsive/mobile risk, accessibility baseline, and anti-wireframe/mockup risk. No URL, browser, screenshot, vision, or DOM review is implemented in Foundation Beta.
-
-### `handoff`
-
-Reads the generated brief, screen map, required wireframes, and design system, then writes `docs/design/DESIGN_HANDOFF.md`.
+## Outputs
 
-The handoff is planning input for SDTK-CODE. It includes screen-to-component mapping, screen-to-user-story mapping, design decisions, implementation notes, suggested data model, domain/status taxonomy, interaction flow, persistence guidance, visual implementation contract, prototype reference, SDTK-CODE build notes, acceptance criteria, and a readiness verdict. Domain-specific examples are derived from the generated artifacts rather than fixed to one demo product. It does not generate production app code.
+Human-facing artifacts are written under `docs/design/`, including:
 
-### `status`
-
-Read-only command. It reports complete artifacts, missing artifacts, and the next recommended command.
-
-The optimized readiness path expects `docs/design/prototype/index.html` before prototype review and handoff.
-
-## Non-Goals And Deferred Features
+```text
+DESIGN_BRIEF.md
+SCREEN_MAP.md
+DESIGN_SYSTEM.md
+DESIGN_HANDOFF.md
+prototype/index.html
+reviews/DESIGN_REVIEW_YYYYMMDD.md
+wireframes/
+```
 
-Foundation Beta does not provide:
+SPEC-driven/high-fidelity flows may also create per-screen briefs, component contracts, visual token contracts, reference maps, fidelity reviews, and internal state under `.sdtk/design/`.
 
-- Figma, Lovable, v0, or full app-builder replacement behavior.
-- Production app code generation.
-- URL, browser, screenshot, vision, or DOM review.
-- Network calls by default.
-- Pro entitlement gates.
-- `.sdtk/atlas` creation or mutation.
-- SDTK-WIKI output mutation.
-- Landing-site updates.
-- npm publish or maintainer packaging checks without separate maintainer approval.
+## Boundaries
 
-## SDTK-CODE Handoff
+- no production app code generation
+- no URL/browser/screenshot/vision review in the CLI
+- no network calls by default
+- no `.sdtk/atlas` creation or mutation
+- no SDTK-WIKI output mutation
+- no overwrite unless a command explicitly supports `--force`
 
-After `sdtk-design handoff`, pass `docs/design/DESIGN_HANDOFF.md` to SDTK-CODE as implementation planning input. SDTK-CODE should still plan, implement, and verify code changes separately.
+See `products/sdtk-design/governance/SDTK_DESIGN_USAGE_GUIDE.md` for the full usage guide.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdtk-design-kit",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Local-first MVP design planner and reviewer for SDTK workspaces.",
   "bin": {
     "sdtk-design": "bin/sdtk-design.js"