sailopdocs
docsscanpricinginstall
Getting Started
  • Overview
  • Getting Started
Reference
  • CLI Reference
  • MCP Tools
  • Scoring System
Links
  • Product
  • Pricing
  • Blog
Reference

CLI Reference

All 18 Sailop CLI commands with their options, flags, and output examples. Commands marked Pro require a Pro license ($39 one-time).

Commands
scanfixgeneratesetupautotunehookdiffrulesreportinitscorecomparewatchexportcleanconfiglicense--version

Global options

These flags work with any command:

--help, -hShow help for any command
--version, -vPrint version number
--no-colorDisable colored output
--verboseShow additional debug information
--quiet, -qSuppress all output except errors

sailop scanFree

Scan files or directories for AI-generated visual patterns. Outputs a slop score, grade, and a list of triggered rules organized by dimension.

Usage
sailop scan <path> [options]
Options
--format <type>Output format(default: pretty)
--threshold <n>Fail with exit code 1 if score exceeds this value
--include <glob>Only scan files matching this pattern
--exclude <glob>Skip files matching this pattern
--verboseShow every rule check, not just triggered ones
--no-colorDisable color output
Example
sailop scan ./src --format json --threshold 40
{
  "score": 67,
  "grade": "D",
  "dimensions": {
    "colors": { "score": 12, "weight": 0.20, "findings": 4 },
    "typography": { "score": 8, "weight": 0.15, "findings": 2 },
    "spacing": { "score": 10, "weight": 0.15, "findings": 3 },
    ...
  },
  "findings": [ ... ],
  "filesScanned": 24
}

sailop fixPro

Auto-transform your code to replace AI patterns with a unique design system. Rewrites CSS, Tailwind classes, and inline styles while keeping your markup semantic.

Usage
sailop fix <path> [options]
Options
--seed <string>Deterministic seed for design system generation
--dry-runPreview changes without writing files
--no-backupSkip creating .sailop-backup/ before transforms
--dimensions <list>Only fix specific dimensions (comma-separated)
--aggressiveApply deeper transforms including layout restructuring
Example
sailop fix ./src --seed my-brand --dry-run
Dry run — no files will be modified

Would transform 18 files:
  src/app/page.tsx         — 7 changes (colors, radius, spacing)
  src/components/nav.tsx   — 3 changes (colors, typography)
  src/app/globals.css      — 12 changes (all dimensions)
  ...

Estimated score change: 67 → 19 (Grade A)

sailop generateFree

Generate a unique design system as CSS custom properties. The output is a complete set of variables for colors, fonts, spacing, radius, shadows, and more.

Usage
sailop generate [options]
Options
--seed <string>Seed for reproducible output
--format <type>Output format: css, json, tailwind(default: css)
--hue <n>Force a specific base hue (0-360)
--mode <type>Light or dark mode output(default: light)
--output <path>Write to file instead of stdout
Example
sailop generate --seed acme-corp --format css
:root {
  --c-bg: #f2ede6;
  --c-bg-raised: #faf7f3;
  --c-fg: #1e1a15;
  --c-fg-body: #504840;
  --c-accent: #b05530;
  --c-secondary: #2a7568;
  --f-display: 'Bitter', Georgia, serif;
  --f-body: 'Karla', system-ui, sans-serif;
  --r-btn: 3px;
  --r-card: 6px;
  /* ... 40+ more variables */
}

sailop setupFree

Configure Sailop for your environment. Writes MCP server configuration for Claude Code, Cursor, and other compatible editors.

Usage
sailop setup [options]
Options
--globalWrite configuration to your home directory (all projects)
--localWrite configuration to the current project only
--editor <name>Target a specific editor: claude, cursor, all(default: all)
--forceOverwrite existing configuration
Example
sailop setup --global --editor claude

sailop autotunePro

Karpathy-style iterative improvement loop. Repeatedly scans, transforms, and re-scans until the score drops below a target threshold or the maximum iterations are reached.

Usage
sailop autotune <path> [options]
Options
--target <n>Target score to reach(default: 20)
--max-iter <n>Maximum number of iterations(default: 5)
--seed <string>Seed for design system generation
--verboseShow per-iteration breakdown
Example
sailop autotune ./src --target 15 --max-iter 3
Iteration 1: score 67 → 34 (improved 33 points)
Iteration 2: score 34 → 21 (improved 13 points)
Iteration 3: score 21 → 14 (improved 7 points)

Target reached: 14/100 (Grade A)
3 iterations, 18 files transformed

sailop hookPro

Manage the git pre-commit hook. The hook runs a scan before each commit and blocks if the slop score exceeds your configured threshold.

Usage
sailop hook <action> [options]
Options
installInstall the pre-commit hook in the current repo
removeRemove the pre-commit hook
--threshold <n>Maximum allowed score(default: 40)
--staged-onlyOnly scan staged files, not the entire project
Example
sailop hook install --threshold 30 --staged-only

sailop diffPro

Show a before/after comparison of what the transform would change. Renders a visual diff of CSS properties and Tailwind classes.

Usage
sailop diff <path> [options]
Options
--seed <string>Seed for design system generation
--colorForce color output even in non-TTY(default: auto)
Example
sailop diff ./src/globals.css
--- src/globals.css (before)
+++ src/globals.css (after)

- --c-bg: #ffffff;
+ --c-bg: #f2ede6;
- --c-accent: #6366f1;
+ --c-accent: #b05530;
- border-radius: 8px;
+ border-radius: 5px;

12 properties would change

sailop rulesFree

List all detection rules. Shows rule ID, dimension, severity, and a short description of what each rule detects.

Usage
sailop rules [options]
Options
--dimension <name>Filter by dimension (colors, typography, spacing, etc.)
--severity <level>Filter by severity: low, medium, high, critical
--format <type>Output format: pretty, json(default: pretty)
Example
sailop rules --dimension colors
Colors dimension — 12 rules

  COL-001  high      Blue-indigo primary palette (#6366f1, #4f46e5, etc.)
  COL-002  high      Blue-violet gradient backgrounds
  COL-003  medium    Pure white background (#ffffff)
  COL-004  medium    Pure black text (#000000)
  COL-005  low       Gray-only neutral palette (no warm/cool tint)
  COL-006  high      AI-band hues (200-290 range)
  ...

sailop reportFree

Generate a detailed HTML report of the scan results. Opens in your browser with interactive charts and per-file breakdowns.

Usage
sailop report <path> [options]
Options
--output <path>Write report file to this path(default: ./sailop-report.html)
--openOpen the report in your default browser after generating
Example
sailop report ./src --open

sailop initFree

Create a .sailoprc configuration file in the current directory. Sets project-specific scan options, thresholds, and exclusion patterns.

Usage
sailop init [options]
Options
--template <name>Start from a template: nextjs, react, vue, svelte, default(default: default)
--threshold <n>Set default threshold in config(default: 40)
Example
sailop init --template nextjs
Created .sailoprc in /Users/you/project/

{
  "threshold": 40,
  "exclude": ["node_modules", ".next", "dist"],
  "include": ["src/**/*.{tsx,css,vue,svelte}"],
  "dimensions": { "weights": "default" }
}

sailop scoreFree

Quick score check. Prints only the numeric score and grade without the full findings list. Useful for scripting.

Usage
sailop score <path>
Example
sailop score ./src
67 D

sailop compareFree

Compare two scan snapshots or branches. Shows score delta and which rules improved or regressed.

Usage
sailop compare <before> <after>
Options
--format <type>Output format: pretty, json(default: pretty)
Example
sailop compare baseline.json current.json
Score: 67 → 22 (improved 45 points)
Grade: D → A

Improved:
  Colors:     12 → 3  (-9)
  Spacing:    10 → 2  (-8)
  Typography:  8 → 1  (-7)

Regressed: none

sailop watchFree

Watch files for changes and re-scan automatically. Shows a live-updating score in the terminal. Useful during development.

Usage
sailop watch <path> [options]
Options
--debounce <ms>Wait this long after a change before re-scanning(default: 500)
--clearClear terminal on each rescan
Example
sailop watch ./src --clear

sailop exportFree

Export the generated design system in various formats for use outside of Sailop.

Usage
sailop export [options]
Options
--format <type>Format: css, scss, json, tailwind-config, figma-tokens(default: css)
--seed <string>Seed for reproducible output
--output <path>Write to file instead of stdout
Example
sailop export --format tailwind-config --seed acme > tailwind.config.patch.js

sailop cleanFree

Remove Sailop-generated backup files and temporary data from the project directory.

Usage
sailop clean [options]
Options
--backupsRemove .sailop-backup/ directories
--reportsRemove generated report files
--allRemove everything Sailop-related
Example
sailop clean --all

sailop configFree

View or modify the Sailop configuration for the current project or global scope.

Usage
sailop config [key] [value]
Options
--globalRead/write global config instead of project config
--listPrint all configuration values
--resetReset to defaults
Example
sailop config threshold 30

sailop licenseFree

Manage your Pro license. Activate, deactivate, or check license status.

Usage
sailop license <action>
Options
activate <key>Activate a Pro license key
deactivateDeactivate the current license on this machine
statusCheck current license status
Example
sailop license activate SAILOP-XXXX-XXXX-XXXX
License activated successfully.

Plan: Pro (lifetime)
Machine: registered
Features: fix, autotune, hook, diff, export

sailop --versionFree

Print the installed Sailop version.

Usage
sailop --version
Example
sailop --version
sailop v1.4.2
← Getting StartedMCP Tools →