CLI Overview
All 12 commands at a glance with links to per-command pages for the 0.6.1 CLI.
The 12 commands
The CLI wraps every catalog interaction in a short verb. npx -y @webdesignhot/design-md <command> is the canonical one-off form; if you’ve installed globally just design-md <command>. The current catalog uses webdesignhot/0.2 with profile: catalog, while v0.1 remains readable.
| Command | One-line | Reference |
|---|---|---|
add <slug> |
Drop a brand’s DESIGN.md into your repo | add → |
init |
Scaffold a fresh DESIGN.md for your own brand | init → |
list |
List all brands in the catalog | list → |
category <name> |
List brands in a single category | category → |
preview <slug> |
Open the brand’s catalog page in browser | preview → |
lint <file> |
Validate a DESIGN.md against the schema | lint → |
diff <a> <b> |
Token-level diff between two brands | diff → |
export <file> |
Convert to Tailwind, CSS vars, DTCG, or Figma JSON | export → |
theme <slug> |
Pick a specific theme variant for a multi-theme brand | theme → |
extract <url> |
Extract a draft DESIGN.md from any production URL | extract → |
submit <file> |
Open a PR to add your DESIGN.md to the public catalog | submit → |
upgrade <file-or-dir> |
Prepare a v0.1 file for v0.2 without guessing design intent | upgrade → |
12 commands shown (plus help/--help which is just the help screen).
Global flags
| Flag | Use |
|---|---|
--help, -h |
Print help for any command |
--version, -v |
Print the installed CLI version |
--format=json |
(where applicable, e.g. lint, diff) Output as JSON for piping |