Agent-readable docs
Impeccable Documentation
Technical reference for Impeccable: the `/impeccable` design skill (23 commands), multi-harness installer, deterministic anti-pattern detector CLI and browser extension, live browser iteration, project artifacts, and contributor build/test surfaces.
Pages
- OverviewWhat Impeccable exposes (skill, CLI detector, extension, live mode), runtime assumptions, and the shortest path from install to first successful command.
- InstallationInstall paths for npx install/link/update, plugin install, submodule link, provider selection, scope (project vs global), and hook consent constraints.
- QuickstartFirst successful session: install skills, run `/impeccable init`, load context via context.mjs, run a scoped design command, and optionally scan with detect.
- Modes and platformVisitor modes (Persuade, Operate, Read, Experience) and orthogonal platform values (web, ios, android, adaptive), including defaults, native reference loading, and web-only live/detect boundaries.
- Project artifactsPRODUCT.md, DESIGN.md, design.json sidecar, surface briefs, `.impeccable/` layout, schema stamps, deprecated sections, and context resolution order.
- Commands and routingSingle `/impeccable` skill, 23 sub-commands, Setup load order, no-argument routing, craft-floor gate, and when native command variants replace web references.
- Provider harnessesSupported AI harness directories, install aliases, frontmatter and hook capability matrix, and provider-specific trust or skills-enable steps.
- Initialize product contextRun init to interview and write PRODUCT.md (including Platform), optionally document DESIGN.md from code, configure live when useful, and verify completion gates.
- Run design commandsInvoke evaluate and refine commands (audit, critique, polish, harden, layout, typeset, and related) with targets, expected artifacts, and verification signals.
- Live browser iterationStart live mode, poll contract, generate/accept/discard/steer/manual-edit events, carbonize cleanup, roots resolution, and web-only platform constraints.
- Design hookProvider-native edit hooks that scan writes for detector findings, intentional-finding workflow, quiet/disabled controls, and native-platform skip behavior.
- Pin shortcutsCreate and remove standalone harness shortcuts (for example `/audit`) that redirect to `/impeccable <command>` across discovered skill directories.
- Manage detector ignoresAdd, list, and remove ignoreRules, ignoreFiles, and ignoreValues in shared or local config, including value scoping, reasons, and inline disable comments.
- CLI referenceCommands for detect, ignores, install, link, update, check, and help: flags, defaults, exit codes, JSON output, URL scanning, and detect shorthand targets.
- Skill commands referenceCatalog of `/impeccable` sub-commands with argument hints, categories, reference files, and native variants for audit and adapt.
- Detector rulesDeterministic rule registry: ids, slop vs quality categories, advisory rules, scopes, engines (jsdom, browser, regex), and finding shape for CLI and extension.
- Configuration reference`.impeccable/config.json` and `config.local.json` keys for detector, hook, live, update, and staleness settings, plus live config.json fields and hard path excludes.
- Environment variablesDocumented IMPECCABLE_* and related env vars for context dir, update host/cache, live config, hook quiet/disable/depth/log, telemetry opt-out, and OpenCode config dirs.
- Plugin agentsBundled finish-reviewer, documenter, asset-producer, and manual-edit-applier agents, plugin manifest contract, and hooks packaged for Claude Code and Grok plugin installs.
- Live framework recipesCopy-paste live config shapes and adapter notes for Vite, Next.js, Nuxt, SvelteKit, TanStack, Astro, multipage, and CSP-aware fixtures under tests/framework-fixtures.
- Detect in CIRun impeccable detect non-interactively with --json/--quiet/--scope, interpret exit codes 0 and 2, apply project ignores, and wire optional Puppeteer URL scans.
- DoctorRun doctor for schema, config, and proxy truth-drift findings; apply auto fixes; route mention and route severities; opt out of boot staleness checks.
- Build and testSource-first vs release builds, browser and extension bundles, default and opt-in test suites (live-e2e, skill-behavior, plugin-e2e), and suite trigger mapping.
- ContributingSource-of-truth layout under skill/, generated harness policy, issue-first PR rules, anti-pattern TDD order, and component release tags (skill-v, cli-v, ext-v).
Complete Markdown
The complete agent-readable Markdown files are published separately from this HTML page.