Skip to main content
Beyond scan, fix, ci, and hook, aislop ships several supporting commands for project setup, toolchain verification, rule exploration, badge generation, score tracking, and version management. This page covers each one with its key flags and usage examples.

​
aislop init

Creates .aislop/config.yml (your policy file) and optionally .aislop/rules.yml and a CI workflow file. Run this once when you add aislop to a project to get a sensible starting configuration without writing YAML by hand. 
aislop init
aislop init ./my-project
Answer the interactive prompts to:
  • Set your failBelow threshold
  • Enable or disable specific engines
  • Generate a GitHub Actions workflow at .github/workflows/aislop.yml

​
—strict

Generate an enterprise-grade configuration: all engines enabled, typecheck turned on, failBelow set to 85, and the CI workflow included automatically. 
aislop init --strict
Commit both .aislop/config.yml and the generated workflow file. The workflow uses npx --yes aislop@latest ci, so there is no version to bump as the CLI is updated.

​
aislop doctor

Checks which analysis engines can run in the current project and reports coverage. Run this after installing aislop on a new machine or in a new environment to confirm the full toolchain is available. 
aislop doctor
aislop doctor ./src
Doctor reports on each engine—formatting, linting, code quality, AI slop, security, and architecture—and tells you which ones are active, which are skipped due to missing tools, and which languages are covered. If an engine reports as skipped, the output tells you what to install to enable it.
aislop doctor does not run a scan. It only checks engine availability and project coverage. No score is produced.

​
aislop rules

Lists all 50+ rules with their IDs, severity levels, fixability, and descriptions. Use this command to understand what each rule catches before you override or suppress it. 
aislop rules
aislop rules ./src

​
—search

Open an interactive, searchable rule explorer in your terminal. Type to filter by rule ID, description, or engine. 
aislop rules --search
Rules are grouped by engine. Each entry shows:
  • The rule ID (e.g. ai-slop/narrative-comment)
  • The default severity (error or warning)
  • Whether the rule is auto-fixable
  • A short description of what it catches
To override the severity of a rule or turn it off entirely, add it to .aislop/config.yml: 
rules:
  ai-slop/narrative-comment: warning   # error | warning | off
  ai-slop/trivial-comment: "off"
  security/hardcoded-secret: error

​
aislop badge

Generates the badge URL and README markdown for your repository’s aislop score. Scores are hosted at badges.scanaislop.com and link through to your project’s page on scanaislop.com. 
aislop badge
The command auto-detects your GitHub owner and repo name from the git remote. Pass them explicitly if the auto-detection fails: 
aislop badge --owner scanaislop --repo aislop

​
Flags

FlagDescription
--owner <owner>GitHub owner (auto-detected from git remote if omitted)
--repo <repo>GitHub repo name (auto-detected from git remote if omitted)
--jsonEmit machine-readable JSON instead of rendered markdown

​
Example output

[![aislop](https://badges.scanaislop.com/score/scanaislop/aislop.svg)](https://scanaislop.com)
Paste this into your README to display a live score badge. The badge updates automatically after each CI run.

​
aislop trend

Reads .aislop/history.jsonl and prints a table of recent scores alongside an ASCII sparkline, so you can see how your score has moved over time. 
aislop trend
aislop trend ./src

​
—limit

Control how many recent runs to display: 
aislop trend --limit 20

​
How score history works

A full-project interactive scan automatically appends a compact record to .aislop/history.jsonl. Each record includes:
  • Timestamp
  • Score
  • Error and warning counts
  • File count
  • CLI version
History is a local side effect only. aislop never writes to .aislop/history.jsonl when:
  • Running with --json or --sarif
  • Running aislop ci
  • The environment variable AISLOP_NO_HISTORY=1 is set
This keeps machine output clean and deterministic. aislop trend only reflects local interactive runs.

​
aislop update / aislop upgrade

Checks npm for the latest published version of aislop and compares it to the installed version. upgrade is an alias for update—they do the same thing. 
aislop update
aislop upgrade
This command does not install anything. It prints the current version and the latest available version so you can decide whether to upgrade. To upgrade, run the appropriate install command for your package manager: 
npm install -g aislop@latest
brew upgrade scanaislop/tap/aislop
pipx upgrade aislop

​
aislop version

Prints the installed CLI version to stdout. 
aislop version
aislop -v
aislop -V
aislop --version

​
aislop commands

Prints the full command reference—every public command and its major flags—directly in your terminal. 
aislop commands
Use aislop <command> --help for detailed help on a single command: 
aislop scan --help
aislop fix --help
aislop hook install --help