@hegemonart/get-design-done 1.59.5 → 1.59.7

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 CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  **English** · [简体中文](docs/i18n/README.zh-CN.md) · [日本語](docs/i18n/README.ja.md) · [한국어](docs/i18n/README.ko.md) · [Français](docs/i18n/README.fr.md) · [Italiano](docs/i18n/README.it.md) · [Deutsch](docs/i18n/README.de.md)
6
6
 
7
- **A design-quality pipeline for AI coding agents: brief explore plan design verify.**
7
+ **A design-quality pipeline for AI coding agents: brief -> explore -> plan -> design -> verify.**
8
8
 
9
- **Get Design Done keeps AI-generated UI tied to your brief, your design system, your references, and your quality gates. Works with Claude Code, OpenCode, Gemini CLI, Kilo, Codex, Copilot, Cursor, Windsurf, Antigravity, Augment, Trae, Qwen Code, CodeBuddy, and Cline.**
9
+ **Get Design Done keeps AI-generated UI tied to your brief, your design system, your local design knowledge, and your quality gates. Built for Claude Code, and installs across Codex, Cursor, Gemini, OpenCode, Copilot, Windsurf, and more.**
10
10
 
11
11
  [![npm version](https://img.shields.io/npm/v/@hegemonart/get-design-done?style=for-the-badge&logo=npm&logoColor=white&color=CB3837)](https://www.npmjs.com/package/@hegemonart/get-design-done)
12
12
  [![npm downloads](https://img.shields.io/npm/dm/@hegemonart/get-design-done?style=for-the-badge&logo=npm&logoColor=white&color=CB3837)](https://www.npmjs.com/package/@hegemonart/get-design-done)
@@ -15,538 +15,313 @@
15
15
  [![Node](https://img.shields.io/badge/node-22%20%7C%2024-339933?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/)
16
16
  [![License](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](LICENSE)
17
17
 
18
- <br>
19
-
20
18
  ```bash
21
19
  npx @hegemonart/get-design-done@latest
22
20
  ```
23
21
 
24
22
  **Works on macOS, Linux, and Windows.**
25
23
 
26
- <br>
27
-
28
- *"AI coding agents ship UI fast. Get Design Done makes sure it ships as design."*
29
-
30
- <br>
31
-
32
- [Why I Built This](#why-i-built-this) · [How It Works](#how-it-works) · [Commands](#commands) · [Connections](#connections) · [Why It Works](#why-it-works)
24
+ [Install](#install) · [Quickstart](#quickstart) · [Use Cases](#use-cases) · [How It Works](#how-it-works) · [Commands](#commands) · [Connections](#connections) · [Safety](#safety-and-privacy)
33
25
 
34
26
  </div>
35
27
 
36
28
  ---
37
29
 
38
- > [!IMPORTANT]
39
- > ### Already have a Claude Design bundle?
40
- >
41
- > If you exported a design from [claude.ai/design](https://claude.ai/design), you can skip Stages 1–3 entirely:
42
- >
43
- > ```
44
- > /gdd:handoff ./my-design.html
45
- > ```
46
- >
47
- > Parses the bundle's CSS custom properties into D-XX design decisions, runs the verification pass with Handoff Faithfulness scoring, and optionally writes implementation status back to Figma.
48
-
49
- ---
50
-
51
- ## Why I Built This
52
-
53
- I'm a designer who ships with AI coding agents. The code-side workflow is mature: specs, tasks, tests, commits, review loops. The design-side workflow was not.
54
-
55
- What I kept running into: the agent could generate a screen that looked fine in isolation, but the work was disconnected. Tokens did not match the existing system. Contrast ratios drifted below WCAG. Hierarchy got reinvented per screen. Old anti-patterns leaked into new components. And because nothing verified the output against the original brief, the problems usually surfaced late, in PR review or after handoff.
30
+ ## What It Is
56
31
 
57
- So I built Get Design Done: a design pipeline that gives AI coding agents the same kind of structure developers already expect from engineering workflows. It captures the brief, maps the current design system, grounds decisions in references, decomposes the work into atomic tasks, executes those tasks, and verifies the result before you ship.
32
+ Get Design Done helps AI coding agents ship UI that belongs in your product.
58
33
 
59
- Behind the scenes: 64 specialized agents, a queryable intel store, tier-aware model routing, 42 optional tool connections, atomic commits, and a no-regret adaptive layer that learns from solidify-with-rollback outcomes. What you use day to day: a few `/gdd:*` commands that keep design work coherent.
34
+ It turns loose requests like "make this screen better" into a traceable design workflow: brief, explore, plan, design, verify.
60
35
 
61
- - **Hegemon**
36
+ Instead of asking an agent to improvise from taste alone, GDD gives it a structured process, local design knowledge, project-specific memory, optional design-tool connections, and verification before the work ships.
62
37
 
63
- ---
38
+ ## Why It Exists
64
39
 
65
- AI-generated design has the same failure mode as AI-generated code: describe what you want, get something plausible, then watch it fall apart at scale because no system tied the output back to the brief.
40
+ AI agents are fast at producing UI. The hard part is making that UI coherent.
66
41
 
67
- Get Design Done is the context engineering layer for design work. It turns "make this UI better" into a traceable cycle: brief → explore → plan → design → verify.
42
+ Without a design workflow, generated interfaces drift:
68
43
 
69
- ---
44
+ - colors and spacing stop matching the system
45
+ - components get reinvented
46
+ - contrast and accessibility regress
47
+ - hierarchy changes from screen to screen
48
+ - implementation no longer matches the original brief
70
49
 
71
- ## What You Get
50
+ GDD adds the missing design discipline around AI coding workflows. It captures the problem, maps the current design system, plans scoped changes, executes them in atomic steps, and verifies the result against the brief, tokens, accessibility, and design-quality rubrics.
72
51
 
73
- - **Brief-grounded design work** - every cycle starts with the problem, audience, constraints, success metrics, and must-haves.
74
- - **Design-system extraction** - GDD inventories tokens, typography, spacing, components, motion, accessibility, dark mode, and design debt before planning changes.
75
- - **Reference-backed decisions** - agents use embedded design references plus optional Figma, Refero, Pinterest, Storybook, Chromatic, Preview, Claude Design, paper.design, pencil.dev, Graphify, 21st.dev Magic, and Magic Patterns connections.
76
- - **Atomic execution** - design tasks are decomposed by dependency, run in safe waves, and committed independently.
77
- - **Verification before shipping** - audits check brief fit, token integration, WCAG contrast, component conformance, motion consistency, dark-mode architecture, and design anti-patterns.
78
- - **Rollback on failed validation** - solidify-with-rollback validates each task before it sticks; failed work is automatically reverted.
52
+ Behind the scenes: 64 specialized agents, a queryable intel store, tier-aware model routing, and 39 optional tool connections. What you use day to day is a handful of `/gdd:*` commands.
79
53
 
80
- ---
54
+ ## Install
81
55
 
82
- ## Who This Is For
56
+ ### npm
83
57
 
84
- GDD is for engineers, designers, design engineers, founders, and product builders who ship UI with AI coding agents and need the result to hold together beyond the first screenshot.
58
+ ```bash
59
+ npx @hegemonart/get-design-done@latest
60
+ ```
85
61
 
86
- Use it when you care that tokens match, contrast passes WCAG, motion feels cohesive, components follow your system, and the final implementation still matches what you asked for.
62
+ ### Claude Code
87
63
 
88
- You do not need to be a designer to benefit from it. The pipeline carries the design discipline into the agent workflow: it extracts context, asks only for missing decisions, grounds the work in references, and catches the issues people usually find too late.
64
+ ```bash
65
+ /plugin marketplace add hegemonart/get-design-done
66
+ /plugin install get-design-done@get-design-done
67
+ /reload-plugins
68
+ ```
89
69
 
90
- For the full release history (every version from v1.0.0 onwards), see [CHANGELOG.md](CHANGELOG.md).
70
+ ### Codex
91
71
 
92
- ---
72
+ ```bash
73
+ codex plugin marketplace add hegemonart/get-design-done
74
+ ```
93
75
 
94
- <p align="center">
95
- <strong>Supported by</strong>
96
- </p>
76
+ ### agentskills.io
97
77
 
98
- <div align="center">
99
- <a href="https://www.humbleteam.com/" aria-label="Humbleteam">
100
- <img src="docs/assets/sponsors/humbleteam.svg" alt="Humbleteam logo" width="180">
101
- </a>
102
- <br>
103
- <sub>Product design partner for ambitious startups and AI products.</sub>
104
- </div>
78
+ Browse and install Get Design Done from the [agentskills.io](https://agentskills.io) skills registry.
105
79
 
106
- ---
80
+ ### Direct runtime installer
107
81
 
108
- ## How It Works
82
+ ```bash
83
+ # Claude Code
84
+ npx @hegemonart/get-design-done --claude --global
85
+ npx @hegemonart/get-design-done --claude --local
109
86
 
110
- > **New to an existing codebase?** Run `/gdd:map` first. It dispatches 5 specialist mappers in parallel (tokens, components, visual hierarchy, a11y, motion) and writes structured JSON to `.design/map/` - much higher signal than the grep-based fallback in Explore.
87
+ # Other runtimes
88
+ npx @hegemonart/get-design-done --codex --global
89
+ npx @hegemonart/get-design-done --cursor --global
90
+ npx @hegemonart/get-design-done --gemini --global
111
91
 
112
- ### 1. Brief
92
+ # Multi-runtime install
93
+ npx @hegemonart/get-design-done --all --global
113
94
 
95
+ # Preview without writing
96
+ npx @hegemonart/get-design-done --dry-run
114
97
  ```
115
- /gdd:brief
116
- ```
117
-
118
- Captures the design problem before any scanning or exploration. The skill interviews via `AskUserQuestion`, one question at a time, only for unanswered sections: problem, audience, constraints, success metrics, scope.
119
-
120
- **Creates:** `.design/BRIEF.md`
121
98
 
122
- ---
99
+ ## Quickstart
123
100
 
124
- ### 2. Explore
101
+ Run a lightweight first pass:
125
102
 
103
+ ```bash
104
+ /gdd:start
126
105
  ```
127
- /gdd:explore
128
- ```
129
-
130
- Inventories the current codebase's design system: colors, typography, spacing, components, motion, a11y, dark-mode. Five parallel mappers + a `design-discussant` interview produce three artifacts. Connection probes detect Figma, Refero, Storybook, Chromatic, Preview, Pinterest, Claude Design, paper.design, pencil.dev, Graphify, 21st.dev Magic, and Magic Patterns availability.
131
-
132
- **Creates:** `.design/DESIGN.md`, `.design/DESIGN-DEBT.md`, `.design/DESIGN-CONTEXT.md`, `.design/map/{tokens,components,a11y,motion,visual-hierarchy}.{md,json}`
133
106
 
134
- ---
135
-
136
- ### 3. Plan
107
+ Or run the full design cycle:
137
108
 
138
- ```
109
+ ```bash
110
+ /gdd:brief
111
+ /gdd:explore
139
112
  /gdd:plan
113
+ /gdd:design
114
+ /gdd:verify
140
115
  ```
141
116
 
142
- Decomposes Explore output into atomic, wave-coordinated, dependency-analyzed design tasks. Each task carries explicit `Touches:` paths, parallel-safety tags, and acceptance criteria. `design-planner` (opus) authors; `design-plan-checker` (haiku) gate-checks against the brief goal before execution.
117
+ For natural-language routing:
143
118
 
144
- **Creates:** `.design/DESIGN-PLAN.md`
145
-
146
- ---
147
-
148
- ### 4. Design
149
-
150
- ```
151
- /gdd:design
119
+ ```bash
120
+ /gdd:do improve the checkout page hierarchy, spacing, and empty states
152
121
  ```
153
122
 
154
- Executes plan tasks in waves. Each task gets a dedicated `design-executor` agent with a fresh 200k context, atomic git commit, and automatic deviation handling per in-context rules. Parallel-safe tasks run in worktrees.
123
+ ## Use Cases
155
124
 
156
- **Solidify-with-rollback** - every task validates (typecheck + build + targeted test) before locking in. Validation fails → `git stash` revert. Each task is atomic commit-or-revert.
125
+ ### Improve An Existing Screen
157
126
 
158
- **Creates:** `.design/tasks/task-NN.md` per task, atomic git commit per task
127
+ Use GDD when a screen works technically but feels visually inconsistent, unclear, or under-designed.
159
128
 
160
- ```
161
- ┌────────────────────────────────────────────────────────────────────┐
162
- │ WAVE EXECUTION │
163
- ├────────────────────────────────────────────────────────────────────┤
164
- │ │
165
- │ WAVE 1 (parallel) WAVE 2 (parallel) WAVE 3 │
166
- │ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
167
- │ │ Task 01 │ │ Task 02 │ → │ Task 03 │ │ Task 04 │ → │ Task 05 │ │
168
- │ │ tokens │ │ a11y │ │ button │ │ form │ │ verify │ │
169
- │ └─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘ │
170
- │ │ │ ↑ ↑ ↑ │
171
- │ └───────────┴──────────────┴───────────┴──────────────┘ │
172
- │ Touches: paths drive dependency analysis │
173
- │ │
174
- └────────────────────────────────────────────────────────────────────┘
129
+ ```bash
130
+ /gdd:do improve the settings page layout and component hierarchy
175
131
  ```
176
132
 
177
- ---
133
+ ### Bring AI Output Back To The Design System
178
134
 
179
- ### 5. Verify
135
+ Use it when an agent generated UI that looks plausible but does not match your tokens, spacing, states, or components.
180
136
 
181
- ```
137
+ ```bash
182
138
  /gdd:verify
183
139
  ```
184
140
 
185
- Verifies against the brief - must-haves, NN/g heuristics, audit rubric, token integration. Three agents run in sequence: `design-auditor` (6-pillar 1–4 score), `design-verifier` (goal-backward), `design-integration-checker` (greps D-XX decisions back to code). On failures, produces a structured gap list and enters a verify→fix loop via `design-fixer`.
141
+ ### Audit Before Shipping
186
142
 
187
- **Creates:** `.design/DESIGN-VERIFICATION.md`, gap-fix commits if issues found
143
+ Run verification before a PR, release, or design handoff.
188
144
 
189
- ---
145
+ ```bash
146
+ /gdd:audit
147
+ ```
190
148
 
191
- ### 6. Ship → Reflect → Next Cycle
149
+ ### Fix Dark Mode
192
150
 
193
- ```
194
- /gdd:ship # Generate clean PR branch (filters .design/ commits)
195
- /gdd:reflect # design-reflector reads telemetry + learnings
196
- /gdd:apply-reflections # Review and selectively apply reflector proposals
197
- /gdd:complete-cycle # Archive cycle artifacts, write EXPERIENCE.md
198
- /gdd:new-cycle # Open a new design cycle
151
+ ```bash
152
+ /gdd:darkmode
199
153
  ```
200
154
 
201
- Or auto-route:
155
+ ### Import A Design Handoff
202
156
 
157
+ ```bash
158
+ /gdd:handoff ./my-design.html
203
159
  ```
204
- /gdd:next # Auto-detect state and run the next step
205
- ```
206
-
207
- Each cycle gets a brief, scan, plan, execution, verification, and a per-cycle `EXPERIENCE.md` (~100–200 lines: Goal / Decisions made / Learnings graduated / What died / Handoff to next cycle) that becomes the highest-priority source for the decision-injector hook.
208
160
 
209
- ---
161
+ This parses a Claude Design bundle, extracts CSS custom properties into design decisions, and runs handoff faithfulness checks.
210
162
 
211
- ### Fast Mode
163
+ ### Make A Small Focused Fix
212
164
 
213
- ```
214
- /gdd:fast "<task>"
165
+ ```bash
166
+ /gdd:fast "fix contrast in pricing cards"
215
167
  ```
216
168
 
217
- For trivial single-file fixes that don't need the full pipeline. Skips the router, cache-manager, and telemetry. Same atomic-commit guarantees.
169
+ ## What Makes It Different
218
170
 
219
- ```
220
- /gdd:quick
221
- ```
171
+ ### Local Design Knowledge
222
172
 
223
- For ad-hoc tasks that need GSD-style guarantees but skip optional gates (no phase-researcher, no assumptions analyzer, no integration-checker). Faster than the full pipeline; safer than `/gdd:fast`.
173
+ GDD ships with an extensive local reference library for design work. Agents can use it without relying on live web search for basic design judgment.
224
174
 
225
- ---
175
+ It covers accessibility, WCAG, typography, spacing, grids, color, contrast, surfaces, motion, UX writing, forms, empty states, visual hierarchy, dark mode, responsive behavior, i18n, research methods, audit scoring, and design anti-patterns.
226
176
 
227
- ## Why It Works
177
+ The agent is not starting from a blank prompt. It has a shared design vocabulary and concrete standards it can apply during planning, implementation, and verification.
228
178
 
229
- ### Context Engineering
179
+ Full map: [docs/KNOWLEDGE-BASE.md](docs/KNOWLEDGE-BASE.md)
230
180
 
231
- AI coding CLIs are powerful **if** you feed them context. Most people don't.
181
+ ### Project-Specific Memory
232
182
 
233
- GDD handles it for you:
183
+ GDD creates a `.design/` workspace that keeps each cycle grounded:
234
184
 
235
- | File | What it does |
236
- |------|--------------|
237
- | `.design/BRIEF.md` | The cycle's problem, audience, success metrics |
238
- | `.design/DESIGN.md` | Current design-system snapshot (tokens, components, hierarchy) |
239
- | `.design/DESIGN-CONTEXT.md` | D-XX decisions, interview answers, upstream/downstream constraints |
240
- | `.design/DESIGN-PLAN.md` | Atomic tasks, wave choreography, dependencies |
241
- | `.design/DESIGN-VERIFICATION.md` | Verification result, gap list, Handoff Faithfulness score |
242
- | `.design/intel/` | Queryable knowledge layer: token fan-out, component call-graph, decision traceability |
243
- | `.design/archive/cycle-N/EXPERIENCE.md` | Per-cycle retrospective for cross-cycle memory |
244
- | `.design/telemetry/events.jsonl` | Typed event stream across stages |
245
- | `.design/telemetry/posterior.json` | Bandit posterior (when `adaptive_mode != static`) |
185
+ | Artifact | Purpose |
186
+ | --- | --- |
187
+ | `.design/BRIEF.md` | Problem, audience, scope, success metrics |
188
+ | `.design/DESIGN.md` | Current design-system snapshot |
189
+ | `.design/DESIGN-CONTEXT.md` | Decisions, constraints, references |
190
+ | `.design/DESIGN-PLAN.md` | Atomic implementation plan |
191
+ | `.design/DESIGN-VERIFICATION.md` | Final audit and gap report |
192
+ | `.design/intel/` | Queryable project knowledge: tokens, components, relationships, decisions |
193
+ | `.design/archive/` | Completed cycle history and learnings |
246
194
 
247
- Size limits where Claude's quality degrades. Stay under, get consistency.
195
+ The longer you use it, the less the agent has to rediscover.
248
196
 
249
- ### 64 Specialized Agents
197
+ ### Verification Before Shipping
250
198
 
251
- Each stage is a thin orchestrator that spawns specialized agents. Heavy lifting happens in fresh 200k contexts, not your main session.
199
+ GDD does not stop when the UI "looks done."
252
200
 
253
- | Stage | Orchestrator does | Agents do |
254
- |-------|-------------------|-----------|
255
- | Brief | one-question interview | (no subagents - leaf skill) |
256
- | Explore | spawns 5 mappers + discussant | 5 parallel mappers, design-discussant, research-synthesizer |
257
- | Plan | spawns researcher + planner + checker | design-phase-researcher (optional), design-planner (opus), design-plan-checker (haiku) |
258
- | Design | wave coordination + worktree isolation | design-executor per task, design-fixer on solidify failure |
259
- | Verify | spawns auditor + verifier + checker | design-auditor (6-pillar score), design-verifier (goal-backward), design-integration-checker (D-XX → code) |
260
- | Reflect | reads telemetry + learnings | design-reflector (opus), design-authority-watcher, design-update-checker |
201
+ The verify stage checks whether the result still matches:
261
202
 
262
- ### Embedded Design References
203
+ - the original brief
204
+ - design-system tokens
205
+ - accessibility thresholds
206
+ - component conventions
207
+ - visual hierarchy
208
+ - motion and interaction rules
209
+ - recorded design decisions
263
210
 
264
- The plugin ships 18+ reference files covering every major design-knowledge domain. Agents have authoritative answers without web search:
211
+ When gaps appear, GDD produces a structured fix list instead of leaving review to vibes.
265
212
 
266
- - **Heuristics** - NN/g 10, Don Norman emotional design (visceral/behavioral/reflective), Dieter Rams 10, Disney 12 (motion), Sonner / Emil Kowalski component-authoring lens, Peak-End Rule, Loss Aversion, Cognitive Load Theory, Aesthetic-Usability Effect, Doherty Threshold, Flow.
267
- - **Components** - 35 component specs (Material 3, Apple HIG, Radix, shadcn, Polaris, Carbon, Fluent, Atlassian, Ant, Mantine, Chakra, Base Web, Spectrum, Lightning, Evergreen, Gestalt) with locked spec template (Purpose · Anatomy · Variants · States · Sizing · Typography · Keyboard · Motion · Do/Don't · Anti-patterns · Citations · Grep signatures).
268
- - **Visual + brand** - gestalt principles, visual-hierarchy, brand-voice, palette catalog (161 industry palettes), style vocabulary (67 UI aesthetics), iconography (Lucide / Phosphor / Heroicons / Radix Icons / Tabler / SF Symbols).
269
- - **Motion** - 12 canonical easings (RN MIT) + 8 transition families (hyperframes Apache-2.0) + spring presets + interpolation taxonomy + advanced craft (gesture mechanics, clip-path, blur crossfades, View Transitions API, WAAPI).
270
- - **Platform + a11y** - WCAG 2.1 AA thresholds, platforms (iOS / Android / web / visionOS / watchOS), RTL + CJK + cultural color, form patterns (Wroblewski label research, autocomplete taxonomy, CAPTCHA ethics).
271
- - **Anti-patterns** - regex-signature catalog matched by `design-pattern-mapper`.
213
+ ### Skill behavior tests
272
214
 
273
- ### Atomic Git Commits
215
+ GDD's own skills are exercised under adversarial pressure scenarios (time pressure, sunk-cost, authority, scope-minimization) to confirm they hold their discipline rather than caving. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add a pressure scenario.
274
216
 
275
- Each design task gets its own commit immediately after completion:
217
+ ## How It Works
276
218
 
219
+ ```text
220
+ Brief -> Explore -> Plan -> Design -> Verify -> Ship
277
221
  ```
278
- abc123f docs(08-02): complete user-card token plan
279
- def456g feat(08-02): unify card surface tokens with --color-bg-elevated
280
- hij789k feat(08-02): replace inline padding with --space-* scale
281
- lmn012o test(08-02): assert card.spec passes WCAG contrast 4.5:1
282
- ```
283
-
284
- Git bisect finds exact failing task. Each task is independently revertable. Solidify-with-rollback adds a per-task validation gate so a broken task 3 never corrupts tasks 4–10 before verify runs.
285
-
286
- ### Self-Improvement Loop
287
-
288
- After every cycle, `design-reflector` (opus) reads `events.jsonl`, `agent-metrics.json`, and `learnings/`, then proposes diffs:
289
-
290
- - **Tier overrides** - "design-verifier on plans <300 lines: drop to haiku, no measured quality regression"
291
- - **Parallelism rules** - "token-mapper + component-taxonomy-mapper conflict on `Touches: src/styles/`; serialize"
292
- - **Reference additions** - "L-12 cited 9 times across cycles 3–5; promote to `reference/heuristics.md`"
293
- - **Frontmatter updates** - "design-executor `typical-duration-seconds: 60` measured at 142s; propose 120s"
294
-
295
- `/gdd:apply-reflections` shows the diff and asks before applying. Nothing auto-applies. The **No-Regret Adaptive Layer** layers a Thompson sampling bandit + AdaNormalHedge ensemble + MMR rerank on top, viable in single-user mode via informed-prior bootstrap.
296
222
 
297
- ### Cost Governance
223
+ | Stage | Command | Output |
224
+ | --- | --- | --- |
225
+ | Brief | `/gdd:brief` | Captures the design problem |
226
+ | Explore | `/gdd:explore` | Maps UI system, debt, tokens, components |
227
+ | Plan | `/gdd:plan` | Creates atomic design tasks |
228
+ | Design | `/gdd:design` | Executes tasks with validation |
229
+ | Verify | `/gdd:verify` | Audits final result |
298
230
 
299
- - **`gdd-router` skill** - deterministic intent → fast / quick / full routing. No model call.
300
- - **`gdd-cache-manager`** - Layer-B explicit cache with SHA-256 input-hash + 5-min TTL awareness.
301
- - **`budget-enforcer` PreToolUse hook** - enforces tier overrides, hard caps, lazy-spawn gates from `.design/budget.json`.
302
- - **Per-spawn cost telemetry** - `.design/telemetry/costs.jsonl` rows feed `/gdd:optimize` rule-based recommendations.
231
+ ### Core Outputs
303
232
 
304
- Targets 50–70% per-task token-cost reduction with no quality-floor regression.
305
-
306
- ---
233
+ | File | What it does |
234
+ | --- | --- |
235
+ | `.design/BRIEF.md` | The cycle's problem, audience, success metrics |
236
+ | `.design/DESIGN.md` | Current design-system snapshot |
237
+ | `.design/DESIGN-CONTEXT.md` | Design decisions and constraints |
238
+ | `.design/DESIGN-PLAN.md` | Atomic tasks, waves, dependencies |
239
+ | `.design/DESIGN-VERIFICATION.md` | Verification result and gap list |
240
+ | `.design/intel/` | Queryable knowledge layer for this project |
307
241
 
308
242
  ## Commands
309
243
 
310
- GDD ships 95 skills. The most common ones are below; for the full reference see [SKILL.md](SKILL.md).
244
+ GDD ships 96 skills. These are the ones most users need day to day. For the full reference see [SKILL.md](SKILL.md).
311
245
 
312
246
  ### Core Pipeline
313
247
 
314
- | Command | What it does |
315
- |---------|--------------|
316
- | `/gdd:brief` | Stage 1 - capture the design brief |
317
- | `/gdd:explore` | Stage 2 - codebase inventory + interview |
318
- | `/gdd:plan` | Stage 3 - produce DESIGN-PLAN.md |
319
- | `/gdd:design` | Stage 4 - execute plan in waves |
320
- | `/gdd:verify` | Stage 5 - verify against brief |
321
- | `/gdd:ship` | Generate clean PR branch (filters .design/ commits) |
322
- | `/gdd:next` | Auto-route to the next stage based on STATE.md |
323
- | `/gdd:do <text>` | Natural-language router - picks the right command |
324
- | `/gdd:fast <text>` | One-shot trivial fix, no pipeline |
325
- | `/gdd:quick` | Ad-hoc task with GDD guarantees but skipped optional gates |
326
-
327
- ### Cycle + Iteration
328
-
329
- | Command | What it does |
330
- |---------|--------------|
331
- | `/gdd:start` | First-run proof path - top-3 design issues in your repo (no `.design/` footprint until you opt in) |
332
- | `/gdd:new-project` | Initialize a GDD project (PROJECT.md + STATE.md + first cycle) |
333
- | `/gdd:new-cycle` / `/gdd:complete-cycle` | Open / archive a design cycle |
334
- | `/gdd:pause` / `/gdd:resume` | Numbered checkpoints - pause mid-stage, resume from any saved checkpoint |
335
- | `/gdd:discuss [topic]` | Adaptive design interview |
336
- | `/gdd:sketch [idea]` / `/gdd:spike [idea]` | Multi-variant HTML mockups + timeboxed feasibility |
337
- | `/gdd:audit` | Wraps `design-verifier` + `design-auditor` + `design-reflector` |
338
-
339
- ### Memory + Diagnostics
340
-
341
- | Command | What it does |
342
- |---------|--------------|
343
- | `/gdd:recall <query>` | FTS5-backed search across cycle archives, learnings, decisions |
344
- | `/gdd:note <text>` / `/gdd:plant-seed <idea>` | Idea capture - append, list, promote, surface at the right cycle |
345
- | `/gdd:scan` / `/gdd:map` | Codebase design-system inventory + 5 parallel mappers |
346
- | `/gdd:health` / `/gdd:progress` | Artifact health, pipeline position, integrity audit |
347
- | `/gdd:stats` / `/gdd:optimize` | Cycle stats, rule-based cost analysis, tier recommendations |
348
-
349
- ### Connections
350
-
351
- | Command | What it does |
352
- |---------|--------------|
353
- | `/gdd:connections` | Onboarding wizard for the external integrations |
354
- | `/gdd:figma-write` | Write design decisions back to Figma (annotate / tokenize / roundtrip) |
355
- | `/gdd:handoff <bundle>` | Import a Claude Design bundle and skip Stages 1–3 |
356
- | `/gdd:darkmode` | Audit dark-mode implementation |
357
- | `/gdd:style <Component>` | Generate component handoff doc |
358
-
359
- ### Help
360
-
361
- ```
362
- /gdd:help
363
- ```
364
-
365
- The full per-command reference, including the long tail of memory, distribution, backlog, and forensic commands, lives in [SKILL.md](SKILL.md).
366
-
367
- ---
248
+ | Command | Purpose |
249
+ | --- | --- |
250
+ | `/gdd:brief` | Capture the design brief |
251
+ | `/gdd:explore` | Inventory the current UI system |
252
+ | `/gdd:plan` | Produce the design plan |
253
+ | `/gdd:design` | Execute the plan |
254
+ | `/gdd:verify` | Verify the result |
255
+ | `/gdd:ship` | Prepare a clean PR branch |
256
+ | `/gdd:next` | Auto-route to the next stage |
257
+
258
+ ### Daily Use
259
+
260
+ | Command | Purpose |
261
+ | --- | --- |
262
+ | `/gdd:do <task>` | Natural-language router |
263
+ | `/gdd:fast <task>` | Small focused fix |
264
+ | `/gdd:quick` | Lightweight task flow |
265
+ | `/gdd:audit` | Design quality audit |
266
+ | `/gdd:darkmode` | Dark-mode audit |
267
+ | `/gdd:style <component>` | Component style handoff |
268
+ | `/gdd:health` | Diagnose pipeline state |
269
+ | `/gdd:progress` | Show current cycle progress |
270
+ | `/gdd:resume` | Resume from checkpoint |
271
+
272
+ ### Design Tools And Handoff
273
+
274
+ | Command | Purpose |
275
+ | --- | --- |
276
+ | `/gdd:connections` | Configure optional integrations |
277
+ | `/gdd:figma-extract` | Extract Figma design-system context |
278
+ | `/gdd:figma-write` | Write decisions and status back to Figma |
279
+ | `/gdd:handoff <bundle>` | Import a Claude Design bundle |
280
+ | `/gdd:sketch <idea>` | Generate multi-variant HTML mockups |
281
+ | `/gdd:spike <idea>` | Timeboxed feasibility pass |
282
+
283
+ Full command reference: [SKILL.md](SKILL.md)
368
284
 
369
285
  ## Connections
370
286
 
371
- GDD ships 39 tool connections. All are optional; the pipeline degrades gracefully to fallbacks when any connection is unavailable. Configure with `/gdd:connections`.
287
+ GDD works without external tools, but can connect to 39 optional integrations. All are optional; the pipeline degrades gracefully to fallbacks when any connection is unavailable.
372
288
 
373
289
  The connection layer spans these categories:
374
290
 
375
291
  - **Design surfaces** - Figma (read + write + Code Connect), paper.design, pencil.dev, Penpot, Framer, Webflow, Plasmic
376
- - **Reference + research** - Refero, Pinterest, Lazyweb, Mobbin, Claude Design handoff
292
+ - **Reference and research** - Refero, Pinterest, Lazyweb, Mobbin, Claude Design handoff
377
293
  - **Component generation** - 21st.dev Magic, Magic Patterns, v0.dev, Builder.io
378
- - **Component spec + visual QA** - Storybook, Chromatic, Preview (Playwright + Claude Preview MCP)
294
+ - **Component spec and visual QA** - Storybook, Chromatic, Preview (Playwright + Claude Preview MCP)
379
295
  - **Knowledge graph** - Graphify
380
- - **Native + non-web output** - Xcode Simulator, Android Emulator, Litmus / Email-on-Acid, print renderer
296
+ - **Native and non-web output** - Xcode Simulator, Android Emulator, Litmus / Email-on-Acid, print renderer
381
297
  - **Motion verification** - Lottie, Rive
382
- - **Experiment + research signal** - LaunchDarkly, Statsig, GrowthBook, UserTesting, Maze, Hotjar
383
- - **Team surfaces** - Slack, Discord, Linear, Jira, Notion, GitHub PR (`pr-commenter`)
384
- - **Provider aggregation** - OpenRouter (opt-in alongside native provider auth)
298
+ - **Team surfaces** - Slack, Discord, Linear, Jira, Notion, GitHub PR
385
299
 
386
- For the full connection list with probe patterns and degraded-mode behaviour, see [connections/connections.md](connections/connections.md). Each connection is also a SKILL.md file under `skills/connections/` once enabled.
387
-
388
- ---
389
-
390
- ## Install
391
-
392
- ```bash
393
- npx @hegemonart/get-design-done@latest
394
- ```
395
-
396
- The installer prompts you to choose:
397
-
398
- 1. **Runtime** - Claude Code, OpenCode, Gemini, Kilo, Codex, Copilot, Cursor, Windsurf, Antigravity, Augment, Trae, Qwen Code, CodeBuddy, Cline, or all (interactive multi-select - pick multiple runtimes in a single session).
399
- 2. **Location** - Global (all projects) or local (current project only).
400
-
401
- All 14 runtimes receive their native artifact layout (`skills/`, `command/`, `agents/`, or `.clinerules`) via per-runtime content converters - source skills are translated to each runtime's expected shape at install time (frontmatter pass-through, path rewrite, tool-name rewrite via the cross-harness maps).
402
-
403
- Verify:
404
-
405
- ```
406
- /gdd:help
407
- ```
408
-
409
- > [!TIP]
410
- > Run Claude Code with `--dangerously-skip-permissions` for a frictionless experience. GDD is designed for autonomous multi-stage execution - approving each Read and `git commit` defeats the purpose.
411
-
412
- ### Staying Updated
413
-
414
- GDD ships often. Update by re-running the installer (it is idempotent and updates registered marketplace entries in place):
300
+ Configure integrations with:
415
301
 
416
302
  ```bash
417
- npx @hegemonart/get-design-done@latest
418
- ```
419
-
420
- Or from inside Claude Code:
421
-
422
- ```
423
- /gdd:update
424
- ```
425
-
426
- `/gdd:update` previews the changelog before applying. Local modifications under `reference/` are preserved - if a structural update needs re-stitching, run `/gdd:reapply-patches`. When a new release lands, the SessionStart hook prints a one-line banner gated by state-machine logic so it never interrupts a running stage.
427
-
428
- <details>
429
- <summary><strong>Non-interactive Install (Docker, CI, Scripts)</strong></summary>
430
-
431
- ```bash
432
- # Claude Code
433
- npx @hegemonart/get-design-done --claude --global # Install to ~/.claude/
434
- npx @hegemonart/get-design-done --claude --local # Install to ./.claude/
435
-
436
- # Per-runtime
437
- npx @hegemonart/get-design-done --opencode --global # Install to ~/.config/opencode/
438
- npx @hegemonart/get-design-done --gemini --global # Install to ~/.gemini/
439
- # ... same pattern for: kilo, codex, copilot, cursor, windsurf, antigravity,
440
- # augment, trae, qwen, codebuddy, cline
441
-
442
- # All runtimes
443
- npx @hegemonart/get-design-done --all --global
444
-
445
- # Dry run (print diff, write nothing)
446
- npx @hegemonart/get-design-done --dry-run
447
-
448
- # Custom config dir (Docker, non-default Claude root)
449
- CLAUDE_CONFIG_DIR=/workspace/.claude npx @hegemonart/get-design-done
450
- ```
451
-
452
- </details>
453
-
454
- <details>
455
- <summary><strong>Alternative: Claude Code CLI</strong></summary>
456
-
457
- ```bash
458
- claude plugin marketplace add hegemonart/get-design-done
459
- claude plugin install get-design-done@get-design-done
460
- ```
461
-
462
- This is what the npx installer does for you - `npx` just collapses two commands into one.
463
-
464
- </details>
465
-
466
- <details>
467
- <summary><strong>Alternative: Tier-2 Distribution Channels</strong></summary>
468
-
469
- Beyond the file-drop install paths above (which remain the default), three additional discovery-driven channels are supported:
470
-
471
- - **agentskills.io** - skills are spec-compliant per the [agentskills.io](https://agentskills.io) standard, consumable by any agentskills.io-compatible runtime (Codex, Kilo, Augment, Hermes, Qwen).
472
- - **Cursor Marketplace** - install via Cursor's marketplace UI (manifest at `.cursor-plugin/plugin.json`).
473
- - **Codex Plugin** - `codex plugin marketplace add hegemonart/get-design-done` (manifest at `.codex-plugin/plugin.json`).
474
-
475
- </details>
476
-
477
- ---
478
-
479
- ## Configure
480
-
481
- GDD stores project settings in `.design/config.json`. Configure during `/gdd:new-project` or update with `/gdd:settings`.
482
-
483
- ### Model Profiles
484
-
485
- Control which Claude model each agent uses. Balance quality vs token spend.
486
-
487
- | Profile | Planning | Execution | Verification |
488
- |---------|----------|-----------|--------------|
489
- | `quality` | Opus | Opus | Sonnet |
490
- | `balanced` (default) | Opus | Sonnet | Sonnet |
491
- | `budget` | Sonnet | Sonnet | Haiku |
492
- | `inherit` | Inherit | Inherit | Inherit |
493
-
494
- Switch profiles:
495
-
303
+ /gdd:connections
496
304
  ```
497
- /gdd:set-profile budget
498
- ```
499
-
500
- Use `inherit` when using non-Anthropic providers or to follow the runtime's current model selection.
501
-
502
- ### Adaptive Mode
503
-
504
- `.design/budget.json#adaptive_mode` ladder:
505
-
506
- | Mode | What it does |
507
- |------|--------------|
508
- | `static` (default) | Static tier-map behaviour |
509
- | `hedge` | AdaNormalHedge ensemble + MMR rerank engaged. Bandit router still reads static map. Safest intro. |
510
- | `full` | Bandit router + Hedge + MMR all active, reading/writing `.design/telemetry/posterior.json` |
511
-
512
- ### Parallelism + Quality Gates
513
305
 
514
- | Setting | Default | What it controls |
515
- |---------|---------|------------------|
516
- | `parallelism.enabled` | `true` | Run independent tasks in worktrees |
517
- | `parallelism.max_concurrent_workers` | `4` | Hard cap on simultaneous worktrees |
518
- | `solidify.rollback_mode` | `"stash"` | `stash` / `hard` / `none` - how to revert on validation failure |
519
- | `verify.iterations_max` | `3` | Cap on verify→fix loop iterations |
520
- | `connection.figma_writeback` | `proposal` | `proposal` / `auto` - confirm before writing |
306
+ For the full connection list with probe patterns, see [connections/connections.md](connections/connections.md).
521
307
 
522
- ### Peer-CLI Delegation
308
+ ## Requirements
523
309
 
524
- GDD agents can optionally delegate to local peer CLIs (Codex via App Server Protocol; Gemini, Cursor, Copilot, Qwen via Agent Client Protocol) when measurably cheaper or higher-quality for the role. Falls back to in-process Anthropic SDK when no peer is available. Configure per-agent via `/gdd:peers` and `/gdd:run-skill peer-cli-customize`. Full ops guide: [docs/PEER-DELEGATION.md](docs/PEER-DELEGATION.md).
310
+ - Node.js 22 or 24
311
+ - Git
312
+ - A supported AI coding runtime
525
313
 
526
- ### Skill behavior tests
527
-
528
- Static validators check a skill's shape; behavior tests check that it holds under pressure. A manifest-driven pressure-scenario harness drives 8 scenarios (7 stage skills + `using-gdd`) through time / sunk-cost / authority / exhaustion / scope-minimization pressure and scores responses against a compliance rubric. Behavior tests are opt-in and key-gated (the default `npm test` covers the harness structurally and stays CI-green):
529
-
530
- ```bash
531
- # Skips + exits 0 when ANTHROPIC_API_KEY is unset.
532
- ANTHROPIC_API_KEY=sk-... GDD_BEHAVIOR_INVOKER=./path/to/invoker.cjs npm run test:behavior
533
- ```
314
+ ## Multi-Runtime Support
534
315
 
535
- See [CONTRIBUTING.md](CONTRIBUTING.md) ("How to add a pressure scenario") for the authoring path.
316
+ GDD installs across 14 AI coding runtimes: Claude Code, Codex, Cursor, Gemini CLI, OpenCode, Kilo, Copilot, Windsurf, Antigravity, Augment, Trae, Qwen Code, CodeBuddy, and Cline. The same source skills and agents are compiled to each runtime's native layout (`skills/`, `command/`, `agents/`, or `.clinerules`) by per-runtime converters, so the pipeline travels with you across editors.
536
317
 
537
- ---
318
+ Claude Code is the flagship. The full experience runs there end to end: every agent, the defense-in-depth hooks, and the MCP-backed connections. On the other runtimes you get the same skills and agents in their native shape, MCP-backed connections light up on the MCP-capable hosts, and the hook layer is specific to Claude Code.
538
319
 
539
- ## Security
320
+ ## Safety And Privacy
540
321
 
541
- GDD ships defense-in-depth security:
322
+ GDD is local-first by default. It writes project artifacts under `.design/`, uses optional integrations only when configured, and keeps issue reporting consent-gated.
542
323
 
543
- - **`hooks/gdd-bash-guard.js`** - PreToolUse:Bash blocks ~50 dangerous patterns (`rm -rf /`, `chmod 777`, `curl | sh`, `git reset --hard`, fork bombs) after Unicode NFKC + ANSI normalization.
544
- - **`hooks/gdd-protected-paths.js`** - PreToolUse:Edit/Write/Bash enforces the `protected_paths` glob list.
545
- - **`hooks/gdd-risk-gate.js`** - scores each writer action and blocks only the genuinely dangerous ones.
546
- - **`hooks/gdd-fact-force.js`** - holds the first write to a file until its DesignContext consumers and recorded decisions have been read this session.
547
- - **`hooks/gdd-read-injection-scanner.ts`** - scans inbound Read content for invisible-Unicode + HTML-comment + secret-exfil patterns.
548
- - **`scripts/lib/blast-radius.cjs`** - `design-executor` preflight refuses tasks above `max_files_per_task: 10` / `max_lines_per_task: 400`.
549
- - **`hooks/gdd-mcp-circuit-breaker.js`** - breaks consecutive-timeout loops on MCP-backed connections.
324
+ The plugin includes defense-in-depth hooks for protected paths, dangerous-command blocking, injection scanning, MCP circuit breaking, and budget enforcement. GDD also exposes 13 read-only MCP tools for safe project introspection.
550
325
 
551
326
  Add sensitive paths to your runtime's deny list:
552
327
 
@@ -557,7 +332,6 @@ Add sensitive paths to your runtime's deny list:
557
332
  "Read(.env)",
558
333
  "Read(.env.*)",
559
334
  "Read(**/secrets/*)",
560
- "Read(**/*credential*)",
561
335
  "Read(**/*.pem)",
562
336
  "Read(**/*.key)"
563
337
  ]
@@ -565,54 +339,58 @@ Add sensitive paths to your runtime's deny list:
565
339
  }
566
340
  ```
567
341
 
568
- > [!IMPORTANT]
569
- > Because GDD generates markdown files that become LLM system prompts, any user-controlled text flowing into `.design/` artifacts is a potential indirect prompt-injection vector. The injection scanner catches such vectors at multiple layers - but defense-in-depth is best practice.
342
+ Read: [SECURITY.md](SECURITY.md) · [PRIVACY.md](PRIVACY.md)
570
343
 
571
- ---
344
+ ## Updating
572
345
 
573
- ## Troubleshooting
346
+ ```bash
347
+ npx @hegemonart/get-design-done@latest
348
+ ```
349
+
350
+ Or from inside Claude Code:
351
+
352
+ ```bash
353
+ /gdd:update
354
+ ```
574
355
 
575
- **Commands not found after install?** Restart your runtime to reload commands/skills. Verify files exist at `~/.claude/skills/get-design-done/` for global Claude Code installs (or `./.claude/skills/get-design-done/` for local). Run `/gdd:help` to confirm registration.
356
+ For the full release history, see [CHANGELOG.md](CHANGELOG.md).
576
357
 
577
- **Pipeline stuck mid-stage?** `/gdd:resume` restores from the most recent numbered checkpoint. `/gdd:health` diagnoses `.design/` artifact issues. `/gdd:progress --forensic` runs the 6-check integrity audit.
358
+ ## Troubleshooting
578
359
 
579
- **Cost overruns?** `/gdd:optimize` gives rule-based recommendations. `/gdd:set-profile budget` switches to the budget tier. Set `adaptive_mode: "full"` in `.design/budget.json` so the bandit learns cheap-and-correct tier per agent over 5–10 cycles.
360
+ ### Commands Do Not Appear
580
361
 
581
- **Using Docker / containers?**
362
+ Restart your runtime and run:
582
363
 
583
364
  ```bash
584
- CLAUDE_CONFIG_DIR=/workspace/.claude npx @hegemonart/get-design-done
365
+ /gdd:help
585
366
  ```
586
367
 
587
- ### Uninstalling
368
+ ### Pipeline Is Stuck
588
369
 
589
370
  ```bash
590
- # Per-runtime (replace --claude with any runtime flag)
591
- npx @hegemonart/get-design-done --claude --global --uninstall
592
-
593
- # Multi-select interactive uninstall (no runtime flag)
594
- npx @hegemonart/get-design-done --uninstall
371
+ /gdd:health
372
+ /gdd:resume
595
373
  ```
596
374
 
597
- This removes all GDD commands, agents, hooks, and settings while preserving other configurations.
598
-
599
- ---
375
+ ### Cost Is Too High
600
376
 
601
- ## Feedback
377
+ ```bash
378
+ /gdd:optimize
379
+ ```
602
380
 
603
- GDD ships a consent-first GitHub issue reporter via the `/gdd:report-issue` slash command. It walks you through reporting an issue or capability gap with a payload preview before submission, local-first and consent-gated. Direct identifiers are replaced with stable pseudonyms (your username, hostname, absolute paths, git identity, env-var values, emails, IPs) - but internal correlation is preserved so maintainers can debug. Set `GDD_DISABLE_ISSUE_REPORTER=1` or add `{ "issue_reporter": false }` to `.design/config.json` to halt submission before any network call.
381
+ ## Contributing
604
382
 
605
- See [reference/pseudonymization-rules.md](reference/pseudonymization-rules.md) for the rule catalog.
383
+ ```bash
384
+ npm install
385
+ npm test
386
+ npm run typecheck
387
+ ```
606
388
 
607
- ---
389
+ Read: [CONTRIBUTING.md](CONTRIBUTING.md)
608
390
 
609
391
  ## License
610
392
 
611
- MIT License. See [LICENSE](LICENSE) for details.
612
-
613
- Architecture ported from `gsd-build/get-shit-done` (MIT - see `NOTICE`). Peer-CLI protocol shapes adapted from `greenpolo/cc-multi-cli` (Apache 2.0). Skill-discipline mechanism ported from [`obra/superpowers`](https://github.com/obra/superpowers) (MIT).
614
-
615
- For the full release history, see [CHANGELOG.md](CHANGELOG.md). For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
393
+ MIT License. See [LICENSE](LICENSE) for details. Third-party attributions are listed in [NOTICE](NOTICE).
616
394
 
617
395
  ---
618
396