No install required

uvx ai-slop-detector mycode.py ```

The npm surface is intentionally thin:

- it does not reimplement analysis logic - it delegates into the Python CLI/runtime - it exists for Node-first teams that want npx-style entry without changing product semantics - it requires a Python backend and discovers it in this order: AI_SLOP_DETECTOR_EXECUTABLE -> active VIRTUAL_ENV -> PATH executables -> python -m slop_detector.cli - it ships version-pinned TypeScript interfaces at ai-slop-detector/types - it exports a small async Node API for scanProject, reviewChanges, computeHealth, and runCleanupFamily

Windows / PowerShell tip: PowerShell > redirection writes UTF-16 LE or UTF-8 with BOM by default, which breaks json.load(..., encoding='utf-8'). Use --output <path> instead — it writes UTF-8 bytes (no BOM) directly, skipping the shell.

<p align="center"> <img src="docs/assets/cli-output.png" alt="CLI Output Example" width="800"/> </p>

---

Quick Start

```bash pip install "ai-slop-detector>=3.8.2"

slop-detector scan . # canonical analysis entry slop-detector review . --json # canonical changed-code review slop-detector pulse . --json # canonical repo health view slop-detector sweep dead-code . --json # canonical cleanup family

Optional extras

pip install "ai-slop-detector[js]" # JS/TS tree-sitter analysis pip install "ai-slop-detector[go]" # Go tree-sitter analysis

`.slopconfig.yaml` sensitivity

Your .slopconfig.yaml contains domain_overrides — a precise map of which functions are exempt from complexity rules. This is effectively a codebase weakness surface: it reveals which areas are too complex to refactor right now.

Best practice: - Run slop-detector --init to generate .slopconfig.yaml and auto-add it to .gitignore - To share governance config with your team, explicitly remove .slopconfig.yaml from .gitignore - Open-source repos committing it is fine (transparency over obscurity — see this project's own .slopconfig.yaml)

.pre-commit-config.yaml

repos: - repo: https://github.com/flamehaven01/AI-SLOP-Detector rev: v3.7.3 hooks: - id: slop-detector # hard gate — fails on CRITICAL_DEFICIT >= 70 # - id: slop-detector-warn # soft mode — reports only, never blocks # - id: slop-detector-patterns # fast per-file pattern scan

**GitHub Actions** (runs on every PR):

Configuration

```yaml

.slopconfig.yaml

weights: ldr: 0.40 inflation: 0.30 ddc: 0.20 purity: 0.10

patterns: god_function: domain_overrides: - function_pattern: "check_node" # AST walker — complex by design complexity_threshold: 30 lines_threshold: 200

ignore: - "tests/" - "/init.py"

advanced: exact_topology_ceiling: 300 topology_mode_above_ceiling: deterministic_approximate analysis_cache_enabled: true analysis_cache_db: "" churn_commit_window: 200 coverage_data_file: ".coverage" hotspot_limit: 10 hotspot_weights: deficit: 0.50 churn: 0.30 coverage_gap: 0.20

architecture: enabled: true preset: layered layers: [] ```

Full Configuration Guide → · Config Examples →

---

Programmatic Node API

import { scanProject, reviewChanges, computeHealth, runCleanupFamily } from "ai-slop-detector"

Claude Code Integration

```bash cp -r claude-skills/slop-detector ~/.claude/skills/

CI/CD Integration

pre-commit (runs on every commit): ```yaml

.github/workflows/quality-gate.yml

- name: AI-SLOP Gate run: | pip install "ai-slop-detector>=3.7.3" slop-detector --project . --ci-mode hard --ci-report

**Enforcement modes:**

Full CI/CD Integration Guide →

---

VS Code Extension

Real-time inline diagnostics, debounced lint-on-type, ML score and purity signal in status bar. v3.7.1 rebuilt from a single 855-line monolith into eight focused modules.

What you see:

Commands (Ctrl+Shift+P > "SLOP"):

Install from the VS Code Marketplace or build locally:

cd vscode-extension
npm install
npx vsce package          # produces vscode-slop-detector-3.7.3.vsix
code --install-extension vscode-slop-detector-3.7.3.vsix

Settings (slopDetector.*): pythonPath, lintOnSave, lintOnType, failThreshold (default 50), warnThreshold (default 30), recordHistory, enableCodeLens (default true).

---