@design-ai/cli 4.55.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.
- package/.claude-plugin/plugin.json +164 -0
- package/AGENTS.ko.md +126 -0
- package/AGENTS.md +182 -0
- package/CHANGELOG.md +6883 -0
- package/CLAUDE.md +39 -0
- package/LICENSE +21 -0
- package/README.ko.md +245 -0
- package/README.md +277 -0
- package/agents/README.md +14 -0
- package/agents/a11y-reviewer.md +121 -0
- package/agents/component-architect.md +57 -0
- package/agents/design-critic.md +46 -0
- package/agents/token-extractor.md +63 -0
- package/cli/bin/design-ai-mcp.mjs +6 -0
- package/cli/bin/design-ai.mjs +40 -0
- package/cli/commands/audit.mjs +111 -0
- package/cli/commands/check.mjs +226 -0
- package/cli/commands/doctor.mjs +141 -0
- package/cli/commands/examples.mjs +58 -0
- package/cli/commands/help.mjs +271 -0
- package/cli/commands/install.mjs +161 -0
- package/cli/commands/learn.mjs +1871 -0
- package/cli/commands/list.mjs +143 -0
- package/cli/commands/mcp.mjs +27 -0
- package/cli/commands/pack.mjs +211 -0
- package/cli/commands/prompt.mjs +199 -0
- package/cli/commands/route.mjs +247 -0
- package/cli/commands/search.mjs +60 -0
- package/cli/commands/show.mjs +52 -0
- package/cli/commands/site.mjs +558 -0
- package/cli/commands/status.mjs +161 -0
- package/cli/commands/uninstall.mjs +119 -0
- package/cli/commands/update.mjs +184 -0
- package/cli/commands/version.mjs +94 -0
- package/cli/commands/workspace.mjs +176 -0
- package/cli/lib/brief.mjs +52 -0
- package/cli/lib/check.mjs +642 -0
- package/cli/lib/dispatch.mjs +109 -0
- package/cli/lib/doctor.mjs +505 -0
- package/cli/lib/examples.mjs +258 -0
- package/cli/lib/exec.mjs +63 -0
- package/cli/lib/help-flags.mjs +5 -0
- package/cli/lib/learn.mjs +3694 -0
- package/cli/lib/log.mjs +47 -0
- package/cli/lib/mcp-server.mjs +426 -0
- package/cli/lib/output.mjs +101 -0
- package/cli/lib/pack.mjs +599 -0
- package/cli/lib/paths.mjs +63 -0
- package/cli/lib/prompt.mjs +603 -0
- package/cli/lib/route.mjs +740 -0
- package/cli/lib/search.mjs +158 -0
- package/cli/lib/show.mjs +161 -0
- package/cli/lib/signals.mjs +2337 -0
- package/cli/lib/site.mjs +6617 -0
- package/cli/lib/skill-proposals.mjs +2046 -0
- package/cli/lib/suggest.mjs +66 -0
- package/cli/lib/workspace.mjs +1056 -0
- package/commands/README.md +25 -0
- package/commands/component-spec.md +34 -0
- package/commands/conversational.md +44 -0
- package/commands/design-from-brief.md +141 -0
- package/commands/design-review.md +62 -0
- package/commands/document-from-brief.md +47 -0
- package/commands/extract-tokens.md +38 -0
- package/commands/game-ui.md +40 -0
- package/commands/illustration.md +37 -0
- package/commands/iterate.md +167 -0
- package/commands/motion-design.md +54 -0
- package/commands/palette-from-brand.md +50 -0
- package/commands/print.md +49 -0
- package/commands/slide-deck.md +46 -0
- package/commands/spatial.md +47 -0
- package/commands/stability-review.md +74 -0
- package/commands/video.md +42 -0
- package/commands/website-improvement.md +77 -0
- package/docs/AGENT-DEVELOPMENT.md +658 -0
- package/docs/AI-LEARNING.md +429 -0
- package/docs/AIDER-INTEGRATION.md +224 -0
- package/docs/ARCHITECTURE.ko.md +183 -0
- package/docs/ARCHITECTURE.md +105 -0
- package/docs/CODEX-INTEGRATION.md +311 -0
- package/docs/COMPANY-WEBSITE-DOGFOOD.ko.md +144 -0
- package/docs/COMPANY-WEBSITE-DOGFOOD.md +150 -0
- package/docs/COMPANY-WEBSITE-INTAKE-TEMPLATE.ko.md +153 -0
- package/docs/COMPANY-WEBSITE-INTAKE-TEMPLATE.md +154 -0
- package/docs/CONTRIBUTING.ko.md +203 -0
- package/docs/CONTRIBUTING.md +242 -0
- package/docs/CURSOR-INTEGRATION.md +220 -0
- package/docs/DISTRIBUTION.ko.md +248 -0
- package/docs/DISTRIBUTION.md +253 -0
- package/docs/DOGFOOD-FINDINGS.md +180 -0
- package/docs/DOGFOOD-V4-FINDINGS.md +139 -0
- package/docs/DOGFOOD-V4-MKDOCS-FINDINGS.md +233 -0
- package/docs/DOGFOOD-V4-NPM-FINDINGS.md +157 -0
- package/docs/DOGFOOD-V4-VSCODE-FINDINGS.md +135 -0
- package/docs/FIGMA-INTEGRATION.md +222 -0
- package/docs/MCP-INTEGRATION.md +243 -0
- package/docs/MIGRATION-v4.md +121 -0
- package/docs/PLUGIN-PACKAGING.md +240 -0
- package/docs/PRODUCT-READINESS.md +66 -0
- package/docs/QUICKSTART.ko.md +178 -0
- package/docs/QUICKSTART.md +179 -0
- package/docs/RELEASE-CHECKLIST.md +292 -0
- package/docs/ROADMAP.md +19495 -0
- package/docs/SESSION-LOG.md +940 -0
- package/docs/TOKEN-SYNC.md +237 -0
- package/docs/USING.ko.md +206 -0
- package/docs/USING.md +218 -0
- package/docs/WEBSITE-IMPROVEMENT.ko.md +75 -0
- package/docs/WEBSITE-IMPROVEMENT.md +89 -0
- package/docs/announcements/README.md +56 -0
- package/docs/announcements/dev-to-korea.md +206 -0
- package/docs/announcements/hashnode-post.ko.md +232 -0
- package/docs/announcements/okky-post.ko.md +158 -0
- package/docs/announcements/press-kit.md +101 -0
- package/docs/announcements/reddit-r-korea.md +196 -0
- package/docs/announcements/show-hn.md +114 -0
- package/docs/announcements/twitter-thread.md +255 -0
- package/docs/external-status.md +34 -0
- package/docs/integrations/aider-walkthrough.ko.md +275 -0
- package/docs/integrations/aider-walkthrough.md +274 -0
- package/docs/integrations/codex-walkthrough.ko.md +297 -0
- package/docs/integrations/codex-walkthrough.md +297 -0
- package/docs/integrations/cursor-walkthrough.ko.md +281 -0
- package/docs/integrations/cursor-walkthrough.md +284 -0
- package/docs/integrations/design-ai-mcp-server.md +169 -0
- package/docs/integrations/figma-mcp.md +149 -0
- package/docs/integrations/github-mcp.md +178 -0
- package/docs/integrations/linear-mcp.md +215 -0
- package/docs/integrations/notion-mcp.md +174 -0
- package/docs/integrations/sdk-walkthrough.ko.md +375 -0
- package/docs/integrations/sdk-walkthrough.md +375 -0
- package/docs/integrations/slack-mcp.md +208 -0
- package/docs/integrations/vscode-walkthrough.ko.md +202 -0
- package/docs/integrations/vscode-walkthrough.md +205 -0
- package/docs/requirements.txt +16 -0
- package/docs/site-overrides/extra.css +83 -0
- package/docs/site-overrides/favicon.svg +4 -0
- package/docs/site-overrides/logo.svg +10 -0
- package/docs/site-overrides/main.html +18 -0
- package/docs/website-console/app.js +2540 -0
- package/docs/website-console/index.html +24 -0
- package/docs/website-console/styles.css +975 -0
- package/examples/README.md +252 -0
- package/examples/cases/dogfood-v4-korean-hr-onboarding.md +356 -0
- package/examples/component-accordion-actions.md +153 -0
- package/examples/component-accordion-details.md +147 -0
- package/examples/component-accordion-summary.md +180 -0
- package/examples/component-accordion.md +229 -0
- package/examples/component-account-card.md +284 -0
- package/examples/component-address-input.md +260 -0
- package/examples/component-affix.md +190 -0
- package/examples/component-alert-dialog.md +210 -0
- package/examples/component-alert-title.md +77 -0
- package/examples/component-alert.md +192 -0
- package/examples/component-amount-input.md +278 -0
- package/examples/component-anchor.md +198 -0
- package/examples/component-app-bar.md +249 -0
- package/examples/component-aspect-ratio.md +156 -0
- package/examples/component-auto-complete.md +199 -0
- package/examples/component-avatar-group.md +170 -0
- package/examples/component-avatar.md +191 -0
- package/examples/component-back-top.md +123 -0
- package/examples/component-backdrop.md +148 -0
- package/examples/component-badge.md +181 -0
- package/examples/component-banner.md +237 -0
- package/examples/component-biometric-gate.md +281 -0
- package/examples/component-blockquote.md +153 -0
- package/examples/component-border-beam.md +207 -0
- package/examples/component-bottom-navigation.md +226 -0
- package/examples/component-box.md +112 -0
- package/examples/component-breadcrumb.md +222 -0
- package/examples/component-button-base.md +190 -0
- package/examples/component-button-group.md +117 -0
- package/examples/component-button.md +213 -0
- package/examples/component-calendar.md +280 -0
- package/examples/component-callout.md +131 -0
- package/examples/component-card-actions.md +101 -0
- package/examples/component-card-content.md +90 -0
- package/examples/component-card-header.md +122 -0
- package/examples/component-card-media.md +79 -0
- package/examples/component-card.md +233 -0
- package/examples/component-carousel.md +266 -0
- package/examples/component-cascader.md +135 -0
- package/examples/component-category-picker.md +271 -0
- package/examples/component-chart.md +237 -0
- package/examples/component-chat-interface.md +399 -0
- package/examples/component-checkbox.md +149 -0
- package/examples/component-click-away-listener.md +87 -0
- package/examples/component-code.md +213 -0
- package/examples/component-collapsible.md +219 -0
- package/examples/component-color-picker.md +110 -0
- package/examples/component-combobox.md +267 -0
- package/examples/component-command.md +299 -0
- package/examples/component-config-provider.md +190 -0
- package/examples/component-context-menu.md +179 -0
- package/examples/component-css-baseline.md +148 -0
- package/examples/component-date-picker.md +249 -0
- package/examples/component-descriptions.md +242 -0
- package/examples/component-dialog-actions.md +111 -0
- package/examples/component-dialog-content-text.md +76 -0
- package/examples/component-dialog-content.md +105 -0
- package/examples/component-dialog-title.md +104 -0
- package/examples/component-dialog.md +176 -0
- package/examples/component-divider.md +182 -0
- package/examples/component-doc-page.md +217 -0
- package/examples/component-drawer.md +257 -0
- package/examples/component-dropdown.md +220 -0
- package/examples/component-email-layout.md +253 -0
- package/examples/component-empty-state.md +269 -0
- package/examples/component-empty.md +172 -0
- package/examples/component-fade.md +87 -0
- package/examples/component-feature-grid.md +201 -0
- package/examples/component-field.md +266 -0
- package/examples/component-filled-input.md +114 -0
- package/examples/component-flex.md +117 -0
- package/examples/component-float-button.md +214 -0
- package/examples/component-form-control-label.md +134 -0
- package/examples/component-form-control.md +113 -0
- package/examples/component-form-controls.md +251 -0
- package/examples/component-form-group.md +86 -0
- package/examples/component-form-helper-text.md +95 -0
- package/examples/component-form-label.md +98 -0
- package/examples/component-form.md +291 -0
- package/examples/component-game-hud.md +362 -0
- package/examples/component-game-menu.md +327 -0
- package/examples/component-grid.md +140 -0
- package/examples/component-grow.md +79 -0
- package/examples/component-hero-block.md +252 -0
- package/examples/component-hover-card.md +211 -0
- package/examples/component-icon-button.md +142 -0
- package/examples/component-icon.md +102 -0
- package/examples/component-illustration.md +280 -0
- package/examples/component-image-list.md +107 -0
- package/examples/component-image.md +282 -0
- package/examples/component-input-adornment.md +101 -0
- package/examples/component-input-base.md +134 -0
- package/examples/component-input-number.md +141 -0
- package/examples/component-input-otp.md +271 -0
- package/examples/component-input.md +213 -0
- package/examples/component-item.md +243 -0
- package/examples/component-kbd.md +197 -0
- package/examples/component-krw-amount.md +219 -0
- package/examples/component-label.md +118 -0
- package/examples/component-layout.md +217 -0
- package/examples/component-link.md +223 -0
- package/examples/component-list-item-avatar.md +72 -0
- package/examples/component-list-item-button.md +139 -0
- package/examples/component-list-item-icon.md +82 -0
- package/examples/component-list-item-text.md +98 -0
- package/examples/component-list-item.md +116 -0
- package/examples/component-list-subheader.md +70 -0
- package/examples/component-list.md +198 -0
- package/examples/component-loading-button.md +125 -0
- package/examples/component-loading-sequence.md +254 -0
- package/examples/component-lottie-player.md +279 -0
- package/examples/component-masonry.md +191 -0
- package/examples/component-mentions.md +189 -0
- package/examples/component-menu-item.md +102 -0
- package/examples/component-menu-list.md +98 -0
- package/examples/component-menu.md +139 -0
- package/examples/component-menubar.md +259 -0
- package/examples/component-message.md +162 -0
- package/examples/component-mobile-stepper.md +155 -0
- package/examples/component-modal.md +220 -0
- package/examples/component-navigation-menu.md +295 -0
- package/examples/component-notification.md +166 -0
- package/examples/component-otp-countdown.md +245 -0
- package/examples/component-outlined-input.md +145 -0
- package/examples/component-page-transition.md +281 -0
- package/examples/component-pagination.md +226 -0
- package/examples/component-paper.md +199 -0
- package/examples/component-pass-auth.md +265 -0
- package/examples/component-payment-brand-button.md +253 -0
- package/examples/component-payment-method-selector.md +272 -0
- package/examples/component-payment-receipt.md +277 -0
- package/examples/component-popconfirm.md +144 -0
- package/examples/component-popover.md +239 -0
- package/examples/component-popper.md +129 -0
- package/examples/component-pricing-cards.md +247 -0
- package/examples/component-progress.md +195 -0
- package/examples/component-qr-code.md +201 -0
- package/examples/component-radio.md +167 -0
- package/examples/component-rate.md +202 -0
- package/examples/component-resizable.md +163 -0
- package/examples/component-result.md +270 -0
- package/examples/component-scroll-area.md +199 -0
- package/examples/component-scroll-reveal.md +320 -0
- package/examples/component-segmented.md +178 -0
- package/examples/component-select.md +258 -0
- package/examples/component-separator.md +177 -0
- package/examples/component-sheet.md +277 -0
- package/examples/component-sidebar.md +257 -0
- package/examples/component-skeleton.md +178 -0
- package/examples/component-slide.md +89 -0
- package/examples/component-slider.md +208 -0
- package/examples/component-snackbar-content.md +92 -0
- package/examples/component-snackbar.md +121 -0
- package/examples/component-sonner.md +165 -0
- package/examples/component-space.md +125 -0
- package/examples/component-spatial-locomotion.md +373 -0
- package/examples/component-spatial-panel.md +330 -0
- package/examples/component-speed-dial-action.md +78 -0
- package/examples/component-speed-dial.md +177 -0
- package/examples/component-spin.md +173 -0
- package/examples/component-spinner.md +204 -0
- package/examples/component-splitter.md +210 -0
- package/examples/component-stack.md +130 -0
- package/examples/component-statistic.md +282 -0
- package/examples/component-step-button.md +157 -0
- package/examples/component-step-connector.md +157 -0
- package/examples/component-step-content.md +121 -0
- package/examples/component-step-icon.md +115 -0
- package/examples/component-step-label.md +101 -0
- package/examples/component-step.md +84 -0
- package/examples/component-steps.md +264 -0
- package/examples/component-stock-chart.md +251 -0
- package/examples/component-swipeable-drawer.md +149 -0
- package/examples/component-switch.md +99 -0
- package/examples/component-tab-scroll-button.md +180 -0
- package/examples/component-tab.md +120 -0
- package/examples/component-table-body.md +82 -0
- package/examples/component-table-cell.md +118 -0
- package/examples/component-table-container.md +75 -0
- package/examples/component-table-footer.md +72 -0
- package/examples/component-table-head.md +78 -0
- package/examples/component-table-pagination.md +137 -0
- package/examples/component-table-row.md +113 -0
- package/examples/component-table-sort-label.md +109 -0
- package/examples/component-table.md +202 -0
- package/examples/component-tabs.md +184 -0
- package/examples/component-tag-badge.md +309 -0
- package/examples/component-tag.md +102 -0
- package/examples/component-testimonial-carousel.md +218 -0
- package/examples/component-textarea-autosize.md +114 -0
- package/examples/component-textarea.md +173 -0
- package/examples/component-time-picker.md +205 -0
- package/examples/component-timeline.md +170 -0
- package/examples/component-toast.md +224 -0
- package/examples/component-toggle-button.md +129 -0
- package/examples/component-toggle.md +220 -0
- package/examples/component-toolbar.md +104 -0
- package/examples/component-tooltip.md +178 -0
- package/examples/component-tour.md +176 -0
- package/examples/component-transaction-list-item.md +243 -0
- package/examples/component-transfer.md +156 -0
- package/examples/component-tree-select.md +202 -0
- package/examples/component-tree.md +297 -0
- package/examples/component-typography.md +215 -0
- package/examples/component-upload.md +295 -0
- package/examples/component-video-hero.md +409 -0
- package/examples/component-video-player.md +340 -0
- package/examples/component-voice-input.md +408 -0
- package/examples/component-watermark.md +217 -0
- package/examples/component-zoom.md +92 -0
- package/examples/doc-explanation-example.md +196 -0
- package/examples/doc-how-to-example.md +205 -0
- package/examples/doc-tutorial-example.md +162 -0
- package/examples/dogfood-korean-fintech-system.md +433 -0
- package/examples/email-transactional-example.md +259 -0
- package/examples/palette-saas-violet.md +235 -0
- package/examples/print-business-card-spec.md +205 -0
- package/examples/print-packaging-spec.md +285 -0
- package/examples/report-example.md +228 -0
- package/examples/slide-deck-example.md +237 -0
- package/examples/website-improvement-report.md +128 -0
- package/examples/website-improvement-workspace.json +126 -0
- package/install.sh +189 -0
- package/knowledge/COVERAGE.md +740 -0
- package/knowledge/PRINCIPLES.md +108 -0
- package/knowledge/a11y/contrast.md +70 -0
- package/knowledge/a11y/keyboard-and-focus.md +108 -0
- package/knowledge/colors/color-theory.md +90 -0
- package/knowledge/colors/mui-palette-structure.md +105 -0
- package/knowledge/colors/palettes-by-product-type.md +876 -0
- package/knowledge/components/INDEX.md +231 -0
- package/knowledge/components/index.json +1470 -0
- package/knowledge/components/shadcn-registry.md +159 -0
- package/knowledge/conversational/ai-chat-interfaces.md +323 -0
- package/knowledge/conversational/chatbot-design.md +312 -0
- package/knowledge/conversational/conversational-ui-fundamentals.md +299 -0
- package/knowledge/conversational/korean-voice-conventions.md +281 -0
- package/knowledge/conversational/voice-ui-patterns.md +297 -0
- package/knowledge/design-tokens/ant-design.md +124 -0
- package/knowledge/design-tokens/material-3.md +235 -0
- package/knowledge/design-tokens/polaris-and-carbon.md +231 -0
- package/knowledge/design-tokens/tailwind-v4.md +284 -0
- package/knowledge/game-ui/game-accessibility.md +317 -0
- package/knowledge/game-ui/game-ui-fundamentals.md +281 -0
- package/knowledge/game-ui/hud-design.md +324 -0
- package/knowledge/game-ui/korean-gaming-conventions.md +312 -0
- package/knowledge/game-ui/menu-systems.md +388 -0
- package/knowledge/i18n/korean-app-store-visual.md +223 -0
- package/knowledge/i18n/korean-document-style.md +301 -0
- package/knowledge/i18n/korean-payments.md +211 -0
- package/knowledge/i18n/korean-product-conventions.md +96 -0
- package/knowledge/i18n/korean-publishing.md +139 -0
- package/knowledge/i18n/korean-typography.md +123 -0
- package/knowledge/icons/curated-sets.md +225 -0
- package/knowledge/illustration/hero-illustrations.md +234 -0
- package/knowledge/illustration/illustration-systems.md +221 -0
- package/knowledge/illustration/mascot-design.md +208 -0
- package/knowledge/illustration/spot-illustrations.md +246 -0
- package/knowledge/illustration/svg-optimization.md +308 -0
- package/knowledge/layout/spacing-and-grid.md +119 -0
- package/knowledge/motion/app-loading-sequences.md +277 -0
- package/knowledge/motion/choreography-depth.md +297 -0
- package/knowledge/motion/marketing-motion.md +223 -0
- package/knowledge/motion/micro-interactions.md +266 -0
- package/knowledge/motion/motion-tools.md +281 -0
- package/knowledge/motion/principles.md +126 -0
- package/knowledge/patterns/auth-flow-design.md +316 -0
- package/knowledge/patterns/b2b-onboarding-flows.md +182 -0
- package/knowledge/patterns/brand-identity.md +238 -0
- package/knowledge/patterns/brand-references.md +97 -0
- package/knowledge/patterns/chart-color-encoding.md +269 -0
- package/knowledge/patterns/chart-types.md +344 -0
- package/knowledge/patterns/dashboard-composition.md +299 -0
- package/knowledge/patterns/design-system-qa.md +356 -0
- package/knowledge/patterns/document-typography.md +248 -0
- package/knowledge/patterns/email-design.md +338 -0
- package/knowledge/patterns/empty-states.md +263 -0
- package/knowledge/patterns/error-states.md +318 -0
- package/knowledge/patterns/form-design.md +237 -0
- package/knowledge/patterns/information-architecture.md +341 -0
- package/knowledge/patterns/landing-hero-design.md +283 -0
- package/knowledge/patterns/landing-page-patterns.md +681 -0
- package/knowledge/patterns/list-and-feed.md +371 -0
- package/knowledge/patterns/mobile-navigation.md +278 -0
- package/knowledge/patterns/money-and-amount.md +301 -0
- package/knowledge/patterns/onboarding.md +300 -0
- package/knowledge/patterns/pricing-page-design.md +261 -0
- package/knowledge/patterns/realtime-data.md +280 -0
- package/knowledge/patterns/report-design.md +330 -0
- package/knowledge/patterns/search-ux.md +373 -0
- package/knowledge/patterns/settings-page.md +325 -0
- package/knowledge/patterns/slide-deck-design.md +316 -0
- package/knowledge/patterns/styles-catalog.md +2599 -0
- package/knowledge/patterns/technical-writing.md +306 -0
- package/knowledge/patterns/ui-reasoning.md +1853 -0
- package/knowledge/patterns/ux-guidelines.md +1454 -0
- package/knowledge/platforms/react-native.md +395 -0
- package/knowledge/print/brochures-and-flyers.md +276 -0
- package/knowledge/print/korean-print-conventions.md +284 -0
- package/knowledge/print/packaging.md +321 -0
- package/knowledge/print/print-fundamentals.md +238 -0
- package/knowledge/print/signage-and-posters.md +235 -0
- package/knowledge/print/stationery.md +262 -0
- package/knowledge/spatial/ar-patterns.md +253 -0
- package/knowledge/spatial/comfort-and-accessibility.md +245 -0
- package/knowledge/spatial/spatial-design-fundamentals.md +346 -0
- package/knowledge/spatial/spatial-ui-elements.md +343 -0
- package/knowledge/spatial/vr-patterns.md +302 -0
- package/knowledge/typography/font-pairings.md +332 -0
- package/knowledge/typography/mui-type-scale.md +57 -0
- package/knowledge/typography/type-scale-fundamentals.md +105 -0
- package/knowledge/video/in-product-video.md +277 -0
- package/knowledge/video/korean-video-conventions.md +247 -0
- package/knowledge/video/marketing-video.md +258 -0
- package/knowledge/video/social-and-short-form.md +257 -0
- package/knowledge/video/video-fundamentals.md +296 -0
- package/package.json +106 -0
- package/skills/README.md +39 -0
- package/skills/color-palette/PLAYBOOK.md +175 -0
- package/skills/color-palette/SKILL.md +6 -0
- package/skills/color-palette/TEMPLATE.md +103 -0
- package/skills/component-spec-writer/PLAYBOOK.md +169 -0
- package/skills/component-spec-writer/SKILL.md +6 -0
- package/skills/component-spec-writer/TEMPLATE.md +115 -0
- package/skills/conversational-ui-designer/PLAYBOOK.md +231 -0
- package/skills/conversational-ui-designer/SKILL.md +6 -0
- package/skills/design-broadcast/PLAYBOOK.md +146 -0
- package/skills/design-broadcast/SKILL.md +6 -0
- package/skills/design-critique/PLAYBOOK.md +137 -0
- package/skills/design-critique/SKILL.md +6 -0
- package/skills/design-pr-review/PLAYBOOK.md +171 -0
- package/skills/design-pr-review/SKILL.md +6 -0
- package/skills/design-system-builder/PLAYBOOK.md +218 -0
- package/skills/design-system-builder/SKILL.md +6 -0
- package/skills/design-system-qa/PLAYBOOK.md +163 -0
- package/skills/design-system-qa/SKILL.md +6 -0
- package/skills/document-author/PLAYBOOK.md +167 -0
- package/skills/document-author/SKILL.md +6 -0
- package/skills/figma-token-sync/PLAYBOOK.md +149 -0
- package/skills/figma-token-sync/SKILL.md +6 -0
- package/skills/game-ui-designer/PLAYBOOK.md +209 -0
- package/skills/game-ui-designer/SKILL.md +6 -0
- package/skills/handoff-spec/PLAYBOOK.md +170 -0
- package/skills/handoff-spec/SKILL.md +6 -0
- package/skills/illustration-designer/PLAYBOOK.md +166 -0
- package/skills/illustration-designer/SKILL.md +6 -0
- package/skills/motion-designer/PLAYBOOK.md +223 -0
- package/skills/motion-designer/SKILL.md +6 -0
- package/skills/print-designer/PLAYBOOK.md +209 -0
- package/skills/print-designer/SKILL.md +6 -0
- package/skills/slide-deck-author/PLAYBOOK.md +198 -0
- package/skills/slide-deck-author/SKILL.md +6 -0
- package/skills/spatial-designer/PLAYBOOK.md +238 -0
- package/skills/spatial-designer/SKILL.md +6 -0
- package/skills/ux-audit/PLAYBOOK.md +142 -0
- package/skills/ux-audit/SKILL.md +6 -0
- package/skills/video-designer/PLAYBOOK.md +240 -0
- package/skills/video-designer/SKILL.md +6 -0
- package/skills/website-improvement/PLAYBOOK.md +118 -0
- package/skills/website-improvement/SKILL.md +6 -0
- package/skills/website-improvement/TEMPLATE.md +103 -0
- package/tools/audit/changelog-generate.py +176 -0
- package/tools/audit/check-coverage.py +483 -0
- package/tools/audit/doctor_assertions.py +256 -0
- package/tools/audit/example-qa.py +108 -0
- package/tools/audit/frontmatter-check.py +199 -0
- package/tools/audit/integration-check.py +95 -0
- package/tools/audit/korean-copy-check.py +161 -0
- package/tools/audit/link-check.py +146 -0
- package/tools/audit/local-ci.py +558 -0
- package/tools/audit/package-contents.py +723 -0
- package/tools/audit/package-smoke.py +22443 -0
- package/tools/audit/raw-hex-check.py +252 -0
- package/tools/audit/registry-smoke.py +8188 -0
- package/tools/audit/release-metadata.py +9832 -0
- package/tools/audit/run-all.py +351 -0
- package/tools/audit/smoke_assertions.py +12742 -0
- package/tools/audit/stability-review.py +332 -0
- package/tools/audit/stale-check.py +156 -0
- package/tools/migrations/add-version-frontmatter.py +132 -0
- package/tools/migrations/bump-last-updated.py +131 -0
- package/tools/migrations/promote-stability.py +172 -0
- package/tools/preview/README.md +58 -0
- package/tools/preview/render-tokens.py +454 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Product readiness
|
|
2
|
+
|
|
3
|
+
Current status: **core design consulting product is locally release-ready; website improvement control tower, Website Console handoff evidence tracking and CLI/bundle evidence export with verified bundle evidence metadata, target-repo execution checklist metadata, generated bundle contract verification with per-file diagnostics and repair preview/apply, and packed-tarball evidence preservation smoke, public registry Website Console smoke coverage, Website Console MCP readiness probes, MCP probe count telemetry with package/shared smoke self-test coverage for Website Console MCP probe counts, local learning preferences, focused agent backlog reports, preview-only skill proposal reports with Markdown review artifacts, read-only review-check gates, and read-only accepted proposal apply plans, public registry workspace restore-backups readiness smoke, learning restore rollback backup pruning, workspace learning restore-backups readiness, learning restore rollback backup inventory, learning restore rollback backups, learning profile restore, learning profile diff, workspace curation report next actions, workspace learning curation next actions, learning curation Markdown reports, usage-aware learning curation review, workspace learning usage readiness, workspace learning eval freshness checks, sibling workspace learning eval checkpoint auto-detection, shell-safe workspace learning eval commands, workspace learning eval-template hints, learning eval checkpoint templates, learning eval checkpoints, usage sidecar recording/reporting, archive-first learning curation, starter learning bootstrap, explicit check feedback capture, and internal dogfood readiness snapshots are shipped; model training is not part of the shipped product.**
|
|
4
|
+
|
|
5
|
+
This document separates shipped product scope from future product ideas so the roadmap does not imply that every possible AI feature is already complete.
|
|
6
|
+
|
|
7
|
+
## TL;DR
|
|
8
|
+
|
|
9
|
+
| Area | Status | Evidence | Remaining work |
|
|
10
|
+
|---|---|---|---|
|
|
11
|
+
| Design consulting skills | Complete for v4.55 | 20 skills across design systems, website improvement, UX audit, critique, handoff, motion, illustration, print, video, game UI, conversational UI, and spatial design | Keep knowledge fresh through normal stability review |
|
|
12
|
+
| Design agent workflows | Complete for v4.55 | 17 commands, 4 review agents, route/prompt/pack/check/search/show/examples CLI workflows | Real-CI verification before external launch |
|
|
13
|
+
| Website improvement control tower | Complete for v4.55 | Zero-dependency static Web App under `docs/website-console/`, static Workflow Graph rendering with graph JSON copy/export, browser-local handoff evidence tracking for executed work / verification results / remaining risks / next actions, CLI/bundle evidence export through `design-ai site --json`, `--tasks`, `--report`, and `--bundle`, verified bundle evidence metadata, MCP probe evidence, bundle-check JSON/human and bundle-handoff JSON/prompt boundary metadata for deterministic-local, no-external-call, and no-target-repo-mutation handoff validation, MCP probe count telemetry and package/shared smoke self-test coverage for Website Console MCP probe counts through `--next-actions`, `--bundle-check`, `--bundle-compare`, and `--bundle-handoff` JSON, bundled Website Console `mcp-probes.json` saved probe evidence payload instead of the full `site --mcp-check --probes --json` response, generated bundle contract verification with per-file diagnostics through bundle-check/compare/handoff metadata, repair guidance through bundle-check and bundle-handoff metadata, repair preview/apply through `--bundle-repair` with repair report `--out file` output-file persistence, packed-tarball evidence preservation smoke for non-empty `implementationEvidence`, generated contract counts, generated drift diagnostics, repair guidance, and repair preview/apply through verified bundle paths, `website-improvement` route/skill/command, `design-ai site` sample workspace generation, prompt template listing, MCP readiness check through `--mcp-check`, read-only MCP readiness probes through `--mcp-check --probes`, Markdown MCP action plan export through `--mcp-plan` and `--mcp-plan --probes`, prioritized local operator checklists with read-only probe readiness and probe counts through `--next-actions`, portable workflow graph export through `--graph --json`, complete handoff bundle export with `mcp-probes.json` and downstream MCP probe count JSON through `--bundle --out`, handoff bundle fingerprint verification through `--bundle-check --strict --json`, handoff bundle comparison through `--bundle-compare --strict --json`, target-repo handoff prompt generation through `--bundle-handoff --strict --json`, local handoff bundle repair through `--bundle-repair --yes --json`, refactor task generation, single prompt template export with task selection, plus JSON validation/report/prompt generation, Site Profile, audit checklist, MCP readiness matrix, refactor plan generator, prompt generator, and handoff report export | Future phases can add real MCP connection probes, Playwright/Lighthouse/axe automation, and VS Code Webview reuse |
|
|
14
|
+
| Local release confidence | Complete for v4.55 | `npm run release:check` now passes after the Website Console bundle `mcp-probes.json` saved-payload guard phases, after the Product Readiness and release-facing policy docs bundle boundary metadata guards for bundle-check JSON/human and bundle-handoff JSON/prompt boundary metadata plus full `release:self-test` evidence recording, after the release-facing policy docs guard for Website Console bundle boundary metadata full `release:check` evidence, and after the release-facing policy docs Product Readiness release policy full gate evidence guard, covering unit tests, strict audits, whitespace checks, package contents, release metadata, release self-tests, the full `npm run release:self-test` chain across shared smoke assertions, package smoke, registry smoke, release metadata, local CI, and token extractor self-tests, and packed-tarball smoke including workspace strict failure/success readiness checks plus workspace `--learning-usage` sidecar summaries and workspace `--learning-eval` checkpoint summaries and `design-ai workspace` workspace learning restore-backups readiness with restore rollback backup inventory, Website Console export validation through `design-ai site --stdin --json`, Website Console sample workspace generation through `design-ai site --sample`, Website Console from-intake workspace JSON stdout, JSON `--out`, and handoff bundle coverage through `design-ai site --from-intake`, Website Console project init workspace coverage through `design-ai site --init` in installed-bin and one-shot paths, Website Console init handoff bundle coverage through `design-ai site --init --bundle --out <dir>`, Website Console prompt template listing through `design-ai site --prompt-list --json`, Website Console MCP readiness check through `design-ai site --stdin --mcp-check --json`, Website Console MCP readiness probe check through `design-ai site --stdin --mcp-check --probes --json`, Website Console MCP action plan export through `design-ai site --stdin --mcp-plan`, Website Console workflow graph export through `design-ai site --stdin --graph --json`, Website Console handoff bundle export through `design-ai site --stdin --bundle --out <dir>`, Website Console non-empty evidence preservation through `design-ai site --stdin --report`, `--tasks`, and `--bundle --out <dir>`, Website Console handoff bundle check through `design-ai site <bundle-dir> --bundle-check --strict --json` with SHA-256 checksum verification, bundle digest/fingerprint verification, and generated bundle contract verification plus repair guidance, Website Console handoff bundle compare through `design-ai site <bundle-dir> --bundle-compare <other-bundle-dir> --strict --json` with bundle digest comparison plus warning-state strict smoke coverage that keeps identical warning bundles at `sameBundle: true` while exiting non-zero under `--strict`, Website Console target-repo handoff prompt through `design-ai site <bundle-dir> --bundle-handoff --strict --json` from a verified bundle digest, Website Console bundle repair preview/apply through `design-ai site <bundle-dir> --bundle-repair --yes --json` with repair report `--out file` output-file persistence, Website Console refactor task generation through `design-ai site --stdin --tasks`, Website Console task-selected single prompt generation through `design-ai site --stdin --prompt codex-implementation --task task-homepage-cta`, check learning capture, learning feedback, learn feedback `--out` output-file persistence, backup, redaction, learn JSON `--out` file writes, learn verify `--out` output-file persistence, learn diff JSON output, learn restore JSON output plus learn restore `--out` file-write confirmation, restore rollback backup inventory coverage, restore rollback backup prune preview/apply coverage through `design-ai learn --restore-backups --prune --keep N`, learn import `--out` output-file persistence, learn stats `--out` output-file persistence, human / JSON `design-ai learn --usage` usage sidecar report plus learn usage `--out` file-write confirmation, human / JSON `design-ai learn --eval-template` checkpoint generation plus generated checkpoint strict validation, human / JSON `design-ai learn --eval` checkpoint report plus learn eval `--out` file-write confirmation plus learn eval `--strict` failure gate, learn audit `--out` output-file persistence, `learn --curate` archive-first curation preview/apply plus `--report --out` Markdown report artifacts and usage-aware curation JSON review, verify, diff, restore, import, query-filtered learn list explanation/export, brief-relevant prompt/pack learning selection, prompt/pack learning usage sidecar recording, and audit cleanup guidance | Public registry smoke after publish now also verifies public registry `design-ai site` Website Console export validation, sample workspace coverage, prompt template listing, MCP readiness, MCP action plan, handoff bundle, bundle-check/compare/handoff/repair, refactor task generation, task-selected prompt generation, workspace `--learning-usage` sidecar summaries, workspace `--learning-eval` checkpoint summaries, public registry `design-ai workspace` workspace restore-backups readiness with restore rollback backup inventory, public registry `design-ai learn --eval-template` checkpoint generation plus public registry generated checkpoint strict validation, public registry JSON `design-ai learn --restore` preview/apply output plus public registry learn restore `--out` file-write confirmation, public registry learn restore rollback backup verification, public registry learn restore `--backup-file` path coverage, public registry `design-ai learn --restore-backups` restore rollback backup inventory coverage, and public registry `design-ai learn --restore-backups --prune` restore rollback backup pruning coverage |
|
|
15
|
+
| Internal dogfood readiness | Complete for v4.55 | `design-ai workspace` reports read-only git cleanliness/sync, separates active status from ignored untracked local portfolio/evidence artifacts in JSON, canonical repository remote/metadata alignment, local learning profile audit state, usage sidecar event counts and stale selected-id readiness, optional or auto-detected sibling learning usage sidecar status, optional or auto-detected sibling learning eval checkpoint status, freshness warnings for checkpoint metadata that predates or mismatches the active learning profile, release-script availability, shell-safe learning profile/usage/checkpoint/report path commands in workspace next actions, usage-aware curation next actions plus companion `learn --curate --report --out learning-curation-report.md` report artifact commands for learning profile audit warnings and usage sidecar drift, and eval-template bootstrap next-action hints when a clean learning profile has entries but no checkpoint, sibling restore rollback backup inventory readiness, latest backup metadata, and prune next-action hints when older rollback backups exceed the default keep count; `--strict` exits non-zero on readiness warnings/failures; package smoke verifies strict JSON failure and clean-success behavior plus learning-usage, learning-eval, and workspace restore-backups summaries in installed-bin and one-shot paths, and registry smoke verifies the same learning-eval and workspace restore-backups contracts plus public registry Website Console coverage and public registry eval-template checkpoint generation after publish | Use findings to decide whether the next surface should be CLI, web UI, VS Code, Figma, or SDK |
|
|
16
|
+
| AI chat / conversational design consulting | Complete for v4.55 | `conversational-ui-designer`, `/conversational`, and conversational knowledge cover voice, chatbot, and AI chat UX | Keep Korean platform conventions current |
|
|
17
|
+
| Local AI learning preferences | Complete for v4.55 | `design-ai learn`, preview-first `learn --init` starter profile bootstrap, explicit `learn --feedback` keep/improve/avoid guidance with JSON `--out` artifact persistence, explicit `check --learn --yes` capture for local QA warning/failure results, full `learn --backup --json` export, redacted `learn --redact --json` sharing export from local profile / `--from-file` / `--stdin`, safe `--out` file output with `--force` overwrite control for JSON artifacts and export Markdown, non-mutating `learn --verify`, read-only `learn --diff` profile comparison against portable JSON, preview-first `learn --restore` full-profile replacement from portable backups with automatic rollback backup and optional `--backup-file` path, read-only `learn --restore-backups` sibling rollback backup inventory, preview-first `learn --restore-backups --prune --keep N` cleanup that deletes only older rollback backup files after `--yes`, confirmed `learn --import`, query-filtered `learn --list --explain` / `learn --export` without recency fallback, brief-relevant filtered `prompt --with-learning` / `pack --with-learning` with selection scoring metadata, local `learning.usage.json` sidecar events that store selected ids and short brief hashes, read-only `learn --usage` reports for sidecar activity, read-only `learn --signals --report --out learning-signals.md` Markdown signal handoff artifacts, focused read-only `learn --agent-backlog --report --out agent-backlog.md` agent backlog artifacts, preview-only `learn --propose-skills` reports for repeated check-capture skill deltas with `--report --out skill-proposals.md` Markdown review artifacts, read-only `--review-file` decision joins, read-only `--apply-plan` accepted proposal manual apply plans, `--review-template --out skill-proposals.review.json` JSON decision scaffolds, and `--patch --out skill-proposals.patch` unified diff handoffs, `learn --eval-template` runnable checkpoint generation from the active profile, read-only `learn --eval` checkpoint reports for deterministic learning selection QA with `--strict` failure gating, confirmed `learn --forget`/`--clear`, non-mutating `learn --audit` cleanup suggestions / `learn --stats`, safe `learn --audit --fix --dry-run` previews plus confirmed `--fix --yes` cleanup, archive-first `learn --curate` preview/apply with sibling `*.archive.json` preservation, `learn --curate --report --out` Markdown review artifacts, workspace report next actions for saving those artifacts before cleanup, and usage-aware profile-mismatch/stale/unused review hints, and learned-context audit summaries provide explicit local preference memory | Keep privacy boundaries clear as learning scope expands |
|
|
18
|
+
| AI model training | Not shipped scope | README states fine-tuning is outside shipped scope | Define a separate product phase if embeddings or fine-tuning becomes a goal |
|
|
19
|
+
| External launch | Not complete | Launch kit exists, but roadmap still marks external launch as held | Push, observe Real-CI, then publish/announce |
|
|
20
|
+
|
|
21
|
+
## What is complete
|
|
22
|
+
|
|
23
|
+
The shipped product is a model-agnostic design intelligence layer for AI coding agents. It is complete when an agent can:
|
|
24
|
+
|
|
25
|
+
- Route a design request to the right workflow.
|
|
26
|
+
- Load the relevant design knowledge and examples.
|
|
27
|
+
- Produce design-system, component, UX, motion, illustration, print, video, game UI, conversational, spatial, document, and slide-deck artifacts.
|
|
28
|
+
- Prepare website improvement work through a local Site Profile, audit checklist, MCP readiness matrix, refactor plan, prompt generator, browser-local handoff evidence tracker, CLI/bundle evidence export, verified bundle evidence metadata, handoff readiness guidance in bundle README and `summary.json.handoff`, MCP probe count telemetry, generated bundle contract verification with per-file diagnostics and repair preview/apply, and handoff report without mutating the target website repo from design-ai.
|
|
29
|
+
- Check those artifacts for grounding, accessibility, responsive coverage, route-specific quality, and unresolved markers, with optional `check --learn` preview/application for non-pass QA feedback.
|
|
30
|
+
- Inspect the current local dogfood workspace with a read-only `design-ai workspace` snapshot, optionally include `--learning-usage path` and `--learning-eval path`, rely on automatic sibling `learning.usage.json` sidecar and `learning-eval.json` checkpoint detection when available, treat stale or source-mismatched usage sidecars and checkpoint freshness as a readiness warning, follow usage-aware `learn --curate --usage-file` next actions when profile audit or usage drift needs review, save companion `learn --curate --report --out learning-curation-report.md` curation report artifacts before applying archive cleanup, use the eval-template bootstrap next action when profile entries exist without a checkpoint, rely on shell-safe path quoting in learning usage/eval/report next-action commands, or use `design-ai workspace --strict` when warnings should block handoff, before deciding whether to continue development, run verification, capture learning feedback, commit, or push.
|
|
31
|
+
- Store, initialize starter dogfood preferences through preview-first `learn --init`, record explicit keep/improve/avoid feedback, capture local check warning/failure feedback after `--yes`, query-filter with optional list explanations, audit with cleanup suggestions, preview/apply safe audit cleanup, archive duplicate/sensitive entries through `learn --curate --yes` without losing audit history, save `learn --curate --report --out` Markdown curation reports, review usage sidecar profile mismatch, stale selected ids, and unused active entries through advisory usage-aware curation, summarize profile and usage activity, generate runnable eval checkpoint templates, evaluate deterministic learning-selection checkpoints, export, write JSON/export artifacts through safe `--out` file output, create redacted shareable backups from local profiles or portable JSON sources, verify/diff/restore with rollback backup, list restore rollback backups, preview/apply older rollback backup pruning without mutating the active profile, and import portable profiles, forget, and clear explicit local learning preferences, and inject brief-relevant scoped category/limit subsets into prompts/packs only when requested with selection scoring, audit-summary metadata, and privacy-preserving usage sidecar events attached.
|
|
32
|
+
- Install, update, status-check, and uninstall through the packaged CLI.
|
|
33
|
+
- Pass the release gate without relying on manual inspection.
|
|
34
|
+
|
|
35
|
+
As of v4.55, these are covered by the manifest, commands, skills, agents, examples, and release smoke suite, including packed-tarball checks for workspace strict failure/success readiness behavior plus workspace learning-usage summaries and learning-eval summaries, Website Console export validation through `design-ai site --stdin --json`, Website Console sample workspace generation through `design-ai site --sample`, Website Console project init workspace coverage through `design-ai site --init` in installed-bin and one-shot paths, Website Console init handoff bundle coverage through `design-ai site --init --bundle --out <dir>`, Website Console prompt template listing through `design-ai site --prompt-list --json`, Website Console MCP readiness check through `design-ai site --stdin --mcp-check --json`, Website Console MCP readiness probe check through `design-ai site --stdin --mcp-check --probes --json`, Website Console MCP action plan export through `design-ai site --stdin --mcp-plan`, Website Console workflow graph export through `design-ai site --stdin --graph --json`, Website Console handoff bundle export through `design-ai site --stdin --bundle --out <dir>`, Website Console handoff bundle check through `design-ai site <bundle-dir> --bundle-check --strict --json` with SHA-256 checksum verification, bundle digest/fingerprint verification, and generated bundle contract verification plus repair guidance, Website Console handoff bundle compare through `design-ai site <bundle-dir> --bundle-compare <other-bundle-dir> --strict --json` with bundle digest comparison plus warning-state strict smoke coverage that keeps identical warning bundles at `sameBundle: true` while exiting non-zero under `--strict`, Website Console target-repo handoff prompt through `design-ai site <bundle-dir> --bundle-handoff --strict --json` from a verified bundle digest, Website Console bundle repair preview/apply through `design-ai site <bundle-dir> --bundle-repair --yes --json` with repair report `--out file` output-file persistence, Website Console refactor task generation through `design-ai site --stdin --tasks`, Website Console task-selected single prompt generation through `design-ai site --stdin --prompt codex-implementation --task task-homepage-cta`, public registry checks for the same workspace strict contract plus workspace learning-usage sidecar summaries, learning-eval checkpoint summaries, workspace restore-backups readiness, public registry `design-ai site` Website Console export validation, sample workspace coverage, prompt template listing, MCP readiness, MCP action plan, handoff bundle, bundle-check/compare/handoff/repair including warning-state bundle-compare strict smoke coverage, refactor task generation, and task-selected prompt generation after publish, check learning capture, learning feedback, learn feedback `--out` output-file persistence, backup, redaction, learn JSON `--out` file-write confirmation and forced overwrite coverage, portable learning verify `--out` output-file persistence, portable learning diff JSON output, portable learning restore JSON output plus restore `--out` file-write confirmation plus restore rollback backup verification, restore `--backup-file` path coverage, `design-ai learn --restore-backups` restore rollback backup inventory coverage, and design-ai learn --restore-backups --prune restore rollback backup pruning coverage, portable learning import `--out` output-file persistence, learning stats `--out` output-file persistence, human / JSON `design-ai learn --usage` usage sidecar report plus learn usage `--out` file-write confirmation, human / JSON `design-ai learn --eval-template` checkpoint generation plus generated checkpoint strict validation, human / JSON `design-ai learn --eval` checkpoint report plus learn eval `--out` file-write confirmation plus learn eval `--strict` failure gate, learning audit `--out` output-file persistence, archive-first `learn --curate` preview/apply coverage with curation Markdown report output, workspace curation report next actions, and usage-aware curation JSON review, verify, diff, restore, import, query-filtered learn list explanation/export, brief-relevant prompt/pack learning selection, prompt/pack learning usage sidecar recording, and learning audit cleanup suggestions. Public registry smoke also verifies public registry `design-ai workspace` workspace restore-backups readiness with restore rollback backup inventory, public registry `design-ai learn --eval-template` checkpoint generation plus public registry generated checkpoint strict validation, public registry JSON `design-ai learn --restore` preview/apply output plus public registry learn restore `--out` file-write confirmation, public registry learn restore rollback backup verification, public registry learn restore `--backup-file` path coverage, public registry `design-ai learn --restore-backups` restore rollback backup inventory coverage, public registry `design-ai learn --restore-backups --prune` restore rollback backup pruning coverage, learning feedback/init bootstrap, public registry learning feedback `--out` output-file persistence, portable learning verify `--out` output-file persistence, portable learning backup `--out` output-file persistence, public registry learning import `--out` output-file persistence, learning stats `--out` output-file persistence, public registry learning audit `--out` output-file persistence, portable learning import/redact behavior, query-filtered learn list/export behavior, brief-relevant prompt/pack learning selection, and learning audit cleanup suggestions plus safe cleanup dry-run/apply behavior after publish.
|
|
36
|
+
|
|
37
|
+
Local learning preferences are documented in [`AI-LEARNING.md`](AI-LEARNING.md).
|
|
38
|
+
|
|
39
|
+
## What is not complete
|
|
40
|
+
|
|
41
|
+
The product now includes local learning preferences, but it should not be described as having completed AI model learning unless that scope is explicitly added later.
|
|
42
|
+
|
|
43
|
+
Not shipped:
|
|
44
|
+
|
|
45
|
+
- Fine-tuning a model.
|
|
46
|
+
- Training a private model on user artifacts.
|
|
47
|
+
- Embedding index generation for semantic retrieval.
|
|
48
|
+
- Background feedback loops that learn from accepted/rejected design recommendations without an explicit CLI command.
|
|
49
|
+
|
|
50
|
+
These are valid future product ideas, but they are different from the current architecture. The current architecture is deterministic corpus routing, prompt packing, quality checking, scoped local preference injection, and release-smoked CLI distribution.
|
|
51
|
+
|
|
52
|
+
## Current release blockers
|
|
53
|
+
|
|
54
|
+
Only launch-readiness items remain in the active roadmap:
|
|
55
|
+
|
|
56
|
+
- Real-CI verification: push the branch and observe GitHub Actions green.
|
|
57
|
+
- External launch: publish/announce after CI and registry smoke are proven.
|
|
58
|
+
- Reference-link policy: decide whether `refs/` source links remain visible or move behind generated reference pages.
|
|
59
|
+
|
|
60
|
+
## Recommended next decision
|
|
61
|
+
|
|
62
|
+
The next product decision is scope, not another hardening pass:
|
|
63
|
+
|
|
64
|
+
1. If the goal is to ship the current design consulting tool, run the push/Real-CI/public launch path.
|
|
65
|
+
2. If the goal is a deeper AI learning product, open a new phase for retrieval memory, embeddings, or fine-tuning, with explicit data boundaries and privacy constraints.
|
|
66
|
+
3. If the goal is “best design tool” as a broader product, define whether the next surface is CLI, VS Code, web UI, Figma plugin, or agent SDK.
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# 빠른 시작
|
|
2
|
+
|
|
3
|
+
클론부터 첫 디자인 산출물까지 5분.
|
|
4
|
+
|
|
5
|
+
## 1. 설치 (Claude Code)
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
git clone https://github.com/sungjin9288/design-ai.git ~/dev/design-ai
|
|
9
|
+
cd ~/dev/design-ai
|
|
10
|
+
./install.sh
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
20개 스킬, 17개 명령어, 4개 리뷰 에이전트가 `~/.claude/` 아래에 심볼릭 링크로 설치돼요. Claude Code를 다시 시작(또는 새 세션 열기)하면 적용돼요.
|
|
14
|
+
|
|
15
|
+
확인:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
./install.sh --status
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
20 skills, 4 agents, 17 commands가 설치되었다고 나와야 해요.
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
design-ai doctor
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
설치 상태, runtime 전제 조건, symlink target이 의심될 때 이 명령으로 먼저 진단하세요.
|
|
28
|
+
경고가 design-ai symlink 누락뿐이라면 `design-ai doctor --fix`로 갱신하세요.
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
design-ai route "audit a Figma signup flow for Korean fintech" --explain
|
|
32
|
+
design-ai routes
|
|
33
|
+
design-ai prompt "audit a Figma signup flow for Korean fintech"
|
|
34
|
+
design-ai pack "audit a Figma signup flow for Korean fintech" --max-bytes 80000
|
|
35
|
+
design-ai prompt --from-file product-brief.md --route design-review --out prompt.md
|
|
36
|
+
cat product-brief.md | design-ai pack --stdin --out prompt-pack.md
|
|
37
|
+
design-ai pack "audit a Figma signup flow for Korean fintech" --out audit-pack.md
|
|
38
|
+
design-ai check output.md --route component-spec --strict
|
|
39
|
+
design-ai check --examples --route design-from-brief --limit 1
|
|
40
|
+
design-ai check --examples --all-routes --issues-only
|
|
41
|
+
design-ai examples --route component-spec --limit 5
|
|
42
|
+
design-ai learn --remember "Prefer dense Korean product UI" --category korean
|
|
43
|
+
design-ai learn --feedback "Keep audit findings short and evidence-led" --outcome keep
|
|
44
|
+
cat feedback.md | design-ai learn --feedback --stdin --outcome improve --category workflow
|
|
45
|
+
design-ai learn --backup --json --out learning-backup.json
|
|
46
|
+
design-ai learn --redact --json --out learning-redacted.json
|
|
47
|
+
design-ai learn --redact --from-file learning-backup.json --json --out learning-redacted.json --force
|
|
48
|
+
design-ai learn --verify --from-file learning-backup.json
|
|
49
|
+
design-ai learn --import --from-file learning-backup.json --dry-run
|
|
50
|
+
design-ai learn --list --category korean --limit 5
|
|
51
|
+
design-ai learn --list --query "keyboard accessibility" --explain --json
|
|
52
|
+
design-ai learn --audit
|
|
53
|
+
design-ai learn --audit --fix --dry-run
|
|
54
|
+
design-ai learn --stats --json
|
|
55
|
+
design-ai prompt "audit a Figma signup flow" --with-learning --learning-category korean --learning-limit 5
|
|
56
|
+
design-ai search Pretendard --dir knowledge --limit 5
|
|
57
|
+
design-ai show knowledge/PRINCIPLES.md:29
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
맞는 command, 재사용 가능한 agent prompt, portable context bundle, artifact QA, known-good reference, opt-in local preference, 정확한 knowledge file을 찾아야 할 때 CLI route + prompt + pack + check + examples + learn + search + show를 사용하세요. `design-ai route --explain`은 왜 해당 route가 매칭됐는지와 참조 파일이 몇 개 사용 가능한지 보여줘요. 생성된 prompt에는 선택된 route id, routing reason, reference examples, 읽을 파일 목록, 실행 규칙, 추천 `design-ai check output.md --route <id> --strict` 명령, route-aware verification checklist가 포함돼요. 생성된 pack에는 context summary와 truncated/unavailable file warning이 들어가고, 가능한 경우 선택된 reference example file까지 포함돼서 다른 agent에 보내기 전에 bundle이 충분한지 판단할 수 있어요. `design-ai learn`은 local preference entry를 저장하고, 명시적 `--feedback`을 durable keep/improve/avoid guidance로 바꾸며, inline text / `--from-file` / `--stdin` feedback, category/query/limit filtering, 전체 portable `--backup --json`, local profile 또는 portable JSON을 `--redact --from-file` / `--redact --stdin`으로 받아 공유용 redacted `--redact --json` 출력 생성, `--out file` JSON artifact 저장과 `--force` overwrite control, portable JSON `--verify`, `--dry-run` preview와 confirmed `--yes` merge를 포함한 portable import, cleanup suggestion을 포함하는 non-mutating `--audit`, 안전한 `--audit --fix --dry-run` preview와 confirmed `--fix --yes` cleanup, `--stats` summary, confirmed `--forget`/`--clear` control을 지원해요. `learn --list --query --explain`과 `learn --export --query`는 recency fallback 없이 query와 맞는 local preference를 보여주고, list 설명에는 score, matched token, selection reason이 포함돼요. `prompt`/`pack --with-learning`은 명시적으로 요청했을 때만 entry를 포함하며 현재 brief와의 relevance로 먼저 정렬한 뒤 recency로 보완하고, `--learning-category`와 `--learning-limit`으로 주입 범위를 좁히며, warning profile이 보이도록 learned-context audit summary를 함께 넣어요. `design-ai check`는 생성된 Markdown이 grounding, unresolved marker, accessibility, responsive, screen-reader, misuse guidance를 갖췄는지 검사하고, `--route <id>`를 주면 산출물 유형별 route-specific evidence도 함께 점검해요. `--learn --yes`를 추가하면 warn/fail check 결과를 local learning entry로 저장해요. `design-ai check --examples --route <id>`를 쓰면 같은 QA rule로 해당 workflow의 worked example도 검사할 수 있고, `design-ai check --examples --all-routes --issues-only`는 maintainer용 전체 example QA gap summary를 출력해요. `design-ai examples --route <id>`는 선택한 workflow에 맞는 worked output을 찾아줘요. 실제 product/design brief가 shell 한 줄보다 길면 `--from-file` 또는 `--stdin`을 사용하세요. 자동 routing이 거의 맞지만 특정 workflow를 고르고 싶다면 `--route <id>`를 사용하세요. id는 `design-ai routes`, `design-ai route --list`, 또는 `design-ai route "..." --json`에서 확인할 수 있어요.
|
|
61
|
+
|
|
62
|
+
## 2. 첫 번째 작업 세 가지
|
|
63
|
+
|
|
64
|
+
### 작업 1: 컴포넌트 스펙 만들기
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
/design-component-spec Banner
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
다음을 포함한 개발자용 스펙을 받아요:
|
|
71
|
+
- 아나토미 (parts table)
|
|
72
|
+
- API (props, types, defaults)
|
|
73
|
+
- 상태 (default / hover / focus / active / disabled / loading / error)
|
|
74
|
+
- 변형 (size, color, shape)
|
|
75
|
+
- 사용된 토큰
|
|
76
|
+
- ARIA + 키보드 계약
|
|
77
|
+
- 엣지 케이스 (empty / overflow / RTL / 모션 감소)
|
|
78
|
+
- 코드 예제
|
|
79
|
+
- Don't 섹션
|
|
80
|
+
|
|
81
|
+
자연어로 반복 작업: "닫을 수 있는 변형을 추가해줘", "한국어 카피는 어떻게 할까?"
|
|
82
|
+
|
|
83
|
+
### 작업 2: 디자인 리뷰
|
|
84
|
+
|
|
85
|
+
어떤 산출물(스크린샷, Figma 링크, URL)에 대해서든 UX + 접근성 + 디자인 비평을 병렬로 받아요:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
/design-design-review [이미지 또는 URL 붙여넣기]
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
반환되는 것: 최우선 추천 사항, 크리티컬 이슈, 접근성 발견, 고려할 UX 패턴.
|
|
92
|
+
|
|
93
|
+
### 작업 3: 처음부터 만들기
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
/design-from-brief 프리랜서를 위한 한국 핀테크. 인보이스, 경비 추적, 세금 추정. 신뢰감 있고, 차분하고, 모바일 우선. Pretendard 타이포그래피, 블루 위주 팔레트.
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
완전한 디자인 시스템을 생성: 팔레트 + 파운데이션 + 컴포넌트 베이스라인 + 5개 컴포넌트 스타터 셋 + 핸드오프 문서.
|
|
100
|
+
|
|
101
|
+
## 3. 도메인 스킬 시도하기
|
|
102
|
+
|
|
103
|
+
v2 확장에서 7개 새 도메인을 추가했어요. 각각 슬래시 명령어가 있어요:
|
|
104
|
+
|
|
105
|
+
| 명령어 | 용도 |
|
|
106
|
+
|---|---|
|
|
107
|
+
| `/design-motion-design` | 모션 스펙 (CSS / Framer Motion / GSAP / Lottie) |
|
|
108
|
+
| `/design-illustration` | 일러스트레이션 시스템 또는 단일 작업 |
|
|
109
|
+
| `/design-print` | 인쇄물 스펙 (명함, 브로슈어, 패키징) |
|
|
110
|
+
| `/design-video` | 비디오 스펙 (마케팅, 소셜, 인앱) |
|
|
111
|
+
| `/design-game-ui` | 게임 UI 스펙 (HUD, 메뉴, 인벤토리) |
|
|
112
|
+
| `/design-conversational` | 챗봇, 음성 비서, AI 챗 스펙 |
|
|
113
|
+
| `/design-spatial` | VR / AR / Vision Pro 경험 스펙 |
|
|
114
|
+
|
|
115
|
+
예시:
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
/design-motion-design 한국 핀테크 랜딩 페이지 히어로 루프. Toss 스타일 절제. 8초. 모바일 + 데스크톱.
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## 4. 지식 베이스 둘러보기
|
|
122
|
+
|
|
123
|
+
스킬이 컨텍스트가 필요하면 `knowledge/`를 읽어요. 직접 둘러봐도 좋아요:
|
|
124
|
+
|
|
125
|
+
- [`knowledge/PRINCIPLES.md`](../knowledge/PRINCIPLES.md) — 30개 핵심 규칙을 한 페이지로.
|
|
126
|
+
- [`knowledge/COVERAGE.md`](../knowledge/COVERAGE.md) — 무엇이 문서화됐고 무엇이 빈 영역인지.
|
|
127
|
+
- [`knowledge/components/INDEX.md`](../knowledge/components/INDEX.md) — 컴포넌트 커버리지 맵.
|
|
128
|
+
|
|
129
|
+
## 5. 다른 에이전트에서
|
|
130
|
+
|
|
131
|
+
| 에이전트 | 방법 |
|
|
132
|
+
|---|---|
|
|
133
|
+
| **Codex CLI** | 이 폴더를 프로젝트 루트로 열어요. `AGENTS.md`가 자동 로드돼요. |
|
|
134
|
+
| **Cursor** | 이 폴더를 열고 `AGENTS.md`를 `.cursorrules`로 심볼릭 링크. |
|
|
135
|
+
| **Aider** | `aider --read AGENTS.md` |
|
|
136
|
+
| **일반 프롬프트** | 어떤 `skills/*/PLAYBOOK.md` 본문이든 프롬프트에 붙여넣으세요. |
|
|
137
|
+
| **Anthropic SDK** | PLAYBOOK.md를 시스템 프롬프트에 임베드; 관련 `knowledge/*.md` 파일 참조. |
|
|
138
|
+
|
|
139
|
+
각 `PLAYBOOK.md`는 자기 완결적이고 통째로 붙여넣으면 작동해요 — 나머지 레포 없이도.
|
|
140
|
+
|
|
141
|
+
## 한국어 기본값
|
|
142
|
+
|
|
143
|
+
대상 사용자가 한국인이면:
|
|
144
|
+
- 스킬은 B2C에 해요체, B2B / 뱅킹에 합쇼체를 자동 적용해요.
|
|
145
|
+
- Pretendard 타이포그래피가 기본값.
|
|
146
|
+
- 명함 90×50 (국제 85×55 아님).
|
|
147
|
+
- KFDA / 표시광고법 / 정보통신망법 / 게임산업진흥법 컴플라이언스가 인쇄 / 비디오 / 게임 UI 스킬에 내장.
|
|
148
|
+
- 본인인증 (PASS / NICE / KCB) 플로우는 인증 스킬에 포함.
|
|
149
|
+
- 한국 주식 차트 빨간색=상승 (서양과 반대 — `knowledge/i18n/`에 인코딩).
|
|
150
|
+
|
|
151
|
+
스킬 입력에서 오버라이드: "글로벌 1순위, 영문 카피".
|
|
152
|
+
|
|
153
|
+
## 유지보수
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
# refs/ (gitignored 업스트림 소스) 재추출
|
|
157
|
+
./tools/extractors/run-all.sh
|
|
158
|
+
|
|
159
|
+
# 수동으로 검사 실행
|
|
160
|
+
design-ai audit --strict
|
|
161
|
+
|
|
162
|
+
# HTML 토큰 미리보기 렌더링
|
|
163
|
+
python3 tools/preview/render-tokens.py
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
CI는 모든 PR에서 8개 검사를 실행해요.
|
|
167
|
+
|
|
168
|
+
## 다음 단계
|
|
169
|
+
|
|
170
|
+
- [`docs/USING.md`](USING.md) — 에이전트별 설치 심화.
|
|
171
|
+
- [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) — 3계층 아키텍처 설명.
|
|
172
|
+
- [`docs/CONTRIBUTING.md`](CONTRIBUTING.md) — 지식 / 스킬 / 추출기 추가하기.
|
|
173
|
+
- [`docs/PLUGIN-PACKAGING.md`](PLUGIN-PACKAGING.md) — 패키징 세부 사항.
|
|
174
|
+
- [`docs/MCP-INTEGRATION.md`](MCP-INTEGRATION.md) — Figma / Notion / GitHub / Slack / Linear MCP.
|
|
175
|
+
|
|
176
|
+
## 이슈
|
|
177
|
+
|
|
178
|
+
스킬이 잘못된 / 일반적인 / 환각 출력을 만들면: 그건 지식 격차예요. 스킬 이름 + 프롬프트 + 예상 vs 실제로 이슈를 열어주세요. 대부분의 수정은 `knowledge/`에 들어가요 (스킬 자체가 아니라) — 플레이북은 작게, 코퍼스는 크게.
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Quickstart
|
|
2
|
+
|
|
3
|
+
Five minutes from clone to first design output.
|
|
4
|
+
|
|
5
|
+
## 1. Install (Claude Code)
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
git clone https://github.com/sungjin9288/design-ai.git ~/dev/design-ai
|
|
9
|
+
cd ~/dev/design-ai
|
|
10
|
+
./install.sh
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
That symlinks 20 skills, 17 commands, and 4 review agents under `~/.claude/`. Restart Claude Code (or open a new session) to pick them up.
|
|
14
|
+
|
|
15
|
+
Verify:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
./install.sh --status
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Should show 20 skills, 4 agents, 17 commands installed.
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
design-ai doctor
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Use this when install state, runtime prerequisites, or symlink targets look wrong.
|
|
28
|
+
If the only warnings are missing design-ai symlinks, run `design-ai doctor --fix`.
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
design-ai route "audit a Figma signup flow for Korean fintech" --explain
|
|
32
|
+
design-ai routes
|
|
33
|
+
design-ai prompt "audit a Figma signup flow for Korean fintech"
|
|
34
|
+
design-ai pack "audit a Figma signup flow for Korean fintech" --max-bytes 80000
|
|
35
|
+
design-ai prompt --from-file product-brief.md --route design-review --out prompt.md
|
|
36
|
+
cat product-brief.md | design-ai pack --stdin --out prompt-pack.md
|
|
37
|
+
design-ai pack "audit a Figma signup flow for Korean fintech" --out audit-pack.md
|
|
38
|
+
design-ai check output.md --route component-spec --strict
|
|
39
|
+
design-ai check --examples --route design-from-brief --limit 1
|
|
40
|
+
design-ai check --examples --all-routes --issues-only
|
|
41
|
+
design-ai examples --route component-spec --limit 5
|
|
42
|
+
design-ai learn --init
|
|
43
|
+
design-ai learn --remember "Prefer dense Korean product UI" --category korean
|
|
44
|
+
design-ai learn --feedback "Keep audit findings short and evidence-led" --outcome keep
|
|
45
|
+
cat feedback.md | design-ai learn --feedback --stdin --outcome improve --category workflow
|
|
46
|
+
design-ai learn --backup --json --out learning-backup.json
|
|
47
|
+
design-ai learn --redact --json --out learning-redacted.json
|
|
48
|
+
design-ai learn --redact --from-file learning-backup.json --json --out learning-redacted.json --force
|
|
49
|
+
design-ai learn --verify --from-file learning-backup.json
|
|
50
|
+
design-ai learn --import --from-file learning-backup.json --dry-run
|
|
51
|
+
design-ai learn --list --category korean --limit 5
|
|
52
|
+
design-ai learn --list --query "keyboard accessibility" --explain --json
|
|
53
|
+
design-ai learn --audit
|
|
54
|
+
design-ai learn --audit --fix --dry-run
|
|
55
|
+
design-ai learn --stats --json
|
|
56
|
+
design-ai prompt "audit a Figma signup flow" --with-learning --learning-category korean --learning-limit 5
|
|
57
|
+
design-ai search Pretendard --dir knowledge --limit 5
|
|
58
|
+
design-ai show knowledge/PRINCIPLES.md:29
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Use CLI route + prompt + pack + check + examples + learn + search + show when you need the right command, reusable agent prompt, portable context bundle, artifact QA, known-good references, opt-in local preferences, and exact knowledge file. `design-ai route --explain` shows why a route matched and how many referenced files are available. Generated prompts include the selected route id, routing reason, reference examples, files to read, execution rules, a suggested `design-ai check output.md --route <id> --strict` command, and a route-aware verification checklist. Generated packs add a context summary and warnings for truncated or unavailable files, and include the selected reference example files when available, so you can judge whether the bundle is complete before sending it to another agent. `design-ai learn` stores local preference entries, converts explicit `--feedback` into durable keep/improve/avoid guidance, accepts feedback from inline text, `--from-file`, or `--stdin`, supports category/query/limit filtering, creates full portable backups with `--backup --json`, creates shareable redacted backups with `--redact --json` from the local profile or portable JSON via `--redact --from-file` / `--redact --stdin`, writes JSON artifacts with `--out file` and refuses overwrites unless `--force` is provided, validates portable learning JSON with `--verify`, imports portable learning JSON with `--dry-run` preview plus confirmed `--yes` merge, includes non-mutating `--audit` inspection with cleanup suggestions, safe `--audit --fix --dry-run` previews plus confirmed `--fix --yes` cleanup, and `--stats` summaries, and includes confirmed `--forget`/`--clear` controls; `learn --list --query --explain` and `learn --export --query` show matching local preferences without recency fallback, with list explanations for score, matched tokens, and selection reason, while `prompt`/`pack --with-learning` includes entries only when explicitly requested, ranks them against the current brief before falling back to recency, can narrow injection with `--learning-category` plus `--learning-limit`, and carries a learned-context audit summary so warning profiles stay visible. `design-ai check` audits generated Markdown for grounding, unresolved markers, accessibility, responsive, screen-reader, misuse guidance, and route-specific evidence when `--route <id>` is provided. Add `--learn --yes` to capture warning/failure checks as local learning entries. Use `design-ai check --examples --route <id>` to run the same QA rules against worked examples for that workflow, or `design-ai check --examples --all-routes --issues-only` for a maintainer-wide example QA summary focused on gaps. `design-ai examples --route <id>` finds worked outputs for the workflow you selected. Use `--from-file` or `--stdin` for real product/design briefs that are too long for a shell line. Use `--route <id>` when automatic routing is close but you want a specific workflow; get ids from `design-ai routes`, `design-ai route --list`, or `design-ai route "..." --json`.
|
|
62
|
+
|
|
63
|
+
## 2. Three first tasks
|
|
64
|
+
|
|
65
|
+
### Task 1: Spec a component
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
/design-component-spec Banner
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
You get a developer-ready spec covering:
|
|
72
|
+
- Anatomy (parts table)
|
|
73
|
+
- API (props, types, defaults)
|
|
74
|
+
- States (default / hover / focus / active / disabled / loading / error)
|
|
75
|
+
- Variants (size, color, shape)
|
|
76
|
+
- Tokens consumed
|
|
77
|
+
- ARIA + keyboard contract
|
|
78
|
+
- Edge cases (empty / overflow / RTL / reduced motion)
|
|
79
|
+
- Code example
|
|
80
|
+
- Don't section
|
|
81
|
+
|
|
82
|
+
Iterate via natural language: "Add a closable variant", "What about Korean copy?".
|
|
83
|
+
|
|
84
|
+
### Task 2: Design review
|
|
85
|
+
|
|
86
|
+
Get a parallel UX + a11y + design critique on any artifact (screenshot, Figma link, URL):
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
/design-design-review [paste image or URL]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Returns: top recommendation, critical issues, accessibility findings, UX patterns to consider.
|
|
93
|
+
|
|
94
|
+
### Task 3: From scratch
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
/design-from-brief Korean fintech for freelancers — invoice, expense tracking, tax estimation. Trustworthy, calm, mobile-first. Pretendard typography, blue-led palette.
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Generates a complete design system: palette + foundations + component baseline + 5-component starter set + handoff document.
|
|
101
|
+
|
|
102
|
+
## 3. Try a domain skill
|
|
103
|
+
|
|
104
|
+
The v2 expansion added 7 new domains. Each has a slash command:
|
|
105
|
+
|
|
106
|
+
| Command | Use |
|
|
107
|
+
|---|---|
|
|
108
|
+
| `/design-motion-design` | Spec motion (CSS / Framer Motion / GSAP / Lottie) |
|
|
109
|
+
| `/design-illustration` | Design or spec an illustration system |
|
|
110
|
+
| `/design-print` | Spec a print piece (business card, brochure, packaging) |
|
|
111
|
+
| `/design-video` | Spec video for marketing, social, in-product |
|
|
112
|
+
| `/design-game-ui` | Spec game UI (HUD, menus, inventory) |
|
|
113
|
+
| `/design-conversational` | Spec a chatbot, voice assistant, or AI chat |
|
|
114
|
+
| `/design-spatial` | Spec a VR / AR / Vision Pro experience |
|
|
115
|
+
|
|
116
|
+
Example:
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
/design-motion-design Hero loop for Korean fintech landing page. Toss-style restraint. 8 seconds. Mobile + desktop.
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## 4. Browse the knowledge
|
|
123
|
+
|
|
124
|
+
When a skill needs context, it reads `knowledge/`. You can browse directly:
|
|
125
|
+
|
|
126
|
+
- [`knowledge/PRINCIPLES.md`](../knowledge/PRINCIPLES.md) — 30 load-bearing rules in one page.
|
|
127
|
+
- [`knowledge/COVERAGE.md`](../knowledge/COVERAGE.md) — what's documented and what's gap.
|
|
128
|
+
- [`knowledge/components/INDEX.md`](../knowledge/components/INDEX.md) — component coverage map.
|
|
129
|
+
|
|
130
|
+
## 5. For other agents
|
|
131
|
+
|
|
132
|
+
| Agent | How |
|
|
133
|
+
|---|---|
|
|
134
|
+
| **Codex CLI** | Open this dir as project root. `AGENTS.md` is auto-loaded. |
|
|
135
|
+
| **Cursor** | Open this dir; symlink `AGENTS.md` to `.cursorrules`. |
|
|
136
|
+
| **Aider** | `aider --read AGENTS.md` |
|
|
137
|
+
| **Plain prompt** | Paste any `skills/*/PLAYBOOK.md` body into your prompt. |
|
|
138
|
+
| **Anthropic SDK** | Embed PLAYBOOK.md in system prompt; reference relevant `knowledge/*.md` files. |
|
|
139
|
+
|
|
140
|
+
Each `PLAYBOOK.md` is self-contained and works without the rest of the repo if pasted whole.
|
|
141
|
+
|
|
142
|
+
## Korean defaults
|
|
143
|
+
|
|
144
|
+
If your audience is Korean:
|
|
145
|
+
- Skills auto-apply 해요체 (friendly) for B2C, 합쇼체 (formal) for B2B / banking.
|
|
146
|
+
- Pretendard typography is the default.
|
|
147
|
+
- 명함 90×50 (not international 85×55) for business cards.
|
|
148
|
+
- KFDA / 표시광고법 / 정보통신망법 / 게임산업진흥법 compliance built into print / video / game-ui skills.
|
|
149
|
+
- 본인인증 (PASS / NICE / KCB) flows in auth skill.
|
|
150
|
+
- KR stock-chart inversion (red=up, blue=down) in `knowledge/i18n/`.
|
|
151
|
+
|
|
152
|
+
Override via skill input: "international primary, English copy".
|
|
153
|
+
|
|
154
|
+
## Maintaining
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
# Re-extract from refs/ (gitignored upstream sources)
|
|
158
|
+
./tools/extractors/run-all.sh
|
|
159
|
+
|
|
160
|
+
# Run audits manually
|
|
161
|
+
design-ai audit --strict
|
|
162
|
+
|
|
163
|
+
# Render HTML token preview
|
|
164
|
+
python3 tools/preview/render-tokens.py
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
CI runs the eight audits on every PR.
|
|
168
|
+
|
|
169
|
+
## Next
|
|
170
|
+
|
|
171
|
+
- [`docs/USING.md`](USING.md) — per-agent setup deep dive.
|
|
172
|
+
- [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) — three-layer architecture explanation.
|
|
173
|
+
- [`docs/CONTRIBUTING.md`](CONTRIBUTING.md) — adding knowledge / skills / extractors.
|
|
174
|
+
- [`docs/PLUGIN-PACKAGING.md`](PLUGIN-PACKAGING.md) — packaging details (this file).
|
|
175
|
+
- [`docs/MCP-INTEGRATION.md`](MCP-INTEGRATION.md) — Figma / Notion / GitHub / Slack / Linear MCPs.
|
|
176
|
+
|
|
177
|
+
## Issues
|
|
178
|
+
|
|
179
|
+
If a skill produces output that's wrong / generic / hallucinatory: that's a knowledge gap. Open an issue with the skill name + the prompt + expected vs actual. Most fixes land in `knowledge/` (not the skill itself), keeping playbooks small and corpus large.
|