mirror of
https://github.com/pbakaus/impeccable.git
synced 2026-09-11 21:57:14 +03:00
Move CLI to separate repo, make this skills-only (Apache 2.0)
The CLI and detection engine now live in pbakaus/impeccable-detect (published as 'impeccable' on npm, BSL-1.1). This repo is purely Apache 2.0: skills, prompts, website, and build system. - Remove bin/ (CLI moved to CLI repo) - Remove README.npm.md (moved to CLI repo) - Remove @impeccable/detect dependency, add impeccable dependency - Set package.json to private (no longer published to npm) - Update all references from @impeccable/detect to impeccable - Update CLAUDE.md, NOTICE.md, FAQ, and changelog - Rebuild all provider skill distributions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.6
parent
077e1a7b2b
commit
d8d5b8acd8
@@ -1,76 +0,0 @@
|
||||
# Impeccable CLI
|
||||
|
||||
Detect UI anti-patterns and design quality issues from the command line. Scans HTML, CSS, JSX, TSX, Vue, and Svelte files for 25 specific patterns including AI-generated UI tells, accessibility violations, and general design quality problems.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install skills into your AI harness (Claude, Cursor, Gemini, etc.)
|
||||
npx impeccable skills install
|
||||
|
||||
# Update skills to the latest version
|
||||
npx impeccable skills update
|
||||
|
||||
# List all available commands
|
||||
npx impeccable skills help
|
||||
|
||||
# Scan files or directories for anti-patterns
|
||||
npx impeccable detect src/
|
||||
|
||||
# Scan a live URL (requires Puppeteer)
|
||||
npx impeccable detect https://example.com
|
||||
|
||||
# JSON output for CI/tooling
|
||||
npx impeccable detect --json src/
|
||||
|
||||
# Regex-only mode (faster, no jsdom)
|
||||
npx impeccable detect --fast src/
|
||||
```
|
||||
|
||||
## What It Detects
|
||||
|
||||
**AI Slop Tells** -- patterns that scream "AI generated this":
|
||||
- Side-tab accent borders, gradient text on headings
|
||||
- Purple/violet gradients and cyan-on-dark palettes
|
||||
- Dark mode with glowing accents, border + border-radius clashes
|
||||
|
||||
**Typography Issues** -- overused fonts (Inter, Roboto), flat type hierarchy, single font families
|
||||
|
||||
**Color & Contrast** -- WCAG AA violations, gray text on colored backgrounds, pure black/white
|
||||
|
||||
**Layout & Composition** -- nested cards, monotonous spacing, everything-centered layouts
|
||||
|
||||
**Motion** -- bounce/elastic easing, layout property transitions
|
||||
|
||||
**Quality** -- tiny body text, cramped padding, long line lengths, small touch targets
|
||||
|
||||
25 detections in total. See the full list at [impeccable.style](https://impeccable.style).
|
||||
|
||||
## Exit Codes
|
||||
|
||||
- `0` -- no issues found
|
||||
- `2` -- anti-patterns detected
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
impeccable detect [options] [file-or-dir-or-url...]
|
||||
|
||||
--fast Regex-only mode (skip jsdom, faster but less accurate)
|
||||
--json Output findings as JSON
|
||||
--help Show help
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Node.js 18+
|
||||
- `jsdom` (included as dependency, used for HTML scanning)
|
||||
- `puppeteer` (optional, only needed for URL scanning)
|
||||
|
||||
## 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 20 steering commands for Claude, Cursor, Gemini, Codex, and more.
|
||||
|
||||
## License
|
||||
|
||||
See [LICENSE](https://github.com/pbakaus/impeccable/blob/main/LICENSE) file.
|
||||
Reference in New Issue
Block a user