# Scanaislop Documentation

## Docs

- [AGENTS](https://scanaislop-update.mintlify.app/AGENTS.md)
- [Local repair sessions with your coding agent](https://scanaislop-update.mintlify.app/cli/agent.md): Run local repair sessions with Codex, Claude Code, or OpenCode while aislop keeps scoring, verification, worktrees, and review in charge.
- [Publish a repository score badge](https://scanaislop-update.mintlify.app/cli/badge.md): Generate a README badge URL and markdown snippet for your repository's public aislop score.
- [Quality gate for pull requests and pipelines](https://scanaislop-update.mintlify.app/cli/ci.md): Run aislop as a quality gate in any CI provider. Exits non-zero when the score drops below your threshold or an error-severity finding is present.
- [Complete CLI reference](https://scanaislop-update.mintlify.app/cli/commands.md): Every public aislop command, alias, and major flag in one place.
- [Check engine availability](https://scanaislop-update.mintlify.app/cli/doctor.md): Check which aislop engines, tools, and language targets can run in the current project.
- [Deterministic auto-fix for mechanical slop](https://scanaislop-update.mintlify.app/cli/fix.md): Mechanically fix reversible and low-risk findings, then use aislop agent or a prompt handoff for issues that need judgment.
- [Real-time quality gates for AI agents](https://scanaislop-update.mintlify.app/cli/hooks.md): Install hooks that run after every AI agent edit and give instant score feedback, blocking regressions before they reach your repository.
- [Create project config and CI workflow](https://scanaislop-update.mintlify.app/cli/init.md): Create .aislop/config.yml, optional architecture rules, and an optional GitHub Actions quality gate.
- [Inspect rule IDs, severity, fixability, and impact](https://scanaislop-update.mintlify.app/cli/rules.md): List every rule, search interactively, and understand severity, fixability, and score impact before overriding or suppressing findings.
- [Score your codebase for AI slop](https://scanaislop-update.mintlify.app/cli/scan.md): Run all analysis engines in parallel, get a 0–100 score, and see exactly which AI-authored patterns are dragging your codebase down.
- [Local score history](https://scanaislop-update.mintlify.app/cli/trend.md): Read local score history from .aislop/history.jsonl and see how a project's score changes over time.
- [upgrade, version, and commands](https://scanaislop-update.mintlify.app/cli/update-version.md): Check installed versions, compare against the latest npm release, and print the built-in command reference.
- [How Scanaislop scans and scores your code](https://scanaislop-update.mintlify.app/concepts/how-it-works.md): Learn how aislop's six parallel engines analyze your codebase across 8 languages and produce a deterministic 0–100 quality score in under a second.
- [Scanaislop rule categories and what they catch](https://scanaislop-update.mintlify.app/concepts/rules.md): Explore aislop's six rule engines — Formatting, Linting, Code Quality, AI Slop, Security, and Architecture — and the 50+ patterns they detect across 8 languages.
- [Understanding Scanaislop's 0-100 code quality score](https://scanaislop-update.mintlify.app/concepts/scoring.md): Understand how Scanaislop converts diagnostic findings into a single 0-100 score using severity penalties, engine weights, rule-impact tiers, density normalization, and saturation caps.
- [Supported languages and frameworks](https://scanaislop-update.mintlify.app/concepts/supported-languages.md): See which Scanaislop engines run for TypeScript, JavaScript, Expo, Python, Go, Rust, Ruby, and PHP, plus the framework detection rules used during scans.
- [Enforce custom import and layering rules in aislop](https://scanaislop-update.mintlify.app/configuration/architecture-rules.md): Define project-specific import bans, layer boundaries, and required patterns in .aislop/rules.yml to enforce your architecture automatically on every scan.
- [Configure scanaislop with .aislop/config.yml](https://scanaislop-update.mintlify.app/configuration/config-file.md): Learn how to create and customise the .aislop/config.yml file that controls every aislop engine, scoring weight, and CI quality gate in your project.
- [Enable and tune scanaislop engines per project](https://scanaislop-update.mintlify.app/configuration/engines.md): Control which of aislop's six analysis engines run, adjust quality thresholds, tune scoring weights, and set the CI score gate for your project.
- [Example aislop configs](https://scanaislop-update.mintlify.app/configuration/example-configs.md): Copy starting-point .aislop/config.yml profiles for strict TypeScript projects, relaxed monorepos, Python and Go backends, and architecture rules.
- [Exclude files and paths from aislop scans](https://scanaislop-update.mintlify.app/configuration/ignoring-code.md): Use .aislopignore, the exclude key in config.yml, or CLI flags to keep generated files, snapshots, and legacy paths out of every aislop scan.
- [Override rule severity or disable rules in aislop](https://scanaislop-update.mintlify.app/configuration/rule-overrides.md): Change the severity of any aislop rule project-wide via config, or silence specific findings inline with suppression comments in any language.
- [Write comments that survive aislop](https://scanaislop-update.mintlify.app/guides/writing-comments.md): A practical guide to comments that earn their place, comments that aislop removes, and the trivial-comment and narrative-comment rules.
- [Scan your code for AI slop](https://scanaislop-update.mintlify.app/index.md): Understand what scanaislop is, the problem it solves, its six analysis engines, supported languages, and the key properties that make it reliable in CI.
- [npm, Homebrew, pipx, and more](https://scanaislop-update.mintlify.app/installation.md): Every way to install aislop; npm, Yarn, pnpm, Bun, Homebrew, pipx, and GitHub Packages; plus requirements, bundled tools, and external tool setup.
- [Install the Scanaislop agent skill](https://scanaislop-update.mintlify.app/integrations/agent-skill.md): Install aislop as an agent skill so coding agents know when to scan, how to interpret findings, and how to fix AI-slop patterns before handing work back.
- [Scanaislop CI/CD integration for GitLab, CircleCI, Bitbucket](https://scanaislop-update.mintlify.app/integrations/ci-cd.md): Add scanaislop quality gates to GitLab CI, CircleCI, and Bitbucket Pipelines with copy-paste YAML configs and PR-scoped file diffing.
- [Add Scanaislop to GitHub Actions as a quality gate](https://scanaislop-update.mintlify.app/integrations/github-actions.md): Gate every pull request and push with aislop's 0–100 quality score in GitHub Actions, with optional SARIF upload to the Security tab.
- [Instant scans on scanaislop.com](https://scanaislop-update.mintlify.app/integrations/instant-scan.md): Scan a public GitHub repository from the browser by swapping github.com for scanaislop.com, with no install or account required.
- [scanaislop MCP server for Claude Desktop and Cursor](https://scanaislop-update.mintlify.app/integrations/mcp-server.md): Expose aislop's scan, fix, and explain tools inside Claude Desktop, Cursor, and Codex via the Model Context Protocol with zero install.
- [Run Scanaislop as a pre-commit hook on staged files](https://scanaislop-update.mintlify.app/integrations/pre-commit.md): Block commits that introduce AI slop by running aislop on staged files only, using a direct command or the pre-commit framework.
- [Scanaislop VS Code extension: inline diagnostics and score](https://scanaislop-update.mintlify.app/integrations/vscode.md): See scanaislop findings as inline squiggles and a live status-bar score in VS Code, with automatic re-scan on save and a one-click workspace scan.
- [Scan your code for AI slop](https://scanaislop-update.mintlify.app/introduction.md): Understand what scanaislop is, the problem it solves, its six analysis engines, supported languages, and the key properties that make it reliable in CI.
- [Get started with aislop in under a minute](https://scanaislop-update.mintlify.app/quickstart.md): Scan your first project, read your score, repair issues, and add a CI quality gate — all in four steps with no upfront configuration.
- [Changelog](https://scanaislop-update.mintlify.app/reference/changelog.md): Recent scanaislop releases and the user-facing changes they introduced.
- [Configuration schema reference](https://scanaislop-update.mintlify.app/reference/config-schema.md): Reference for the published aislop JSON Schema and every top-level .aislop/config.yml key.
- [Automated fix to PR design](https://scanaislop-update.mintlify.app/reference/fix-to-pr.md): Design reference for a hosted fix-to-open-PR flow where aislop scores every iteration and only keeps changes that improve deterministic quality.
- [GitHub Marketplace Action listing](https://scanaislop-update.mintlify.app/reference/github-marketplace-action.md): Status, naming constraints, and release checklist for publishing the scanaislop/aislop composite Action to GitHub Marketplace.
- [OSS benchmark harness](https://scanaislop-update.mintlify.app/reference/oss-benchmarking.md): Run the frozen GitHub Trending benchmark harness used to validate aislop precision across TypeScript, Python, Go, Rust, Ruby, PHP, and Java projects.
- [Release checklist](https://scanaislop-update.mintlify.app/reference/release-checklist.md): The maintainer checklist for cutting an aislop release, covering code, tests, docs, external surfaces, release mechanics, and post-release verification.
- [aislop research program](https://scanaislop-update.mintlify.app/reference/research-program.md): The public scan protocol for repeatable AI-code-quality research, benchmark writeups, and rule provenance.
- [aislop rules reference: all 50+ rules by engine](https://scanaislop-update.mintlify.app/reference/rules-reference.md): Complete reference for all 50+ scanaislop rules across six engines — formatting, linting, code quality, AI slop, security, and architecture.
- [what's collected and how to opt out](https://scanaislop-update.mintlify.app/reference/telemetry.md): Scanaislop collects anonymous usage analytics to prioritize improvements. No code, file paths, project names, or secrets are ever collected.