diff --git a/PRODUCT.md b/PRODUCT.md index abbc1430c..c2c55749f 100644 --- a/PRODUCT.md +++ b/PRODUCT.md @@ -6,7 +6,7 @@ brand ## Users -Designers, product managers, and engineers who use AI coding tools (Cursor, Claude Code, Gemini CLI, Codex CLI, and others) and want better design output from their AI. They land on the site from GitHub, social media, or word of mouth, already aware that AI-generated UIs have quality problems. They're looking for a practical solution, not education about the problem. +Designers, product managers, and engineers who use AI coding tools (Cursor, Claude Code, GitHub Copilot, Gemini CLI, Codex CLI, and others) and want better design output from their AI. They land on the site from GitHub, social media, or word of mouth, already aware that AI-generated UIs have quality problems. They're looking for a practical solution, not education about the problem. ## Product Purpose diff --git a/README.md b/README.md index f93dd628c..cba046437 100644 --- a/README.md +++ b/README.md @@ -260,11 +260,12 @@ If you reach for one command often, pin it with `/impeccable pin audit` to get ` ## Design hook -On Claude Code, Codex, and Cursor, `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 and Codex surface findings after the edit. Cursor blocks bad proposed writes before they land. +On Claude Code, GitHub Copilot, Codex, and Cursor, `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. Cursor blocks bad proposed writes before they land. Installed hook surfaces: - Claude Code: `.claude/settings.local.json` (gitignored, machine-local) runs `${CLAUDE_PROJECT_DIR}/.claude/skills/impeccable/scripts/hook.mjs`. A hook moved into the shared `settings.json` is honored in place. +- GitHub Copilot: `.github/hooks/impeccable.json` (committed, shared by the Copilot CLI and the cloud agent) runs `.github/skills/impeccable/scripts/hook.mjs`. The Copilot CLI activates it once the file is on the repository's default branch and the folder is trusted. - Cursor: `.cursor/hooks.json` runs `.cursor/skills/impeccable/scripts/hook-before-edit.mjs`. - Codex: `.codex/hooks.json` runs `.agents/skills/impeccable/scripts/hook.mjs`. @@ -310,11 +311,11 @@ Full detector docs: [impeccable.style/docs/detector](https://impeccable.style/do - [Cursor](https://cursor.com) - [Claude Code](https://claude.ai/code) -- [OpenCode](https://opencode.ai) -- [Pi](https://pi.dev) +- [GitHub Copilot](https://github.com/features/copilot) - [Gemini CLI](https://github.com/google-gemini/gemini-cli) - [Codex CLI](https://github.com/openai/codex) -- [VS Code Copilot](https://code.visualstudio.com) +- [OpenCode](https://opencode.ai) +- [Pi](https://pi.dev) - [Kiro](https://kiro.dev) - [Trae](https://trae.ai) - [Rovo Dev](https://www.atlassian.com/software/rovo) diff --git a/README.npm.md b/README.npm.md index 38fcaa073..2142dda11 100644 --- a/README.npm.md +++ b/README.npm.md @@ -81,7 +81,7 @@ impeccable detect [options] [file-or-dir-or-url...] ## Part of Impeccable -This CLI is part of [Impeccable](https://impeccable.style), a cross-provider design skill pack for AI-powered development tools. The full suite includes 23 commands for Claude, Cursor, Gemini, Codex, and more. +This CLI is part of [Impeccable](https://impeccable.style), a cross-provider design skill pack for AI-powered development tools. The full suite includes 23 commands for Claude, Cursor, GitHub Copilot, Gemini, Codex, and more. ## License diff --git a/site/content/reference/hooks.md b/site/content/reference/hooks.md index 192350bd7..7ae050833 100644 --- a/site/content/reference/hooks.md +++ b/site/content/reference/hooks.md @@ -1,6 +1,6 @@ --- title: Design hooks -tagline: "Automatic detector feedback inside Claude Code, Codex, and Cursor." +tagline: "Automatic detector feedback inside Claude Code, GitHub Copilot, Codex, and Cursor." description: "Install, enable, disable, debug, and tune Impeccable's provider-native design hook for automatic detector feedback on UI file edits." section: automation order: 2 @@ -34,7 +34,7 @@ npx impeccable update --no-hooks The hook scans direct edits to UI code and styles. When it finds a new issue, it sends the agent a short reminder with the finding and a fix direction. -Claude Code and Codex run after the edit. Cursor checks proposed writes before they land and blocks only when the detector finds an issue in the proposed UI code. +Claude Code, GitHub Copilot, and Codex run after the edit. Cursor checks proposed writes before they land and blocks only when the detector finds an issue in the proposed UI code. Plain `.ts` and `.js` files are scanned, but the hook stays quiet unless it finds something design-relevant. @@ -57,12 +57,14 @@ The terminal equivalent is `npx impeccable ignores ...`, which writes the same d
Supported harnesses and approval steps
-

npx impeccable install and npx impeccable update install provider-native hook manifests for Claude Code, Codex, and Cursor.

+

npx impeccable install and npx impeccable update install provider-native hook manifests for Claude Code, GitHub Copilot, Codex, and Cursor.

+

GitHub Copilot reads the committed .github/hooks/impeccable.json. In the Copilot CLI the hook activates once that file is on the repository's default branch and you trust the folder; the cloud agent reads it straight from the repo.

Codex requires one extra approval step. After install or update, open /hooks in Codex and approve the project hook. Codex tracks trust by hook definition, so updates can require approval again.

Cursor users should also confirm hooks are enabled in Cursor Settings -> Hooks.

diff --git a/site/content/tutorials/getting-started.md b/site/content/tutorials/getting-started.md index eadd27077..0afe73297 100644 --- a/site/content/tutorials/getting-started.md +++ b/site/content/tutorials/getting-started.md @@ -48,7 +48,7 @@ Prefer a different setup? Claude Code users can install the plugin with `/plugin When a new version ships later, run `npx impeccable update` from the same project root. `npx impeccable check` tells you first whether you are behind, and plugin users update from the `/plugin` menu instead. -On Claude Code, Codex, and Cursor, the installer can also add Impeccable's automatic design hook. See [Design hooks](/docs/hooks) for harness-specific behavior and approval steps. +On Claude Code, GitHub Copilot, Codex, and Cursor, the installer can also add Impeccable's automatic design hook. See [Design hooks](/docs/hooks) for harness-specific behavior and approval steps. ## Step 2. Set up Impeccable for your project diff --git a/site/pages/designing/index.astro b/site/pages/designing/index.astro index e3d5a76b4..23b8f8fd2 100644 --- a/site/pages/designing/index.astro +++ b/site/pages/designing/index.astro @@ -353,7 +353,7 @@ import '../../styles/designing-kinpaku.css';

Mostly, you're in the skill.

-

The 23 commands run inside your AI coding tool: Cursor, Claude Code, Codex, Gemini CLI, Copilot. That's where everything on this page happens. The same anti-pattern detector also runs in two places outside the chat.

+

The 23 commands run inside your AI coding tool: Cursor, Claude Code, GitHub Copilot, Codex, Gemini CLI. That's where everything on this page happens. The same anti-pattern detector also runs in two places outside the chat.

diff --git a/site/pages/faq.astro b/site/pages/faq.astro index ccb0881ae..1822b7fe8 100644 --- a/site/pages/faq.astro +++ b/site/pages/faq.astro @@ -63,6 +63,7 @@ import '../styles/changelog-faq-kinpaku.css';

Tool-specific setup:

  • Cursor: Requires Nightly channel + Agent Skills enabled in Settings → Rules
    • +
  • GitHub Copilot: Skills install to .github/skills/. The design hook lives in .github/hooks/impeccable.json and runs in both the Copilot CLI and the cloud agent once it is committed to the repository's default branch.
  • Gemini CLI: Requires @google/gemini-cli@preview + Skills enabled via /settings
  • Codex: Skills do not appear in the normal / command picker. Open /skills or type $. Repo installs live in .agents/skills/, user installs live in ~/.agents/skills/. Restart Codex if a new skill does not show up.
@@ -75,6 +76,7 @@ import '../styles/changelog-faq-kinpaku.css';

Skills and commands are intermediate features. If you're just getting started, learn the basics first: