getting-started.md

  1---
  2title: Getting started
  3tagline: "From zero to your first polish pass in five minutes."
  4order: 1
  5description: "Install Impeccable, run /impeccable teach once to establish project context, and run /impeccable polish on something that already exists. The fastest path to seeing what Impeccable changes about AI-generated design."
  6---
  7
  8## What you'll build
  9
 10You will end this tutorial with Impeccable installed in your project, a `PRODUCT.md` plus `DESIGN.md` pair that captures your brand, audience, and visual system, and one hand-polished page that went through a polish pass. Total time: about ten minutes.
 11
 12## Prerequisites
 13
 14- An AI coding harness: Claude Code, Cursor, Gemini CLI, Codex CLI, or any of the other supported tools.
 15- A project with at least one HTML or component file you want to improve. A fresh scaffolded landing page works fine.
 16
 17## How Impeccable works
 18
 19Impeccable installs as a single agent skill called `impeccable`. You access all 23 sub-commands through it:
 20
 21```
 22/impeccable <command> <target>
 23```
 24
 25For example: `/impeccable polish the pricing page`, or `/impeccable audit the checkout`. Type `/impeccable` alone to see the full list.
 26
 27If you use a command often, pin it with `/impeccable pin <command>` to create a standalone shortcut (for example, `/impeccable pin audit` gives you `/audit` directly).
 28
 29## Step 1. Install
 30
 31From the root of your project, run:
 32
 33```
 34npx skills add pbakaus/impeccable
 35```
 36
 37This auto-detects your harness and writes the skill files to the right location (e.g., `.claude/skills/`, `.cursor/skills/`). Reload your harness and type `/`. You should see `/impeccable` in the autocomplete. Type it and the skill's argument hint will show all available commands.
 38
 39## Step 2. Teach Impeccable about your project
 40
 41This is the most important step. Design without context produces generic output. The `/impeccable teach` command runs a short discovery interview and writes a `PRODUCT.md` file at the root of your project.
 42
 43Run:
 44
 45```
 46/impeccable teach
 47```
 48
 49The first question is about **register**: is this a brand surface (marketing site, landing page, portfolio, where design IS the product) or a product surface (app UI, dashboard, tools, where design SERVES the product)? Register shapes every downstream default, from type lanes to motion energy. See [brand vs product](/tutorials/brand-vs-product) for how the two diverge. Teach will form a hypothesis from your codebase and ask you to confirm, rather than starting cold.
 50
 51Then a handful of shorter questions:
 52
 53- **Who is this product for?** Be specific. Not "users" but "solo founders evaluating a new tool on their phone between meetings".
 54- **What is the brand voice in three words?** Pick real words. "Warm and mechanical and opinionated" is better than "modern and clean".
 55- **Any visual references?** Named brands, products, or printed objects, not adjectives. "Klim Type Foundry specimen pages", not "technical and clean".
 56- **Anti-references?** Things the product should explicitly not look like, equally named.
 57
 58Answer in your own words. The skill writes `PRODUCT.md` with the answers. Every future command run reads it automatically.
 59
 60Open `PRODUCT.md` and read what it wrote. Edit anything that does not feel right. The file is yours.
 61
 62## Step 2.5. Capture the visual system
 63
 64At the end of `/impeccable teach`, the skill offers to run `/impeccable document` for you. Say yes. It scans your tokens (CSS custom properties, Tailwind config, CSS-in-JS themes), extracts colors and typography, asks one grouped question for the parts that need creative input (a Creative North Star, descriptive color names), and writes a `DESIGN.md` that follows the [Google Stitch DESIGN.md format](https://stitch.withgoogle.com/docs/design-md/format/).
 65
 66On a fresh project with no tokens yet, document runs in seed mode: five quick questions about color strategy, type direction, and motion energy, and writes a scaffold you can refresh once there is code.
 67
 68`PRODUCT.md` carries strategy (who, what, why). `DESIGN.md` carries visuals (colors, typography, components). Every command reads both before generating.
 69
 70## Step 3. Polish something
 71
 72Pick a page that already exists. An about page, a settings screen, a pricing table, anything. Run:
 73
 74```
 75/impeccable polish the pricing page
 76```
 77
 78The skill will walk through alignment, spacing, typography, color, interaction states, transitions, and copy. It makes targeted fixes, not a rewrite. Expect a handful of small diffs that together lift the page from "done" to "done well".
 79
 80A typical polish pass looks like:
 81
 82```
 83Visual alignment: fixed 3 off-grid elements
 84Typography: tightened h1 kerning, fixed widow on feature list
 85Color: replaced one hardcoded hex with --color-accent token
 86Interaction: added missing hover state on FAQ items
 87Motion: softened modal entrance to 220ms ease-out-quart
 88Copy: removed stray 'Lorem' placeholder
 89```
 90
 91Review the diff. If something does not feel right, ask the model to explain the change. If it still does not feel right, revert it. Impeccable is opinionated but not infallible.
 92
 93## What to try next
 94
 95- [Iterate visually with Live Mode](/tutorials/iterate-live) opens a browser picker on your dev server, generates three production-quality variants per element, and writes the accepted one back to source.
 96- `/impeccable critique the landing page` runs a full design review with scoring, persona tests, and automated detection. It is the best way to find what to fix next.
 97- `/impeccable audit the checkout` runs accessibility, performance, theming, responsive, and anti-pattern checks against the implementation. Useful before shipping.
 98- `/impeccable craft a pricing page for enterprise customers` runs the full shape-then-build flow on a brand new feature.
 99- **Pin your favorites.** If you reach for one command constantly, `/impeccable pin audit` makes `/audit` work as a standalone shortcut without reversing the consolidation.
100- `/impeccable redo this hero section` works too. Any description after `/impeccable` applies the design principles to the task.
101
102## Common issues
103
104- **The skill says "no design context found"**. You skipped step 2. Run `/impeccable teach` first.
105- **Commands do not appear in the harness**. Reload the harness after installing. If they still do not appear, check that the installer wrote files into the expected location (`.claude/skills/`, `.cursor/skills/`, etc.) and that your harness is picking up that directory.
106- **The polish pass rewrote something you liked**. Say so. Revert the change, tell the model which specific edit to undo, and continue from there.