Skip to content

The design language that makes your AI harness better at design.

JavaScript
4.4 KB
Raw Blame
{
  "stdout": "Usage: impeccable detect [options] [file-or-dir-or-url...]\n\nScan files or URLs for UI anti-patterns and design quality issues.\n\nOptions:\n  --json              Output results as JSON\n  --quiet             In text mode, only print the final findings count\n  --github            Write GitHub Actions annotations for each\n                      finding. Not with --json or --list-rules\n  --list-rules        Print the detector rule catalog and exit. --json\n                      for JSON, --quiet for ids only. Takes no targets\n  --scope <name>      Only report rules in the given design domain\n                      (type, layout). Comma-separated.\n  --viewport <WxH>    Browser viewport for URL scans (default 1280x800),\n                      e.g. --viewport 390x844 for a mobile-width pass\n  --no-config         Do not apply project config, detector ignores, inline\n                      ignore comments, or DESIGN.md\n  --no-inline-ignores Do not honor in-file impeccable-disable* ignore comments\n  --no-design-system  Do not load local DESIGN.md / .impeccable/design.json context\n  --no-advisory       Suppress advisory findings entirely (e.g. em-dash overuse)\n  --no-consent-hiding URL scans: keep known consent managers' banners\n                      (OneTrust, Cookiebot, ...) on the page instead of hiding\n                      them before the scan\n  --no-overlay-hiding URL scans: keep product tours (driver.js) and\n                      preloaders still covering the page instead of hiding\n                      them before the scan\n  --cdp <port|url>    Scan a page of a running Chromium-based desktop app\n                      (Electron, NW.js, CEF, WebView2) through its local\n                      DevTools port instead of loading a URL. The page is\n                      scanned as shown and left as found: never navigated,\n                      resized or closed. Takes no file or URL targets\n  --target <text>     With --cdp: pick the page whose URL or title contains\n                      this text when the app has more than one\n  --help              Show this help message\n\nAdvisory findings:\n  Some rules are advisory: detected and listed in a separate section, but never\n  counted as failures and never changing the exit code. They stay out of the\n  failure count so they never block automation. --no-advisory hides them.\n\nOutput streams:\n  Human-readable findings go to stderr so stdout stays available for structured\n  output. Use --json for JSON on stdout, or redirect text with 2> findings.txt.\n  --github writes Actions annotations to stdout (no human findings).\n  --list-rules writes the catalog to stdout (no scan).\n\nExit status:\n  0  Scan completed with no primary findings (advisories may still be listed)\n  1  At least one requested target could not be scanned\n  2  Scan completed with primary findings\n  Operational failure takes precedence when a multi-target scan is partial.\n\nProject config:\n  Respects .impeccable/config.json and .impeccable/config.local.json detector\n  settings: detector.ignoreRules, detector.ignoreFiles, detector.ignoreValues,\n  and detector.designSystem.enabled.\n\nInline ignores:\n  In-file comments waive a finding where it lives and travel with the file:\n    <!-- impeccable-disable overused-font -- exported brand doc -->\n    .brand { font-family: Inter } /* impeccable-disable-line overused-font */\n    // impeccable-disable-next-line bounce-easing: intentional bounce\n  impeccable-disable applies to the whole file; -line / -next-line are scoped.\n  List one or more rule ids (comma-separated), or omit them / use * for all.\n\nDetection modes:\n  HTML files     Static HTML/CSS analysis (default, catches linked CSS)\n  Non-HTML files Regex pattern matching (CSS, JSX, TSX, etc.)\n  URLs           Puppeteer full browser rendering (auto-detected;\n                 http(s):// and file:// URLs; accessible linked CSS included)\n  Running apps   --cdp: a page of a Chromium-based app, attached through its\n                 DevTools port and scanned like a URL\n\nExamples:\n  impeccable detect src/\n  impeccable detect index.html\n  impeccable detect https://example.com\n  impeccable detect --cdp 9222 --target \"My App\" --json\n  impeccable detect --json .\n  impeccable detect --github src/\n  impeccable detect --list-rules\n  impeccable detect --no-config src/\n",
  "stderr": "",
  "exit": 0,
  "signal": null,
  "files": {}
}