impeccable 4.7.0 → 4.8.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 +13 -6
- package/README.npm.md +13 -6
- package/README.repo.md +114 -419
- package/cli/bin/cli.js +49 -15
- package/package.json +8 -7
- package/skill/scripts/engine-checksums.txt +9 -0
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Impeccable CLI
|
|
2
2
|
|
|
3
|
-
Detect UI anti-patterns and design quality issues from the command line, and install the Impeccable design skill into your AI coding harness. The detector scans HTML, CSS, JSX, TSX, Vue, and Svelte files for
|
|
3
|
+
Detect UI anti-patterns and design quality issues from the command line, and install the Impeccable design skill into your AI coding harness. The detector scans HTML, CSS, JSX, TSX, Vue, and Svelte files for 62 deterministic rules, including AI-generated UI tells, accessibility violations, and general design quality problems.
|
|
4
4
|
|
|
5
5
|
The npm package is a small launcher. It runs the `impeccable` engine binary for your platform, installed alongside it as an optional dependency (`@impeccable/cli-<os>-<arch>`), and falls back to a per-user cache or a one-time download when that package is missing.
|
|
6
6
|
|
|
@@ -36,6 +36,11 @@ npx impeccable detect https://example.com
|
|
|
36
36
|
|
|
37
37
|
# JSON output for CI/tooling
|
|
38
38
|
npx impeccable detect --json src/
|
|
39
|
+
|
|
40
|
+
# GitHub Actions annotations
|
|
41
|
+
npx impeccable detect --github src/
|
|
42
|
+
# Catalog of detector rules (no scan)
|
|
43
|
+
npx impeccable detect --list-rules
|
|
39
44
|
```
|
|
40
45
|
|
|
41
46
|
`npx impeccable skills <command>` is the legacy namespace and still works.
|
|
@@ -57,7 +62,7 @@ npx impeccable detect --json src/
|
|
|
57
62
|
|
|
58
63
|
**Quality**: tiny body text, cramped padding, long line lengths, small touch targets
|
|
59
64
|
|
|
60
|
-
|
|
65
|
+
62 deterministic detector rules in total. See the full catalog at [impeccable.style/slop](https://impeccable.style/slop).
|
|
61
66
|
|
|
62
67
|
## Exit Codes
|
|
63
68
|
|
|
@@ -65,16 +70,18 @@ npx impeccable detect --json src/
|
|
|
65
70
|
- `1`: at least one requested target could not be scanned
|
|
66
71
|
- `2`: scan completed with primary findings
|
|
67
72
|
|
|
68
|
-
Operational failure takes precedence when a multi-target scan is partial. In JSON mode, stdout remains a findings array and diagnostics are written to stderr.
|
|
73
|
+
Operational failure takes precedence when a multi-target scan is partial. In JSON mode, stdout remains a findings array and diagnostics are written to stderr. With `--github`, stdout is one GitHub Actions annotation per finding; GitHub displays at most 10 annotations of each type per step and 50 per job, and the rest stay in the log.
|
|
69
74
|
|
|
70
75
|
## Options
|
|
71
76
|
|
|
72
77
|
```
|
|
73
78
|
impeccable detect [options] [file-or-dir-or-url...]
|
|
74
79
|
|
|
75
|
-
--json
|
|
76
|
-
--
|
|
77
|
-
--
|
|
80
|
+
--json Output findings as JSON
|
|
81
|
+
--github Write GitHub Actions annotations for each finding
|
|
82
|
+
--list-rules Print the detector rule catalog and exit
|
|
83
|
+
--scope Only report rules in a design domain (type, layout)
|
|
84
|
+
--help Show help
|
|
78
85
|
```
|
|
79
86
|
|
|
80
87
|
## Requirements
|
package/README.npm.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Impeccable CLI
|
|
2
2
|
|
|
3
|
-
Detect UI anti-patterns and design quality issues from the command line, and install the Impeccable design skill into your AI coding harness. The detector scans HTML, CSS, JSX, TSX, Vue, and Svelte files for
|
|
3
|
+
Detect UI anti-patterns and design quality issues from the command line, and install the Impeccable design skill into your AI coding harness. The detector scans HTML, CSS, JSX, TSX, Vue, and Svelte files for 62 deterministic rules, including AI-generated UI tells, accessibility violations, and general design quality problems.
|
|
4
4
|
|
|
5
5
|
The npm package is a small launcher. It runs the `impeccable` engine binary for your platform, installed alongside it as an optional dependency (`@impeccable/cli-<os>-<arch>`), and falls back to a per-user cache or a one-time download when that package is missing.
|
|
6
6
|
|
|
@@ -36,6 +36,11 @@ npx impeccable detect https://example.com
|
|
|
36
36
|
|
|
37
37
|
# JSON output for CI/tooling
|
|
38
38
|
npx impeccable detect --json src/
|
|
39
|
+
|
|
40
|
+
# GitHub Actions annotations
|
|
41
|
+
npx impeccable detect --github src/
|
|
42
|
+
# Catalog of detector rules (no scan)
|
|
43
|
+
npx impeccable detect --list-rules
|
|
39
44
|
```
|
|
40
45
|
|
|
41
46
|
`npx impeccable skills <command>` is the legacy namespace and still works.
|
|
@@ -57,7 +62,7 @@ npx impeccable detect --json src/
|
|
|
57
62
|
|
|
58
63
|
**Quality**: tiny body text, cramped padding, long line lengths, small touch targets
|
|
59
64
|
|
|
60
|
-
|
|
65
|
+
62 deterministic detector rules in total. See the full catalog at [impeccable.style/slop](https://impeccable.style/slop).
|
|
61
66
|
|
|
62
67
|
## Exit Codes
|
|
63
68
|
|
|
@@ -65,16 +70,18 @@ npx impeccable detect --json src/
|
|
|
65
70
|
- `1`: at least one requested target could not be scanned
|
|
66
71
|
- `2`: scan completed with primary findings
|
|
67
72
|
|
|
68
|
-
Operational failure takes precedence when a multi-target scan is partial. In JSON mode, stdout remains a findings array and diagnostics are written to stderr.
|
|
73
|
+
Operational failure takes precedence when a multi-target scan is partial. In JSON mode, stdout remains a findings array and diagnostics are written to stderr. With `--github`, stdout is one GitHub Actions annotation per finding; GitHub displays at most 10 annotations of each type per step and 50 per job, and the rest stay in the log.
|
|
69
74
|
|
|
70
75
|
## Options
|
|
71
76
|
|
|
72
77
|
```
|
|
73
78
|
impeccable detect [options] [file-or-dir-or-url...]
|
|
74
79
|
|
|
75
|
-
--json
|
|
76
|
-
--
|
|
77
|
-
--
|
|
80
|
+
--json Output findings as JSON
|
|
81
|
+
--github Write GitHub Actions annotations for each finding
|
|
82
|
+
--list-rules Print the detector rule catalog and exit
|
|
83
|
+
--scope Only report rules in a design domain (type, layout)
|
|
84
|
+
--help Show help
|
|
78
85
|
```
|
|
79
86
|
|
|
80
87
|
## Requirements
|
package/README.repo.md
CHANGED
|
@@ -1,359 +1,174 @@
|
|
|
1
1
|
# Impeccable
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The design vocabulary for your coding agent. Steer with `polish` and `bolder`, review with `critique` and `audit`, and catch AI slop before it ships.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## Why Impeccable?
|
|
8
|
-
|
|
9
|
-
Anthropic's [frontend-design](https://github.com/anthropics/skills/tree/main/skills/frontend-design) was the first widely-used design skill for Claude. Impeccable started from there.
|
|
10
|
-
|
|
11
|
-
Every model trained on the same SaaS templates. Skip the guidance and you get the same handful of tells on every project: Inter for everything, purple-to-blue gradients, cards nested in cards, gray text on colored backgrounds, the rounded-square icon tile above every heading.
|
|
12
|
-
|
|
13
|
-
Impeccable adds:
|
|
14
|
-
- **One setup flow.** `/impeccable init` records durable product truth in `PRODUCT.md`, so later commands know the audience, purpose, operating context, constraints, voice, and evidence without confusing those facts with surface-level visual direction.
|
|
15
|
-
- **24 commands.** A shared design vocabulary with your AI: `polish`, `audit`, `critique`, `distill`, `animate`, `bolder`, `quieter`, and more.
|
|
16
|
-
- **61 deterministic detector rules** plus LLM-only critique checks. The CLI and browser extension run the deterministic rules with no LLM and no API key.
|
|
17
|
-
|
|
18
|
-
## What's Included
|
|
19
|
-
|
|
20
|
-
### The Skill: impeccable
|
|
21
|
-
|
|
22
|
-
The skill installs as one command:
|
|
5
|
+
From your project root:
|
|
23
6
|
|
|
24
7
|
```bash
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
Start every new project with:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
/impeccable init
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
`init` inspects the project, asks only for material gaps in durable product truth, and writes `PRODUCT.md`. Visitor mode and visual direction are chosen later for each surface; incumbent or newly built visual systems are recorded separately in `DESIGN.md`.
|
|
35
|
-
|
|
36
|
-
### 24 Commands
|
|
37
|
-
|
|
38
|
-
All commands are accessed through `/impeccable`:
|
|
39
|
-
|
|
40
|
-
| Command | What it does |
|
|
41
|
-
|---------|--------------|
|
|
42
|
-
| `/impeccable craft` | Full shape-then-build flow with visual iteration |
|
|
43
|
-
| `/impeccable init` | One-time setup: gather durable product context, write PRODUCT.md, configure live mode when applicable, recommend next steps |
|
|
44
|
-
| `/impeccable document` | Generate root DESIGN.md from existing project code |
|
|
45
|
-
| `/impeccable extract` | Pull reusable components and tokens into the design system |
|
|
46
|
-
| `/impeccable shape` | Plan UX/UI before writing code |
|
|
47
|
-
| `/impeccable critique` | UX design review: hierarchy, clarity, emotional resonance |
|
|
48
|
-
| `/impeccable audit` | Run technical quality checks (a11y, performance, responsive) |
|
|
49
|
-
| `/impeccable polish` | Final pass, design system alignment, and shipping readiness |
|
|
50
|
-
| `/impeccable bolder` | Amplify boring designs |
|
|
51
|
-
| `/impeccable quieter` | Tone down overly bold designs |
|
|
52
|
-
| `/impeccable distill` | Strip to essence |
|
|
53
|
-
| `/impeccable harden` | Error handling, i18n, text overflow, edge cases |
|
|
54
|
-
| `/impeccable onboard` | First-run flows, empty states, activation paths |
|
|
55
|
-
| `/impeccable animate` | Add purposeful motion |
|
|
56
|
-
| `/impeccable colorize` | Introduce strategic color |
|
|
57
|
-
| `/impeccable typeset` | Fix font choices, hierarchy, sizing |
|
|
58
|
-
| `/impeccable layout` | Fix layout, spacing, visual rhythm |
|
|
59
|
-
| `/impeccable delight` | Add moments of joy |
|
|
60
|
-
| `/impeccable overdrive` | Add technically extraordinary effects |
|
|
61
|
-
| `/impeccable clarify` | Improve unclear UX copy |
|
|
62
|
-
| `/impeccable adapt` | Adapt for different devices |
|
|
63
|
-
| `/impeccable optimize` | Performance improvements |
|
|
64
|
-
| `/impeccable live` | Visual variant mode: iterate on elements in the browser |
|
|
65
|
-
| `/impeccable generate` | Generate variants of a named element in the live browser, no manual picking |
|
|
66
|
-
|
|
67
|
-
Use `/impeccable pin <command>` to create standalone shortcuts (e.g., `pin audit` creates `/audit`).
|
|
68
|
-
|
|
69
|
-
#### Usage Examples
|
|
70
|
-
|
|
71
|
-
```
|
|
72
|
-
/impeccable audit blog # Audit blog hub + post pages
|
|
73
|
-
/impeccable critique landing # UX design review
|
|
74
|
-
/impeccable polish settings # Final pass before shipping
|
|
75
|
-
/impeccable harden checkout # Add error handling + edge cases
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Or use `/impeccable` directly with a description:
|
|
79
|
-
```
|
|
80
|
-
/impeccable redo this hero section
|
|
8
|
+
npx impeccable install
|
|
81
9
|
```
|
|
82
10
|
|
|
83
|
-
|
|
11
|
+
Reload your coding tool, then run `/impeccable init` in your agent (`$impeccable init` on Codex).
|
|
84
12
|
|
|
85
|
-
|
|
13
|
+
Works with Claude Code, Cursor, Codex CLI, GitHub Copilot, Devin, Replit Agent, Gemini CLI, Grok Build, OpenCode, Google Antigravity, Kiro, Trae, Rovo Dev, Qoder, Mistral Vibe, Pi, Hermes Agent, DeepSeek Harness, and Veto. Full docs live at [impeccable.style/docs](https://impeccable.style/docs).
|
|
86
14
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
- Don't wrap everything in cards or nest cards inside cards
|
|
91
|
-
- Don't use bounce/elastic easing (feels dated)
|
|
15
|
+
| Without Impeccable | With Impeccable |
|
|
16
|
+
|---|---|
|
|
17
|
+
|  |  |
|
|
92
18
|
|
|
93
|
-
|
|
19
|
+
Same model (Fable 5.1), same brief: a fourteen-room family guesthouse on the Ligurian coast. Without Impeccable, it builds the tasteful default: cream page, thin serif, italic accent, pill buttons. With it, the page is built around one picture: the house at night, seen from the water.
|
|
94
20
|
|
|
95
|
-
|
|
21
|
+
For a full project, see the [Neo Mirai case study](https://impeccable.style/cases/neo-mirai): a conference site taken from mockup to shipped page.
|
|
96
22
|
|
|
97
|
-
##
|
|
23
|
+
## Why
|
|
98
24
|
|
|
99
|
-
|
|
25
|
+
Inter for everything. Purple-to-blue gradients. Cards nested in cards, gray text on colored backgrounds, a rounded-square icon tile above every heading. Ask an agent for a page with no other guidance and these show up again and again, across models and projects.
|
|
100
26
|
|
|
101
|
-
|
|
27
|
+
- **Words for what you want.** "Make it pop" leaves your agent to guess. `/impeccable bolder the pricing cards` loads a playbook written for that one move and points it at one target.
|
|
28
|
+
- **A reviewer.** `critique` scores the design against usability heuristics and ranks what to fix first. `audit` checks accessibility, performance, theming, and responsive behavior, with findings ranked P0 (blocking) to P3 (polish).
|
|
29
|
+
- **A slop detector.** 62 deterministic rules flag the tells above, plus quality problems like cramped padding and skipped headings. No LLM, no API key.
|
|
102
30
|
|
|
103
|
-
|
|
31
|
+
Impeccable is strongest on interfaces that already exist: point it at a page or a component and iterate. It builds new pages too; see [Build something new](https://impeccable.style/docs/new-work) for how to get the most out of that harder mode. To start, pick one component:
|
|
104
32
|
|
|
105
|
-
```bash
|
|
106
|
-
npx impeccable install
|
|
107
33
|
```
|
|
108
|
-
|
|
109
|
-
This shows the harness folders or installed CLIs it detected (for example `~/.claude`, `~/.codex`, `~/.grok`, `~/.hermes`, `~/.veto`, or project-local `.cursor`), lets you keep the detected set or customize providers, then asks whether to install into the current project or globally. Use `--providers=claude,codex,cursor,grok,hermes,veto` and `--scope=project|global` to skip those choices in scripts. On Claude Code, Cursor, Codex, GitHub Copilot, and Grok Build, it also installs the provider-native hook manifest for the current project. Veto receives the packaged skill under `~/.veto/skills/` and does not run native Impeccable edit hooks. Works with Cursor, Claude Code, Gemini CLI, Codex CLI, Grok Build, Hermes Agent, Veto, and every other supported tool. Reload your harness afterward.
|
|
110
|
-
|
|
111
|
-
To refresh an existing install, run:
|
|
112
|
-
|
|
113
|
-
```bash
|
|
114
|
-
npx impeccable update
|
|
34
|
+
/impeccable critique the pricing cards
|
|
115
35
|
```
|
|
116
36
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
See [Allow the hook in your harness](https://impeccable.style/docs/hooks#allow-the-hook-in-your-harness) for harness-specific trust and verification steps.
|
|
37
|
+
## How it works
|
|
120
38
|
|
|
121
|
-
|
|
39
|
+
Run `/impeccable init` once per project. It reads your code, asks only what it can't infer (who the product is for, what it needs to do, the constraints), and writes `PRODUCT.md`. Every later command reads it. Run `/impeccable document` to capture your existing visual system in `DESIGN.md`, so changes stay on-brand. [More on context files](https://impeccable.style/docs/context).
|
|
122
40
|
|
|
123
|
-
|
|
41
|
+
Then name a command and a target:
|
|
124
42
|
|
|
125
|
-
```bash
|
|
126
|
-
git submodule add https://github.com/pbakaus/impeccable .impeccable
|
|
127
|
-
npx impeccable link --source=.impeccable --providers=claude,cursor
|
|
128
|
-
git add .gitmodules .impeccable .claude .cursor
|
|
129
|
-
git commit -m "Add Impeccable skills"
|
|
130
43
|
```
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
```bash
|
|
137
|
-
git submodule update --remote .impeccable
|
|
138
|
-
npx impeccable link --source=.impeccable --providers=claude,cursor
|
|
44
|
+
/impeccable critique the onboarding flow
|
|
45
|
+
/impeccable quieter the landing page
|
|
46
|
+
/impeccable polish settings
|
|
47
|
+
/impeccable harden checkout
|
|
139
48
|
```
|
|
140
49
|
|
|
141
|
-
|
|
50
|
+
Or just describe what you want: `/impeccable redo this hero section`. Narrow targets get better results; a single section reviewed closely beats a whole page at a glance. Pin a command you use often with `/impeccable pin audit` to get `/audit` as its own shortcut.
|
|
142
51
|
|
|
143
|
-
|
|
52
|
+
### 24 commands
|
|
144
53
|
|
|
145
|
-
|
|
54
|
+
| | Commands |
|
|
55
|
+
|---|---|
|
|
56
|
+
| **Steer** | `bolder` amplifies safe designs · `quieter` tones down loud ones · `distill` removes what the page doesn't need · `colorize` brings color to a gray interface · `typeset` fixes fonts, hierarchy, and sizing · `layout` fixes spacing and rhythm · `animate` adds transitions and interaction feedback · `delight` adds personality · `overdrive` goes for shaders, spring physics, and scroll-driven effects |
|
|
57
|
+
| **Review** | `critique` is a scored UX review · `audit` is a technical quality report |
|
|
58
|
+
| **Finish** | `polish` is the final pass before shipping · `harden` covers errors, i18n, overflow, and edge cases · `clarify` rewrites unclear copy · `adapt` handles screen sizes and devices · `optimize` fixes loading and rendering performance · `onboard` designs first-run flows and empty states |
|
|
59
|
+
| **Iterate live** | `live` lets you pick an element in the browser and cycle through variants · `generate` produces variants of a named element without manual picking |
|
|
60
|
+
| **Plan and set up** | `shape` plans UX before code · `init` writes `PRODUCT.md` · `document` writes `DESIGN.md` · `extract` pulls repeated patterns into your design system |
|
|
146
61
|
|
|
147
|
-
|
|
148
|
-
code --install-extension renaissance-geek.impeccable
|
|
149
|
-
```
|
|
62
|
+
The 24th, `craft`, is a deprecated alias for a plain build request. Type `/impeccable` alone to see the list in your agent. Each command has its own page: [impeccable.style/docs](https://impeccable.style/docs).
|
|
150
63
|
|
|
151
|
-
|
|
64
|
+
On Codex, open `/skills` or type `$impeccable` instead of the slash command.
|
|
152
65
|
|
|
153
|
-
|
|
154
|
-
```bash
|
|
155
|
-
/plugin marketplace add pbakaus/impeccable
|
|
156
|
-
```
|
|
66
|
+
### Live mode
|
|
157
67
|
|
|
158
|
-
|
|
68
|
+
`/impeccable live` opens your running dev server with an overlay. Select an element, pick a direction, and Impeccable hot-swaps variants in place. Accept one and it is written back to your source. It works with Vite, Next, SvelteKit, Astro, Nuxt, and plain HTML. [Iterate in the browser](https://impeccable.style/tutorials/iterate-live).
|
|
159
69
|
|
|
160
|
-
|
|
161
|
-
```bash
|
|
162
|
-
grok plugin install pbakaus/impeccable#plugin --trust
|
|
163
|
-
```
|
|
70
|
+
Live mode edits a local checkout only; don't inject it into a deployed site or weaken a production CSP to make it work. Applying copy edits runs your `package.json`'s optional `impeccable:manual-edit-validate` script with your permissions, so review it before using live mode in an unfamiliar repo.
|
|
164
71
|
|
|
165
|
-
|
|
72
|
+
Apply sends staged copy edits to your chat agent while a live session is polling. If none has polled in the last minute, it runs the `codex` CLI from your PATH instead (or `claude` when codex is missing), with approvals, permission checks, and sandboxing off (`--dangerously-bypass-approvals-and-sandbox` or `--permission-mode bypassPermissions`) and your environment inherited. Its prompt carries the staged edits, the edited elements' HTML and nearby text, the page URL, and candidate source paths. Set `IMPECCABLE_LIVE_COPY_AGENT=chat` in the environment that starts live mode to keep Apply in your chat session, or `off` to disable Apply. The server reads it once at startup.
|
|
166
73
|
|
|
167
|
-
|
|
74
|
+
## Three ways to run the detector
|
|
168
75
|
|
|
169
|
-
|
|
76
|
+
**In your agent.** The design hook scans every UI file your agent edits and hands the findings back before the agent calls the work done. This is where most slop gets caught: without the hook, the detector only runs when someone remembers to run it. It's available on Claude Code, Cursor, Codex, GitHub Copilot, Grok Build, and Hermes Agent, and the installer sets it up. Say yes. [Automatic design checks](https://impeccable.style/docs/hooks).
|
|
170
77
|
|
|
171
|
-
|
|
78
|
+
**In CI or your terminal.** The CLI needs no agent:
|
|
172
79
|
|
|
173
|
-
**Cursor:**
|
|
174
80
|
```bash
|
|
175
|
-
|
|
81
|
+
npx impeccable detect src/ # scan a directory
|
|
82
|
+
npx impeccable detect https://example.com # scan a rendered page (uses your installed Chrome or Edge)
|
|
83
|
+
npx impeccable detect --json . # machine-readable output
|
|
84
|
+
npx impeccable detect --github src/ # GitHub Actions annotations
|
|
85
|
+
npx impeccable detect --list-rules # every rule with its id and description
|
|
176
86
|
```
|
|
177
87
|
|
|
178
|
-
|
|
179
|
-
> 1. Switch to Nightly channel in Cursor Settings → Beta
|
|
180
|
-
> 2. Enable Agent Skills in Cursor Settings → Rules
|
|
181
|
-
>
|
|
182
|
-
> [Learn more about Cursor skills](https://cursor.com/docs/context/skills)
|
|
88
|
+
Source files like JSX and TSX get the pattern rules only. Rules that need a rendered page, such as low contrast and tiny text, run when you scan a URL, so point the CLI at your dev server too: `npx impeccable detect http://localhost:5173`.
|
|
183
89
|
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
# Project-specific
|
|
187
|
-
cp -r dist/claude-code/.claude your-project/
|
|
90
|
+
Exit code `2` means findings, `1` means a target couldn't be scanned. To allow your brand font everywhere, run `npx impeccable ignores add-value overused-font Inter --reason "Brand font"`. To turn a rule off for one file, add a comment: `<!-- impeccable-disable overused-font: exported brand doc -->`. [Run a detector scan](https://impeccable.style/docs/detector) · [Configuration and ignores](https://impeccable.style/docs/config).
|
|
188
91
|
|
|
189
|
-
|
|
190
|
-
cp -r dist/claude-code/.claude/* ~/.claude/
|
|
191
|
-
```
|
|
92
|
+
**In your browser.** The [Chrome extension](https://chromewebstore.google.com/detail/impeccable/bdkgmiklpdmaojlpflclinlofgjfpabf) overlays the same findings on any live page, yours or anyone else's. [Review with a visual overlay](https://impeccable.style/tutorials/critique-with-overlay).
|
|
192
93
|
|
|
193
|
-
|
|
194
|
-
```bash
|
|
195
|
-
cp -r dist/opencode/.opencode your-project/
|
|
196
|
-
```
|
|
94
|
+
## Installation
|
|
197
95
|
|
|
198
|
-
**DeepSeek Harness:**
|
|
199
96
|
```bash
|
|
200
|
-
|
|
201
|
-
cp -r dist/dsh/.dsh your-project/
|
|
202
|
-
|
|
203
|
-
# Or global (applies to all projects)
|
|
204
|
-
mkdir -p "${DSH_HOME:-$HOME/.dsh}/skills"
|
|
205
|
-
cp -r dist/dsh/.dsh/skills/* "${DSH_HOME:-$HOME/.dsh}/skills/"
|
|
97
|
+
npx impeccable install
|
|
206
98
|
```
|
|
207
99
|
|
|
208
|
-
The
|
|
100
|
+
The installer detects your coding tools, asks whether to install for this project or globally, and offers the design hook where your tool supports one. Accept the hook. Reload your tool afterward. `npx impeccable update` refreshes an existing install. For scripts, pass `--providers=claude,codex,cursor` and `--scope=project|global`.
|
|
209
101
|
|
|
210
|
-
|
|
211
|
-
```bash
|
|
212
|
-
# Global (applies to all projects; uses the active profile, or ~/.hermes by default)
|
|
213
|
-
cp -r dist/hermes/.hermes/skills/* "${HERMES_HOME:-$HOME/.hermes}/skills/"
|
|
102
|
+
Three tools need one more step before the hook runs. In Codex, open `/hooks` and approve the project hook (again after an update that changes it). In Grok Build, run `/hooks-trust` or launch with `--trust`. In Hermes Agent, the hook is a plugin: run `hermes plugins enable impeccable-design-hook` once. [Allow the hook in your harness](https://impeccable.style/docs/hooks#allow-the-hook-in-your-harness).
|
|
214
103
|
|
|
215
|
-
|
|
216
|
-
cp -r dist/hermes/.hermes your-project/
|
|
217
|
-
```
|
|
104
|
+
Node is only needed for `npx`. The skill itself runs a self-contained engine binary that ships next to it or downloads once into `~/.impeccable/bin/`.
|
|
218
105
|
|
|
219
|
-
>
|
|
220
|
-
>
|
|
221
|
-
> treated as a prompt-injection vector). After a project-scoped install, run
|
|
222
|
-
> `hermes skills trust` once from the project root. Global installs into the
|
|
223
|
-
> active `$HERMES_HOME/skills/` (or `~/.hermes/skills/` when unset) load without
|
|
224
|
-
> a trust step. `/impeccable <command>` then
|
|
225
|
-
> routes through the skill's Commands table; the design hook does not install
|
|
226
|
-
> on Hermes (no hook surface).
|
|
227
|
-
>
|
|
228
|
-
> [Learn more about Hermes skills](https://hermes-agent.nousresearch.com/docs/user-guide/features/skills)
|
|
229
|
-
|
|
230
|
-
**Pi:**
|
|
231
|
-
```bash
|
|
232
|
-
cp -r dist/pi/.pi your-project/
|
|
233
|
-
```
|
|
106
|
+
<details>
|
|
107
|
+
<summary><b>Claude Code, Copilot, and Grok plugins</b></summary>
|
|
234
108
|
|
|
235
|
-
**
|
|
236
|
-
```bash
|
|
237
|
-
cp -r dist/gemini/.gemini your-project/
|
|
238
|
-
```
|
|
109
|
+
**Claude Code:** `/plugin marketplace add pbakaus/impeccable`, then open `/plugin` and install Impeccable.
|
|
239
110
|
|
|
240
|
-
|
|
241
|
-
> 1. Install preview version: `npm i -g @google/gemini-cli@preview`
|
|
242
|
-
> 2. Run `/settings` and enable "Skills"
|
|
243
|
-
> 3. Run `/skills list` to verify installation
|
|
244
|
-
>
|
|
245
|
-
> [Learn more about Gemini CLI skills](https://geminicli.com/docs/cli/skills/)
|
|
111
|
+
**GitHub Copilot in VS Code:** install [Impeccable from the Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=renaissance-geek.impeccable) or run `code --install-extension renaissance-geek.impeccable`. Needs VS Code 1.109.3+, Copilot Chat, and a trusted workspace. It installs the skill without the hook. [Details](docs/VSCODE-EXTENSION.md).
|
|
246
112
|
|
|
247
|
-
**
|
|
248
|
-
```bash
|
|
249
|
-
# Project-local
|
|
250
|
-
cp -r dist/agents/.agents your-project/
|
|
251
|
-
mkdir -p your-project/.codex
|
|
252
|
-
cp dist/codex/.codex/hooks.json your-project/.codex/hooks.json
|
|
253
|
-
|
|
254
|
-
# Or install the skill user-wide. Copy .codex/hooks.json into each project
|
|
255
|
-
# where you want the design hook to run.
|
|
256
|
-
mkdir -p ~/.agents/skills
|
|
257
|
-
cp -r dist/agents/.agents/skills/* ~/.agents/skills/
|
|
258
|
-
```
|
|
113
|
+
**Grok Build:** `grok plugin install pbakaus/impeccable#plugin --trust` installs the skill, agents, and hook.
|
|
259
114
|
|
|
260
|
-
>
|
|
115
|
+
</details>
|
|
261
116
|
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
cp -r dist/github/.github your-project/
|
|
265
|
-
```
|
|
117
|
+
<details>
|
|
118
|
+
<summary><b>Git submodule (a pinned version for the whole team)</b></summary>
|
|
266
119
|
|
|
267
|
-
**Trae:**
|
|
268
120
|
```bash
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
# Trae International
|
|
273
|
-
cp -r dist/trae/.trae/skills/* ~/.trae/skills/
|
|
121
|
+
git submodule add https://github.com/pbakaus/impeccable vendor/impeccable
|
|
122
|
+
npx impeccable link --source=vendor/impeccable --providers=claude,cursor
|
|
274
123
|
```
|
|
275
124
|
|
|
276
|
-
|
|
277
|
-
> - **Trae China**: `~/.trae-cn/skills/`
|
|
278
|
-
> - **Trae International**: `~/.trae/skills/`
|
|
279
|
-
>
|
|
280
|
-
> After copying, restart Trae IDE to activate the skills.
|
|
125
|
+
Commit `.gitmodules`, the submodule, and the generated links. Teammates run `git submodule update --init --recursive`. To upgrade, run `git submodule update --remote vendor/impeccable`, rerun the `link` command, and commit. Linking installs skills, not hooks. Existing skill folders stay put unless you pass `--force`.
|
|
281
126
|
|
|
282
|
-
|
|
283
|
-
```bash
|
|
284
|
-
# Project-specific
|
|
285
|
-
cp -r dist/rovo-dev/.rovodev your-project/
|
|
127
|
+
</details>
|
|
286
128
|
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
```
|
|
129
|
+
<details>
|
|
130
|
+
<summary><b>Manual copy, no Node required</b></summary>
|
|
290
131
|
|
|
291
|
-
|
|
292
|
-
```bash
|
|
293
|
-
# Project-specific
|
|
294
|
-
cp -r dist/qoder/.qoder your-project/
|
|
132
|
+
Download the ZIP for your tool from [impeccable.style](https://impeccable.style), or clone this repo: each tool's build is committed at the repo root. Copy `skills/impeccable` from the folder below into the same place in your project, or into the global folder.
|
|
295
133
|
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
134
|
+
| Tool | Repo folder | Global skills folder |
|
|
135
|
+
|---|---|---|
|
|
136
|
+
| Claude Code | `.claude/` | `~/.claude/skills/` |
|
|
137
|
+
| Cursor | `.cursor/` | |
|
|
138
|
+
| Codex CLI, Replit Agent | `.agents/` | `~/.agents/skills/` |
|
|
139
|
+
| Devin | `.devin/` | `${XDG_CONFIG_HOME:-$HOME/.config}/devin/skills/` |
|
|
140
|
+
| GitHub Copilot | `.github/` | |
|
|
141
|
+
| Gemini CLI | `.gemini/` | |
|
|
142
|
+
| Google Antigravity | `.agent/` | `~/.gemini/config/skills/` |
|
|
143
|
+
| OpenCode | `.opencode/` | |
|
|
144
|
+
| Grok Build | `.grok/` | `~/.grok/skills/` |
|
|
145
|
+
| Hermes Agent | `.hermes/` | `${HERMES_HOME:-$HOME/.hermes}/skills/` |
|
|
146
|
+
| DeepSeek Harness | `.dsh/` | `${DSH_HOME:-$HOME/.dsh}/skills/` |
|
|
147
|
+
| Pi | `.pi/` | |
|
|
148
|
+
| Qoder | `.qoder/` | `~/.qoder/skills/` |
|
|
149
|
+
| Rovo Dev | `.rovodev/` | `~/.rovodev/skills/` |
|
|
150
|
+
| Mistral Vibe | `.vibe/` | `~/.vibe/skills/` |
|
|
151
|
+
| Trae | `.trae/` | `~/.trae/skills/` |
|
|
152
|
+
| Trae China | `.trae-cn/` | `~/.trae-cn/skills/` |
|
|
299
153
|
|
|
300
|
-
|
|
301
|
-
```bash
|
|
302
|
-
# Project-specific
|
|
303
|
-
cp -r dist/vibe/.vibe your-project/
|
|
154
|
+
For example: `mkdir -p your-project/.claude/skills && cp -r .claude/skills/impeccable your-project/.claude/skills/`.
|
|
304
155
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
156
|
+
Notes:
|
|
157
|
+
- A manual copy skips the design hook and subagents. Run `npx impeccable install` to get them; it writes each tool's hook pointing at the right skill path.
|
|
158
|
+
- OpenCode also needs `.opencode/commands/impeccable.md` copied into your project's `.opencode/commands/` to provide `/impeccable`.
|
|
159
|
+
- Hermes asks you to trust project-local skills once: run `hermes skills trust` from the project root. Global installs need no trust step.
|
|
160
|
+
- Cursor and Gemini CLI may need Agent Skills enabled in settings. See the [Cursor](https://cursor.com/docs/context/skills) and [Gemini CLI](https://geminicli.com/docs/cli/skills/) skills docs.
|
|
161
|
+
- Restart Trae after copying.
|
|
162
|
+
- `impeccable install` and `update` manage a DeepSeek Harness global copy only when `DSH_HOME` is inside your home directory.
|
|
308
163
|
|
|
309
|
-
|
|
310
|
-
```bash
|
|
311
|
-
# Project-specific
|
|
312
|
-
cp -r dist/grok/.grok your-project/
|
|
164
|
+
</details>
|
|
313
165
|
|
|
314
|
-
|
|
315
|
-
cp -r dist/grok/.grok/skills/* ~/.grok/skills/
|
|
316
|
-
```
|
|
166
|
+
## Project files and git
|
|
317
167
|
|
|
318
|
-
|
|
168
|
+
Impeccable writes its working files under `.impeccable/`. A few are shared project artifacts and belong in the repo: `config.json`, `live/config.json`, `design.json`, `surfaces/*.md`, and `critique/*.md`. Keep `PRODUCT.md` and `DESIGN.md` in the repo too. The rest is screenshots, caches, and runtime state.
|
|
319
169
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
# Project-specific
|
|
323
|
-
cp -r dist/antigravity/.agent your-project/
|
|
324
|
-
|
|
325
|
-
# Or global (applies to all projects)
|
|
326
|
-
mkdir -p ~/.gemini/config/skills
|
|
327
|
-
cp -r dist/antigravity/.agent/skills/* ~/.gemini/config/skills/
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
## Usage
|
|
331
|
-
|
|
332
|
-
Once installed, every command runs through the single `/impeccable` skill:
|
|
333
|
-
|
|
334
|
-
```
|
|
335
|
-
/impeccable audit # Find issues
|
|
336
|
-
/impeccable polish # Final cleanup
|
|
337
|
-
/impeccable distill # Remove complexity
|
|
338
|
-
/impeccable critique # Full design review
|
|
339
|
-
```
|
|
340
|
-
|
|
341
|
-
Type `/impeccable` alone to see the full command list.
|
|
342
|
-
|
|
343
|
-
Most commands accept an optional argument to focus on a specific area:
|
|
344
|
-
|
|
345
|
-
```
|
|
346
|
-
/impeccable audit the header
|
|
347
|
-
/impeccable polish the checkout form
|
|
348
|
-
```
|
|
349
|
-
|
|
350
|
-
If you reach for one command often, pin it with `/impeccable pin audit` to get `/audit` as a standalone shortcut.
|
|
351
|
-
|
|
352
|
-
**Note:** Codex uses skills here, not `/prompts:` commands. Open `/skills` or type `$impeccable`. Repo-local installs live in `.agents/skills/`; user-wide installs live in `~/.agents/skills/`. GitHub Copilot uses `.github/skills/`. Restart the tool if a newly installed skill does not appear.
|
|
353
|
-
|
|
354
|
-
## Keeping `.impeccable` out of git
|
|
355
|
-
|
|
356
|
-
As you run commands, Impeccable writes working files under `.impeccable/`: critique and polish screenshots, live-mode session and preview state, runtime caches, and per-developer config. Most of it is ephemeral and should not be committed, while a few files are shared project artifacts that belong in the repo. Add this block to your project's `.gitignore`:
|
|
170
|
+
<details>
|
|
171
|
+
<summary><b>Copy the <code>.gitignore</code> entries</b></summary>
|
|
357
172
|
|
|
358
173
|
```gitignore
|
|
359
174
|
# impeccable-ignore-start
|
|
@@ -381,149 +196,29 @@ As you run commands, Impeccable writes working files under `.impeccable/`: criti
|
|
|
381
196
|
# impeccable-ignore-end
|
|
382
197
|
```
|
|
383
198
|
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
**Keep these tracked** (they are shared project artifacts, do not add them to `.gitignore`):
|
|
387
|
-
|
|
388
|
-
- `.impeccable/config.json` (unified shared config)
|
|
389
|
-
- `.impeccable/live/config.json` (live-mode framework wiring)
|
|
390
|
-
- `.impeccable/design.json` (shared design spec)
|
|
391
|
-
- `.impeccable/surfaces/*.md` (route- or artifact-specific strategy and direction contracts)
|
|
392
|
-
- `.impeccable/critique/*.md` (review reports)
|
|
393
|
-
|
|
394
|
-
Impeccable also keeps its own `.gitignore` in the folders that hold decision-round state: `.impeccable/questions/` and `.impeccable/mocks/worlds/` ignore everything in them, and `.impeccable/build/` ignores `state.json`. That keeps new runtime files out of commits even in a project without the block above. A `.gitignore` cannot untrack a file git already tracks, though: when one of these files was committed earlier, the next roll prints a one-time notice with the fix, `git rm -r --cached .impeccable/questions` (plus any other folder it names), and writes its roll record to an untracked file until then.
|
|
395
|
-
|
|
396
|
-
If an ephemeral file (a screenshot, `config.local.json`) was committed before you added the block, `.gitignore` will not untrack it automatically. Run `git rm --cached <path>` to stop tracking it without deleting your local copy.
|
|
397
|
-
|
|
398
|
-
## Telemetry
|
|
399
|
-
|
|
400
|
-
When a new design starts, the skill asks the roll API at impeccable.style to deal a hand of visual worlds from the catalog. That request is the feature, so it always happens. Unless you opt out, it also feeds an anonymous record of which hand was shown and which card won, which is how the catalog learns what works.
|
|
401
|
-
|
|
402
|
-
What is sent, on the roll request and on the choice that follows it:
|
|
403
|
-
|
|
404
|
-
- the roll key (a random value per decision round), scope (direction or surface), visitor mode, and re-roll round
|
|
405
|
-
- the catalog revision the hand came from, and on the choice the kind of card that won (assigned, pick, challenger, canon, or a re-roll), its catalog id when a catalog world won, and its position on the page
|
|
406
|
-
- the client version, whether the choice came from the decision page or the agent, and a random id for that choice so a report sent twice is counted once
|
|
407
|
-
|
|
408
|
-
Never sent: your project's name, files, code, PRODUCT.md, or the names of the directions your agent wrote. Committed files such as surface briefs record only a seed reference, a hash of the roll key under a random salt kept in `~/.impeccable/seed-salt`, never the key itself. If no salt can be kept on a machine, the brief records no seed at all rather than a weaker hash. Roll keys are 128 random bits. If you pass your own short key with `--from`, its reference is easy to guess, so do not rely on it to keep that key private.
|
|
409
|
-
|
|
410
|
-
To turn it off, run `npx impeccable telemetry off` (stored in `~/.impeccable/config.json`), or set `DO_NOT_TRACK=1` or `IMPECCABLE_NO_TELEMETRY=1`. A project can opt everyone out with `"telemetry": false` in `.impeccable/config.json`. `npx impeccable telemetry status` shows the current state. Opted out, the roll still works and the API is told not to record it. Details: https://impeccable.style/privacy
|
|
411
|
-
|
|
412
|
-
## Design hook
|
|
413
|
-
|
|
414
|
-
On Claude Code, GitHub Copilot, Codex, Cursor, and Grok Build, `npx impeccable install` and `npx impeccable update` install a provider-native hook manifest along with the skill payload. The hook runs the Impeccable design detector on direct UI file edits and surfaces findings back into the agent flow. Claude Code, GitHub Copilot, and Codex surface findings after the edit (and run a deeper pass on Stop where supported). Grok Build scans after the edit to warm Stop, then surfaces on Stop; PostToolUse stdout never reaches the model. Cursor blocks bad proposed writes before they land.
|
|
415
|
-
|
|
416
|
-
Installed hook surfaces:
|
|
417
|
-
|
|
418
|
-
- Claude Code: `.claude/settings.local.json` (gitignored, machine-local) runs `${CLAUDE_PROJECT_DIR}/.claude/skills/impeccable/scripts/impeccable hook`. A hook moved into the shared `settings.json` is honored in place.
|
|
419
|
-
- GitHub Copilot: `.github/hooks/impeccable.json` (committed, shared by the Copilot CLI and the cloud agent) runs `.github/skills/impeccable/scripts/impeccable hook`. The Copilot CLI activates it once the file is on the repository's default branch and the folder is trusted.
|
|
420
|
-
- Cursor: `.cursor/hooks.json` runs `.cursor/skills/impeccable/scripts/impeccable hook-before-edit`.
|
|
421
|
-
- Codex: `.codex/hooks.json` runs `.agents/skills/impeccable/scripts/impeccable hook`, with a `commandWindows` sibling that calls `impeccable.cmd` for cmd.exe.
|
|
422
|
-
- Grok Build: `.grok/hooks/impeccable.json` runs `.grok/skills/impeccable/scripts/impeccable hook`. Requires `/hooks-trust` or `--trust`. Findings reach the model on Stop, not after each edit.
|
|
423
|
-
|
|
424
|
-
Every command goes through the launcher shipped in the skill's `scripts/` directory (`impeccable`, or `impeccable.cmd` on Windows), guarded so a missing launcher is a silent no-op. The launcher runs the engine binary that ships next to it, or downloads the pinned version once into `~/.impeccable/bin/`. No Node or other runtime is required for the hook or the skill.
|
|
425
|
-
|
|
426
|
-
In Claude Code, installed command hooks run independently of model-tool approval. The first edit or Stop event can therefore download and cache the engine even if the session denies the model's launcher command. Review installed hooks before unattended runs; to disable all Claude Code hooks for a run, pass `--settings '{"disableAllHooks": true}'`. See [Claude Code's hook security guidance](https://code.claude.com/docs/en/hooks#security-considerations).
|
|
427
|
-
|
|
428
|
-
The installer preserves unrelated hook entries and settings. If a hook manifest is malformed, install/update aborts by default; rerun with `--force` to back up the malformed file as `.bak` and replace it.
|
|
429
|
-
|
|
430
|
-
On an interactive `install`/`update`, Impeccable explains the hook and offers to install it (default yes). Your choice is remembered per-developer in the gitignored `.impeccable/config.local.json`, so you are not asked again; `--no-hooks` skips it for that run without recording anything. Hook lifecycle settings live under the `hook` key of `.impeccable/config.json`; detector ignores live under `detector`, shared by `/impeccable hooks` and `npx impeccable detect`.
|
|
431
|
-
|
|
432
|
-
For debugging, set `hook.auditLog` in `.impeccable/config.json` to a path (or the legacy `IMPECCABLE_HOOK_LOG` env var) to write one NDJSON line per hook invocation. Leave it unset for normal use.
|
|
433
|
-
|
|
434
|
-
## Build path: comp-first or code-first
|
|
435
|
-
|
|
436
|
-
When a new surface gets designed, Impeccable either generates a full-fidelity comp first and builds to match it, or builds straight in code with the ambition written into a development-only direction contract in the surface brief and checked at the finish. Comp-first composes bolder and takes longer; code-first is leaner and faster. The choice covers landing pages and showcase surfaces. App screens and documents are built code-first either way, because they come out better built than pictured. `/impeccable init` asks once and records the answer as `buildPath` in `.impeccable/config.json`:
|
|
437
|
-
|
|
438
|
-
```json
|
|
439
|
-
{ "buildPath": "comp" }
|
|
440
|
-
```
|
|
441
|
-
|
|
442
|
-
The values are `comp` and `code`, and nothing else is read. Set it in the gitignored `.impeccable/config.local.json` to override the team's committed value on one machine, which is what you want when your harness has no image generation. In a monorepo, commit it once at the repo root and any workspace that wants something else sets its own. The choice appears at all only where image generation is available, since without it there is nothing to comp.
|
|
443
|
-
|
|
444
|
-
You do not have to re-run `init` to set it on a project that predates the setting, and you do not have to edit the file by hand either. Whatever is recorded is a default rather than a lock: every decision page carries a footer toggle, and flipping it binds that session only. Flip it on a project that has recorded nothing and Impeccable asks once, after the round, whether to keep it, then writes your answer. That is the whole migration path for an existing project: use the toggle when the default is wrong, and answer the question that follows.
|
|
445
|
-
|
|
446
|
-
Codex requires one platform step that Impeccable cannot safely skip: open `/hooks` after install or update and approve the project hook. There is no Codex marketplace/plugin install flow for this hook.
|
|
447
|
-
|
|
448
|
-
Full hook docs: [impeccable.style/docs/hooks](https://impeccable.style/docs/hooks).
|
|
449
|
-
|
|
450
|
-
The Stop pass suppresses confirmed pre-existing findings when a verified before-edit baseline is available (currently Claude Edit/Write results for text scans). Other findings are marked new or attribution unknown; unknown is not evidence that your session caused the problem. Explicit `detect` scans remain unchanged.
|
|
451
|
-
|
|
452
|
-
Manual copy commands are fallback/debug instructions. The normal path is:
|
|
453
|
-
|
|
454
|
-
```bash
|
|
455
|
-
npx impeccable install
|
|
456
|
-
npx impeccable update
|
|
457
|
-
```
|
|
458
|
-
|
|
459
|
-
## Live mode and production sites
|
|
460
|
-
|
|
461
|
-
Live mode edits a local checkout through a development server or local static HTML. Injecting its localhost HTTP helper into a deployed production site, including an HTTPS site, is not supported. Do not disable browser security or weaken production CSP to make it work.
|
|
462
|
-
|
|
463
|
-
Use live mode only in projects you trust to run locally. Applying copy edits automatically runs `package.json`'s optional `scripts["impeccable:manual-edit-validate"]` command in a shell, with your user permissions; review that script before using live mode in an unfamiliar checkout.
|
|
464
|
-
|
|
465
|
-
For production inspection, use `npx impeccable detect https://example.com` or the browser extension. These inspect the rendered page; they do not provide live variant editing or write changes back to your source.
|
|
466
|
-
|
|
467
|
-
## CLI
|
|
468
|
-
|
|
469
|
-
Impeccable includes a standalone CLI for detecting anti-patterns without an AI harness. `npx impeccable` is a small shim that runs the same engine binary the skill uses (installed as a platform-specific optional dependency, or fetched once into `~/.impeccable/bin/`); Node is needed only for `npx` itself, and you can also download the binary directly and put it on your PATH.
|
|
470
|
-
|
|
471
|
-
```bash
|
|
472
|
-
npx impeccable detect src/ # scan a directory
|
|
473
|
-
npx impeccable detect index.html # scan an HTML file
|
|
474
|
-
npx impeccable detect https://example.com # scan a URL (uses an installed Chrome, Chromium, or Edge)
|
|
475
|
-
npx impeccable detect --json . # CI-friendly JSON output
|
|
476
|
-
npx impeccable detect --no-config src/ # raw scan, ignoring project config/context
|
|
477
|
-
npx impeccable ignores list # show detector ignores
|
|
478
|
-
npx impeccable ignores add-file "src/legacy/**"
|
|
479
|
-
npx impeccable ignores add-value overused-font Inter --reason "Brand font"
|
|
480
|
-
```
|
|
481
|
-
|
|
482
|
-
The detector catches 61 deterministic issues across AI slop (side-tab borders, purple gradients, bounce easing, dark glows) and general design quality (line length, cramped padding, small touch targets, skipped headings, and more).
|
|
483
|
-
|
|
484
|
-
Human-readable findings are diagnostics written to stderr, so redirect them with `2> findings.txt`. Use `--json` for machine-readable results on stdout. Exit `0` means the scan completed without primary findings, exit `2` means it completed with primary findings, and exit `1` means at least one requested target could not be scanned; operational failure takes precedence for a partial multi-target scan. URL scans inspect the rendered DOM, computed layout, and accessible linked stylesheets; browser security still prevents reading cross-origin CSS without CORS. A clean detector run is evidence, not proof of visual or accessibility quality: it does not replace inspecting the rendered experience across relevant viewports.
|
|
485
|
-
|
|
486
|
-
By default, `detect` respects the same `.impeccable/config.json` and `.impeccable/config.local.json` detector config as the design hook: `detector.ignoreRules`, `detector.ignoreFiles`, `detector.ignoreValues`, and `detector.designSystem.enabled`. Hook lifecycle settings such as `hook.enabled` only affect automatic hook execution.
|
|
487
|
-
|
|
488
|
-
For a waiver that should travel with one file instead of the repo config, add an inline comment in the file: `<!-- impeccable-disable overused-font: exported brand doc -->`. The marker works in any comment syntax, scopes to the whole file (or one line with `impeccable-disable-line` / `impeccable-disable-next-line`), and is bypassed by `--no-inline-ignores` or `--no-config`.
|
|
199
|
+
</details>
|
|
489
200
|
|
|
490
|
-
|
|
201
|
+
The folders that hold decision-round state (`.impeccable/questions/`, `.impeccable/mocks/worlds/`) also ignore themselves. A `.gitignore` can't untrack a file git already tracks; if you committed one earlier, run `git rm --cached <path>`.
|
|
491
202
|
|
|
492
|
-
##
|
|
203
|
+
## Good to know
|
|
493
204
|
|
|
494
|
-
- [
|
|
495
|
-
- [Claude Code](https://claude.ai/code)
|
|
496
|
-
- [GitHub Copilot](https://github.com/features/copilot)
|
|
497
|
-
- [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)
|
|
498
|
-
- [Gemini CLI](https://github.com/google-gemini/gemini-cli)
|
|
499
|
-
- [Codex CLI](https://github.com/openai/codex)
|
|
500
|
-
- [Grok Build](https://x.ai/cli)
|
|
501
|
-
- [Hermes Agent](https://hermes-agent.nousresearch.com)
|
|
502
|
-
- [OpenCode](https://opencode.ai)
|
|
503
|
-
- [Pi](https://pi.dev)
|
|
504
|
-
- [Kiro](https://kiro.dev)
|
|
505
|
-
- [Trae](https://trae.ai)
|
|
506
|
-
- [Rovo Dev](https://www.atlassian.com/software/rovo)
|
|
507
|
-
- [Qoder](https://qoder.com)
|
|
508
|
-
- [Mistral Vibe](https://docs.mistral.ai/vibe/code/overview)
|
|
509
|
-
- [Veto](https://github.com/oleg-koval/veto)
|
|
510
|
-
- [Google Antigravity](https://antigravity.google)
|
|
205
|
+
**Build path.** For new landing pages and showcase surfaces, Impeccable can generate a full-fidelity comp first and build to match it (bolder, slower), or build straight in code (leaner, faster). App screens and documents are always built in code. `init` asks once and saves the answer as `buildPath` in `.impeccable/config.json`; the decision page lets you override it for one session. The choice only appears when your harness can generate images. [Image generation](https://impeccable.style/docs/image-generation) · [Configuration](https://impeccable.style/docs/config).
|
|
511
206
|
|
|
512
|
-
|
|
207
|
+
**Hooks run outside model approval.** In Claude Code, installed command hooks run even when you deny the model's own commands, so the first edit can download the engine. Review installed hooks before unattended runs, or pass `--settings '{"disableAllHooks": true}'` to turn them off for a run. The installer leaves hook entries it didn't add alone.
|
|
513
208
|
|
|
514
|
-
|
|
209
|
+
**Something broken?** `/impeccable doctor` finds stale context files, unused settings, and broken hooks. [Fix setup problems](https://impeccable.style/docs/doctor).
|
|
515
210
|
|
|
516
|
-
|
|
517
|
-
- [Impeccable on npm](https://www.npmjs.com/package/impeccable): grab the CLI, follow releases, and star the package.
|
|
518
|
-
- Follow @pbakaus on Twitter for release notes, sample lint reports, and video highlights of new rules.
|
|
211
|
+
**Telemetry.** When a new design starts, the skill fetches a set of visual directions from the impeccable.style catalog. Turning telemetry off doesn't stop that request; it stops the anonymous record of which directions were shown and which one you picked, which is how the catalog learns what works. Your project name, files, code, and `PRODUCT.md` are never sent. Disable telemetry with `npx impeccable telemetry off`, `DO_NOT_TRACK=1`, or `"telemetry": false` in `.impeccable/config.json` for the whole project. The full list of what is sent is on the [privacy page](https://impeccable.style/privacy).
|
|
519
212
|
|
|
520
|
-
##
|
|
213
|
+
## Community
|
|
521
214
|
|
|
522
|
-
|
|
215
|
+
- [Issues](https://github.com/pbakaus/impeccable/issues) for bugs, questions, and ideas. Outside contributions start with an issue; see [DEVELOP.md](docs/DEVELOP.md).
|
|
216
|
+
- [Changelog](https://impeccable.style/changelog) for what shipped.
|
|
217
|
+
- Follow [@pbakaus](https://x.com/pbakaus) for release notes and new rules.
|
|
523
218
|
|
|
524
219
|
## License
|
|
525
220
|
|
|
526
|
-
Apache 2.0. See [LICENSE](LICENSE).
|
|
221
|
+
Apache 2.0. See [LICENSE](LICENSE). Impeccable started from Anthropic's [frontend-design](https://github.com/anthropics/skills/tree/main/skills/frontend-design) skill.
|
|
527
222
|
|
|
528
223
|
---
|
|
529
224
|
|
package/cli/bin/cli.js
CHANGED
|
@@ -2,13 +2,18 @@
|
|
|
2
2
|
// `impeccable` npm shim: finds the platform binary and execs it with argv.
|
|
3
3
|
// Order: $IMPECCABLE_BIN, the @impeccable/cli-<os>-<arch> optional dependency,
|
|
4
4
|
// the version-pinned user cache (~/.impeccable/bin/<version>/), then a
|
|
5
|
-
// download into that cache from the public release channel.
|
|
5
|
+
// download into that cache from the public release channel. The cache and the
|
|
6
|
+
// download are verified against skill/scripts/engine-checksums.txt (shipped in
|
|
7
|
+
// the package); a <binary>.verified stamp holding the manifest digest and the
|
|
8
|
+
// binary's size records that a cached binary passed, until either changes or
|
|
9
|
+
// the binary is newer than the stamp.
|
|
6
10
|
import { spawnSync } from 'node:child_process';
|
|
7
11
|
import { createHash } from 'node:crypto';
|
|
8
12
|
import fs from 'node:fs';
|
|
9
13
|
import { createRequire } from 'node:module';
|
|
10
14
|
import os from 'node:os';
|
|
11
15
|
import path from 'node:path';
|
|
16
|
+
import { fileURLToPath } from 'node:url';
|
|
12
17
|
|
|
13
18
|
const require = createRequire(import.meta.url);
|
|
14
19
|
const pkg = require('../../package.json');
|
|
@@ -22,29 +27,46 @@ const VERSION = String(pkg.optionalDependencies?.[PLATFORM_PKG] || Object.values
|
|
|
22
27
|
const CACHE_ROOT = process.env.IMPECCABLE_HOME || path.join(os.homedir(), '.impeccable');
|
|
23
28
|
const CACHED = path.join(CACHE_ROOT, 'bin', VERSION, EXE);
|
|
24
29
|
const BASE = (process.env.IMPECCABLE_DOWNLOAD_BASE || 'https://github.com/pbakaus/impeccable/releases/download').replace(/\/$/, '');
|
|
25
|
-
const
|
|
30
|
+
const ASSET = `impeccable-${TARGET}${OS === 'windows' ? '.exe' : ''}`;
|
|
31
|
+
const URL = `${BASE}/engine-v${VERSION}/${ASSET}`;
|
|
32
|
+
const MANIFEST = path.join(path.dirname(fileURLToPath(import.meta.url)), '..', '..', 'skill', 'scripts', 'engine-checksums.txt');
|
|
33
|
+
const STAMP = `${CACHED}.verified`;
|
|
26
34
|
|
|
27
35
|
function exists(p) { try { return !!p && fs.statSync(p).isFile(); } catch { return false; } }
|
|
36
|
+
// A stamp counts only while it holds an accepted digest and the binary's size,
|
|
37
|
+
// and the binary has not changed since it was written.
|
|
38
|
+
function stampValid(accepted) {
|
|
39
|
+
try {
|
|
40
|
+
const [digest, size] = fs.readFileSync(STAMP, 'utf8').trim().split(/\s+/);
|
|
41
|
+
const bin = fs.statSync(CACHED);
|
|
42
|
+
return accepted.includes(digest) && size === String(bin.size) && bin.mtimeMs <= fs.statSync(STAMP).mtimeMs;
|
|
43
|
+
} catch { return false; }
|
|
44
|
+
}
|
|
45
|
+
// The digest MANIFEST records for this version and asset, or '' when none.
|
|
46
|
+
function expectedDigest(wanted = ASSET) {
|
|
47
|
+
try {
|
|
48
|
+
for (const line of fs.readFileSync(MANIFEST, 'utf8').split(/\r?\n/)) {
|
|
49
|
+
const [version, asset, sum] = line.trim().split(/\s+/);
|
|
50
|
+
if (version === VERSION && asset === wanted) return (sum || '').toLowerCase();
|
|
51
|
+
}
|
|
52
|
+
} catch { /* no manifest: nothing verifies */ }
|
|
53
|
+
return '';
|
|
54
|
+
}
|
|
28
55
|
function fromPackage() {
|
|
29
56
|
try { return path.join(path.dirname(require.resolve(`${PLATFORM_PKG}/package.json`)), 'bin', EXE); } catch { return null; }
|
|
30
57
|
}
|
|
31
58
|
async function download() {
|
|
32
59
|
if (!VERSION) return null;
|
|
60
|
+
// Fail closed, like the skill launcher and `impeccable install`: no digest
|
|
61
|
+
// on record refuses the download before any request, and nothing is written
|
|
62
|
+
// until the hash matches, so a refusal leaves the cache dir untouched.
|
|
63
|
+
const expected = expectedDigest();
|
|
64
|
+
if (!expected) {
|
|
65
|
+
throw new Error(`no checksum for engine ${VERSION} (${ASSET}) in ${MANIFEST}; refusing the unverified download`);
|
|
66
|
+
}
|
|
33
67
|
const res = await fetch(URL, { redirect: 'follow' });
|
|
34
68
|
if (!res.ok) return null;
|
|
35
69
|
const buf = Buffer.from(await res.arrayBuffer());
|
|
36
|
-
// Fail closed, like the skill launcher and `impeccable install`: a sidecar
|
|
37
|
-
// that cannot be fetched, or that carries no hash, refuses the download
|
|
38
|
-
// instead of caching an unverified binary. Nothing is written until the
|
|
39
|
-
// hash matches, so a refusal leaves the cache dir untouched.
|
|
40
|
-
const sum = await fetch(`${URL}.sha256`, { redirect: 'follow' }).then(r => (r.ok ? r.text() : ''), () => '');
|
|
41
|
-
const expected = sum.trim().split(/\s+/)[0].toLowerCase();
|
|
42
|
-
if (!expected) {
|
|
43
|
-
throw new Error(
|
|
44
|
-
`cannot verify ${URL} against ${URL}.sha256 (sidecar unavailable or empty); `
|
|
45
|
-
+ 'refusing the unverified download',
|
|
46
|
-
);
|
|
47
|
-
}
|
|
48
70
|
if (createHash('sha256').update(buf).digest('hex') !== expected) {
|
|
49
71
|
throw new Error(`checksum mismatch downloading ${URL}`);
|
|
50
72
|
}
|
|
@@ -57,6 +79,7 @@ async function download() {
|
|
|
57
79
|
try { fs.rmSync(tmp, { force: true }); } catch { /* best effort */ }
|
|
58
80
|
throw err;
|
|
59
81
|
}
|
|
82
|
+
try { fs.writeFileSync(STAMP, `${expected} ${buf.length}\n`); } catch { /* next run hashes again */ }
|
|
60
83
|
return CACHED;
|
|
61
84
|
}
|
|
62
85
|
async function locate() {
|
|
@@ -64,7 +87,18 @@ async function locate() {
|
|
|
64
87
|
if (exists(envBin)) return envBin;
|
|
65
88
|
const fromPkg = fromPackage();
|
|
66
89
|
if (exists(fromPkg)) return fromPkg;
|
|
67
|
-
if (exists(CACHED))
|
|
90
|
+
if (exists(CACHED)) {
|
|
91
|
+
// Windows on ARM runs x64 binaries, and the launchers fall back to that asset.
|
|
92
|
+
const accepted = [expectedDigest(), TARGET === 'windows-arm64' && expectedDigest('impeccable-windows-x64.exe')].filter(Boolean);
|
|
93
|
+
if (stampValid(accepted)) return CACHED;
|
|
94
|
+
let digest = '';
|
|
95
|
+
try { digest = createHash('sha256').update(fs.readFileSync(CACHED)).digest('hex'); } catch { /* unreadable: unverified */ }
|
|
96
|
+
if (digest && accepted.includes(digest)) {
|
|
97
|
+
try { fs.writeFileSync(STAMP, `${digest} ${fs.statSync(CACHED).size}\n`); } catch { /* read-only cache: verified this run */ }
|
|
98
|
+
return CACHED;
|
|
99
|
+
}
|
|
100
|
+
process.stderr.write(`impeccable: cannot verify the cached engine ${CACHED} against ${MANIFEST}; downloading engine ${VERSION} again\n`);
|
|
101
|
+
}
|
|
68
102
|
return download().catch((err) => { process.stderr.write(`impeccable: ${err.message}\n`); return null; });
|
|
69
103
|
}
|
|
70
104
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "impeccable",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.8.1",
|
|
4
4
|
"author": "Paul Bakaus",
|
|
5
5
|
"description": "Design skills, commands, and anti-pattern detection for AI coding agents",
|
|
6
6
|
"keywords": [
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
},
|
|
40
40
|
"files": [
|
|
41
41
|
"cli/bin/",
|
|
42
|
+
"skill/scripts/engine-checksums.txt",
|
|
42
43
|
"LICENSE"
|
|
43
44
|
],
|
|
44
45
|
"scripts": {
|
|
@@ -83,18 +84,18 @@
|
|
|
83
84
|
"build:component-review": "bun scripts/build-component-review.mjs"
|
|
84
85
|
},
|
|
85
86
|
"optionalDependencies": {
|
|
86
|
-
"@impeccable/cli-darwin-arm64": "0.1.
|
|
87
|
-
"@impeccable/cli-darwin-x64": "0.1.
|
|
88
|
-
"@impeccable/cli-linux-x64": "0.1.
|
|
89
|
-
"@impeccable/cli-linux-arm64": "0.1.
|
|
90
|
-
"@impeccable/cli-windows-x64": "0.1.
|
|
87
|
+
"@impeccable/cli-darwin-arm64": "0.1.19",
|
|
88
|
+
"@impeccable/cli-darwin-x64": "0.1.19",
|
|
89
|
+
"@impeccable/cli-linux-x64": "0.1.19",
|
|
90
|
+
"@impeccable/cli-linux-arm64": "0.1.19",
|
|
91
|
+
"@impeccable/cli-windows-x64": "0.1.19"
|
|
91
92
|
},
|
|
92
93
|
"devDependencies": {
|
|
93
94
|
"@ai-sdk/anthropic": "^4.0.7",
|
|
94
95
|
"@ai-sdk/google": "^4.0.8",
|
|
95
96
|
"@ai-sdk/openai": "^4.0.7",
|
|
96
97
|
"@anthropic-ai/claude-agent-sdk": "^0.3.165",
|
|
97
|
-
"@anthropic-ai/sdk": "^
|
|
98
|
+
"@anthropic-ai/sdk": "^1.2.0",
|
|
98
99
|
"@babel/parser": "^8.0.4",
|
|
99
100
|
"ai": "^7.0.14",
|
|
100
101
|
"archiver": "^8.0.0",
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Engine binary digests for the pinned ENGINE_VERSION: <engine-version> <asset> <sha256>.
|
|
2
|
+
# The launchers, the npm shim, `impeccable install` and scripts/fetch-engine.mjs verify
|
|
3
|
+
# every engine download against this file. Written by
|
|
4
|
+
# `node scripts/check-engine-release.mjs --record` after each engine release.
|
|
5
|
+
0.1.19 impeccable-darwin-arm64 c35d0b0b250afceb5ab6ee7edfe190a04d76d25c56bac01935a7a1b06d0df818
|
|
6
|
+
0.1.19 impeccable-darwin-x64 df7c2b9cec89df54d1d9722a35aecc48b965dfad190c4ec2e766ce3f7743a544
|
|
7
|
+
0.1.19 impeccable-linux-x64 07b763dc00012e9acf219fe2d2e8980f0810fb8af2e4a41c090107a8351d412f
|
|
8
|
+
0.1.19 impeccable-linux-arm64 73b5662e42f060aba716016c34a7274cc49a998cd0d5da8b84a95d9e4edea729
|
|
9
|
+
0.1.19 impeccable-windows-x64.exe 30427e0cfea383a0adbc5cc554481c3f18337eeabcc4eaf7d9bb48ad2e8b5676
|