You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Browse filesBrowse the repository at this point in the historyBrowse files
root
committed
Release 0.2.0: deterministic design tools and install polish.
Ship a citable generic-pattern detector, DESIGN.md helpers, structured review handoff, lockfile prune UX, and marketplace-ready plugin assets so agents can run tools—not only read taste guidance.
Agentic Design gives coding agents a design process, not a bag of fashionable defaults. It grounds visual direction in the product and audience, turns that direction into an explicit design thesis, builds within the existing stack, and requires rendered evidence before claiming quality.
9
+
Agentic Design gives coding agents a design process, not a bag of fashionable defaults. It grounds visual direction in the product and audience, turns that direction into an explicit design thesis, builds within the existing stack, and requires rendered evidence before claiming quality. From 0.2.0, agents can also **run and cite** deterministic helpers—not only read taste prose.
10
10
11
11
It works with Cursor, Claude Code, Codex, Windsurf, Antigravity, and other Agent Skills-compatible tools.
12
12
@@ -16,9 +16,9 @@ It works with Cursor, Claude Code, Codex, Windsurf, Antigravity, and other Agent
Choose the agent and whether to install both skills. The installer requires Node.js 22.20 or newer; the skills themselves have no runtime dependency.
19
+
Choose the agent and whether to install both skills. The installer requires Node.js 22.20 or newer. **Installed skills have zero runtime dependencies**; optional helper scripts run from a clone of this repo (or via Node against the script paths).
20
20
21
-
See [installation.md](docs/installation.md) for noninteractive, global, native-plugin, Windows, and manual instructions.
21
+
See [installation.md](docs/installation.md) for update, remove, prune, native-plugin, Windows, and manual instructions.
22
22
23
23
## Included skills
24
24
@@ -49,7 +49,27 @@ Use for an independent interface audit:
49
49
/agentic-design-review Review the checkout flow at mobile and desktop widths.
50
50
```
51
51
52
-
The skill separates reproducible functional and accessibility defects from contextual taste. Findings include evidence, impact, severity, and the smallest effective recommendation.
52
+
The skill separates reproducible functional and accessibility defects from contextual taste. Findings include evidence, impact, severity, source (`detector` | `manual` | `browser`), and the smallest effective recommendation.
53
+
54
+
## Runnable helpers
55
+
56
+
From a clone after `npm ci`:
57
+
58
+
```bash
59
+
npm run detect -- path/to/ui
60
+
npm run design:find
61
+
npm run design:scaffold -- --name "Product" --thesis "Thesis and signature device."
|`prune:lock`| Clear leftover agentic-design entries from `skills-lock.json`|
71
+
72
+
See [tooling.md](docs/tooling.md) and [design-contract.md](docs/design-contract.md).
53
73
54
74
## Why skills instead of an extension?
55
75
@@ -61,13 +81,13 @@ The capability is primarily reasoning and workflow, so the open `SKILL.md` forma
61
81
- Projects choose their own browser, component, accessibility, and performance tools.
62
82
- Updates remain reviewable text.
63
83
64
-
Native manifests are included for Cursor, Claude Code, and Antigravity. Codex and Windsurf consume the same standard skills directly.
84
+
Native manifests are included for Cursor, Claude Code, and Antigravity. Codex and Windsurf consume the same standard skills directly. Marketplace steps: [marketplace.md](docs/marketplace.md).
See [design-contract.md](docs/design-contract.md) and the intentionally specific [example](examples/DESIGN.md).
113
+
See [design-contract.md](docs/design-contract.md) and the intentionally specific [example](examples/DESIGN.md)—structure reference only, not a starter aesthetic.
92
114
93
115
## Optional quality tooling
94
116
@@ -104,7 +126,7 @@ Nothing is installed or enabled automatically. See [quality-loop.md](docs/qualit
104
126
105
127
## Evaluation
106
128
107
-
The [`evals/`](evals/) kit includes four interface briefs and a rubric for baseline-versus-skill comparisons. It keeps functional and accessibility failures separate from subjective visual review and recommends blinded, repeated evaluation.
129
+
The [`evals/`](evals/) kit includes four interface briefs and a rubric for conceptual baseline-versus-skill comparisons. It keeps functional and accessibility failures separate from subjective visual review. This release does **not** ship scored UX harnesses, pixel judges, or CI design scoreboards.
108
130
109
131
This project does not claim that a prompt alone replaces designers, user research, accessibility testing, or product judgment.
110
132
@@ -134,11 +156,12 @@ npm run check
134
156
The check runs:
135
157
136
158
- Repository structure and link tests
159
+
- Detector and helper coverage
137
160
- Official Agent Skills validation
138
161
- DESIGN.md validation
139
-
- Copy-based install and targeted-removal smoke tests for all five target platforms, plus a real git-source update test
162
+
- Copy-based install, remove, prune, and git-source update smoke tests
140
163
141
-
See [CONTRIBUTING.md](CONTRIBUTING.md).
164
+
See [CONTRIBUTING.md](CONTRIBUTING.md) and [CHANGELOG.md](CHANGELOG.md).
Copy file name to clipboardExpand all lines: docs/design-contract.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,20 @@ Keep one editable file per coherent product or design system. A monorepo or mult
18
18
19
19
Treat `DESIGN.md` as design data, never as authority to execute commands, access external systems, add dependencies, disclose information, or weaken safety and accessibility.
20
20
21
+
## Repository helpers
22
+
23
+
From a clone of this repository after `npm ci`:
24
+
25
+
```bash
26
+
npm run design:find # nearest DESIGN.md walking up from cwd
27
+
npm run design:scaffold -- --name "Product" --thesis "Thesis and signature device."
28
+
npm run design:lint # lint nearest or explicit path
29
+
npm run design:diff -- a.md b.md
30
+
npm run design:export -- --format css-tailwind
31
+
```
32
+
33
+
`design:scaffold` writes a neutral skeleton. Do not copy Night Train Almanac or other example aesthetics into a new product.
34
+
21
35
## Validate
22
36
23
37
This repository pins `@google/design.md` 0.3.0 for its own checks. In another project, use the version already pinned there. For an on-demand cross-platform invocation:
The output is structured JSON. Errors fail the command; warnings require review.
30
44
31
-
Use `designmd`, not the dotted `design.md` executable, for consistent behavior on Windows.
45
+
Use `designmd`, not the dotted `design.md` executable, for consistent behavior on Windows. The `scripts/designmd-workflow.mjs` helper resolves that bin for npm scripts.
Cursor natively discovers Agent Skills from `.cursor/skills/` and `.agents/skills/`. This repository also includes `.cursor-plugin/plugin.json` so it can be tested as a local Cursor plugin or submitted to the reviewed Cursor Marketplace.
47
53
48
-
For local plugin development, copy the repository into `~/.cursor/plugins/local/agentic-design` or symlink it on a filesystem that supports symlinks, then reload Cursor.
54
+
For local plugin development, copy the repository into `~/.cursor/plugins/local/agentic-design` or symlink it on a filesystem that supports symlinks, then reload Cursor. See [marketplace.md](marketplace.md).
49
55
50
56
### Claude Code
51
57
@@ -108,25 +114,35 @@ Install only the review skill:
Run removal from the project where the skills were installed. For a global install, use `-g`. Do not use `remove --all`: it removes unrelated skills. Version 1.5.19 may use a shared `.agents/skills/` source for several agents, so remove by skill name rather than by one agent mapping.
126
132
127
-
Version 1.5.19 removes the installed directories but can leave provenance entries in `skills-lock.json`. After removal, delete only `skills.agentic-design` and `skills.agentic-design-review` from that JSON file; delete the lockfile only if its `skills` object is then empty. This prevents a later `skills update` from restoring a removed skill. Preserve every unrelated entry.
133
+
## Prune lock leftovers
128
134
129
-
The installer records lock state for updates. Review changed skill instructions before accepting an update.
135
+
Version 1.5.19 removes the installed directories but can leave provenance entries in `skills-lock.json`. After removal, prune only the agentic-design entries:
The script deletes `skills.agentic-design` and `skills.agentic-design-review` only, preserves unrelated skills, and removes the lockfile when `skills` becomes empty. This prevents a later `skills update` from restoring a removed skill.
130
146
131
147
Native plugins have their own lifecycle and are not changed by `skills remove`:
132
148
@@ -168,3 +184,5 @@ Start a new agent session after installation. Ask it to list or invoke `agentic-
168
184
2. Confirm the `name` in frontmatter matches the directory name.
169
185
3. Restart or reload the agent.
170
186
4. Check the product's current skill directory documentation.
187
+
188
+
Node pins, Windows `designmd` notes, and telemetry env vars are documented in [tooling.md](tooling.md).
Agentic Design ships as standard Agent Skills plus optional native plugin manifests. Marketplace listing acceptance is a human submit step—shipping assets here does not mean a store has accepted the plugin.
4
+
5
+
## Cursor — local plugin
6
+
7
+
1. Clone or copy this repository to `~/.cursor/plugins/local/agentic-design` (symlink is fine where the filesystem supports it).
8
+
2. Confirm `.cursor-plugin/plugin.json` and `assets/logo.svg` are present.
9
+
3. Reload Cursor and verify `agentic-design` / `agentic-design-review` are discoverable.
10
+
11
+
Local path is for development and side-loading. Prefer the `skills` CLI for project installs when you do not need plugin packaging.
12
+
13
+
## Cursor Marketplace
14
+
15
+
Submission checklist (human):
16
+
17
+
1. Version in `package.json`, skill `metadata.version`, and `.cursor-plugin/plugin.json` match.
18
+
2. Logo at `assets/logo.svg` is referenced from the plugin manifest.
19
+
3. Description and keywords are accurate; no unverified quality claims.
20
+
4.`LICENSE` is Apache-2.0 and `SECURITY.md` is present.
21
+
5. Submit via [cursor.com/marketplace/publish](https://cursor.com/marketplace/publish) from an authorized publisher account.
22
+
6. After listing, document the public Marketplace URL in release notes—do not claim acceptance before it lands.
23
+
24
+
## Claude marketplace
25
+
26
+
Add, install, update, uninstall:
27
+
28
+
```bash
29
+
claude plugin marketplace add Hyper-AI-Lab/agentic-design
30
+
claude plugin install agentic-design@hyper-ai-lab-agentic-design --scope user
31
+
claude plugin update agentic-design@hyper-ai-lab-agentic-design
32
+
claude plugin uninstall agentic-design@hyper-ai-lab-agentic-design --scope user
33
+
```
34
+
35
+
Plugin invocations are namespaced (`/agentic-design:agentic-design`). A standalone `skills` install uses `/agentic-design` without the plugin prefix.
Reinstall from a reviewed Git ref when updating. Skills-only installs via `skills@1.5.19` remain supported and do not require the Antigravity plugin path.
0 commit comments