-
Notifications
You must be signed in to change notification settings - Fork 0
faq
Short answers, with links to the longer ones.
A versioned design contract in your repo (.specui/) plus a CLI to scaffold it, validate it, sync a registry index, pull shadcn items, export tokens, and wire coding agents. See Introduction.
shadcn copies component source into your app. SpecUI holds the full spec (tokens, brand, patterns, rules, manifests) and can vendor shadcn files under .specui/components/.../vendor/ via specui get. See Registries and Scenarios — shadcn.
DESIGN.md is typically one file for agents. SpecUI is many files, CI-validated, with a registry. You can export to DESIGN.md: specui export --format designmd. See DESIGN.md bridge.
Only the npm package @logicplanes/specui. It provides the specui command. Your project gets .specui/ when you run specui init. Install.
No. npx @logicplanes/specui@latest <command> is enough. Global install is just a convenience.
.specui/ in app |
Flat repo | |
|---|---|---|
| Command | specui init |
specui new |
| Use | Product codebase | Publishable design system |
- Root
AGENTS.md(SpecUI block) -
.specui/AGENTS-GUIDE.md,AGENT-DESIGN-RULES.md,SPEC.md/readOrder
npx specui validate .specui --strictOptional: sync + diff on registry.json. CI/CD.
Common causes: a required component missing from the preset, a stale AGENTS.md block, broken registry links, or contrast warnings under --strict. Troubleshooting · Validation.
init, add, validate, sync, and export all work offline. specui get needs network unless you use file:// JSON. Install — offline.
CLI reference, or specui --help in the terminal.
Contributing — edit wiki/, run tests, PR to dev.
Use https://logicplanes.github.io/specui/docs/ (not /specui/specui/docs). Troubleshooting.
Getting started
How-to guides
- Scenarios
- Tokens And Components
- Agents And Mcp
- Agent Prompts
- Ci Cd
- Distribution
- Registries
- Interop
- Designmd
- Validation
- Troubleshooting
Reference
Community