better-design 0.7.0 → 0.7.1
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 +20 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,37 +1,33 @@
|
|
|
1
|
-
# better-design
|
|
1
|
+
# better-design
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
MCP server that gives AI coding agents design systems, UI principles, icons, and review rules. [better-design.com](https://better-design.com)
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npx better-design
|
|
8
|
+
npx better-design
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Run it once. The installer detects your installed AI coding tools (Claude Code, Cursor, VS Code… Windsurf, Zed, Cline), writes the config merge-safe, and drops an auto-invoke rule so agents use Better Design on UI work. Get an API key at [better-design.com/mcp](https://better-design.com/mcp).
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
<summary>Manual setup & flags</summary>
|
|
13
|
+
### Flags
|
|
15
14
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
Supported clients: Claude Code, Cursor, VS Code (Copilot), Windsurf, Zed, Cline, Claude Desktop, OpenCode, Amp, Codex CLI, Continue.dev.
|
|
27
|
-
|
|
28
|
-
</details>
|
|
15
|
+
| Flag | Description |
|
|
16
|
+
|------|-------------|
|
|
17
|
+
| `--client <ids>` | Comma-separated client ids to configure (skips detection) |
|
|
18
|
+
| `--global` | Install at user/global scope (default) |
|
|
19
|
+
| `--project` | Install at project scope (current directory) |
|
|
20
|
+
| `--api-key <key>` | Skip prompt for API key |
|
|
21
|
+
| `--no-rule` | Don't write the CLAUDE.md / AGENTS.md auto-invoke rule |
|
|
22
|
+
| `--dry-run` | Show what would change without writing |
|
|
23
|
+
| `--yes, -y` | Non-interactive; use detected clients & defaults |
|
|
24
|
+
| `--help, -h` | Show help |
|
|
29
25
|
|
|
30
26
|
## What you can ask
|
|
31
27
|
|
|
32
|
-
- **"use better-design"** → pick a system from the catalog;
|
|
33
|
-
- **"create a design system that…"** → generates a custom one and hands back a single `npx shadcn add` command
|
|
34
|
-
- **Building any UI** →
|
|
28
|
+
- **"use better-design"** → pick a system from the catalog; installs tokens + every component via shadcn.
|
|
29
|
+
- **"create a design system that…"** → generates a custom one and hands back a single `npx shadcn add` command.
|
|
30
|
+
- **Building any UI** → auto-loads design principles + WCAG / visual review rules so output isn't generic AI slop.
|
|
35
31
|
|
|
36
32
|
## Tools
|
|
37
33
|
|
|
@@ -45,6 +41,6 @@ Supported clients: Claude Code, Cursor, VS Code (Copilot), Windsurf, Zed, Cline,
|
|
|
45
41
|
| `get-ui-principle` | UI principles (spacing, color, hierarchy, typography, depth…) |
|
|
46
42
|
| `get-ux-principle` | UX principles (forms, navigation, errors, onboarding…) |
|
|
47
43
|
| `get-review-rules` | WCAG 2.1 + visual design review checklists |
|
|
48
|
-
| `resolve-icon-library` · `search-icons` · `install-icons` · `detect-icon-library` | Find, search,
|
|
44
|
+
| `resolve-icon-library` · `search-icons` · `install-icons` · `detect-icon-library` | Find, search, scaffold inline SVG icons |
|
|
49
45
|
|
|
50
46
|
> After install, set `"style": "new-york"` in `components.json` before running the shadcn command (the default `base-nova` style rewrites Radix `asChild` and breaks components). The returned install instructions include this.
|