Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/agent.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop agent: local repair sessions with your coding agent"
sidebarTitle: "agent"
title: "Local repair sessions with your coding agent"
sidebarTitle: "Agent"
description: "Run local repair sessions with Codex, Claude Code, or OpenCode while aislop keeps scoring, verification, worktrees, and review in charge."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/badge.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop badge: publish a repository score badge"
sidebarTitle: "badge"
title: "Publish a repository score badge"
sidebarTitle: "Badge"
description: "Generate a README badge URL and markdown snippet for your repository's public aislop score."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/ci.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop ci: quality gate for pull requests and pipelines"
sidebarTitle: "ci"
title: "Quality gate for pull requests and pipelines"
sidebarTitle: "CI"
description: "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."
---

Expand Down
2 changes: 1 addition & 1 deletion cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "aislop commands: complete CLI reference"
title: "Complete CLI reference"
sidebarTitle: "All Commands"
description: "Every public aislop command, alias, and major flag in one place."
---
Expand Down
6 changes: 3 additions & 3 deletions cli/doctor.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop doctor: check engine availability"
sidebarTitle: "doctor"
title: "Check engine availability"
sidebarTitle: "Doctor"
description: "Check which aislop engines, tools, and language targets can run in the current project."
---

Expand Down Expand Up @@ -52,5 +52,5 @@ Some engines require external language toolchains:
If a tool is missing, aislop skips the matching check and reports why. Install the tool, rerun `aislop doctor`, then rerun `aislop scan`.

<Note>
`aislop doctor` does not score the project. It checks readiness and coverage only.
`aislop doctor` does not score the project. It checks readiness and coverage only.
</Note>
205 changes: 108 additions & 97 deletions cli/fix.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop fix: deterministic auto-fix for mechanical slop"
sidebarTitle: "fix"
title: "Deterministic auto-fix for mechanical slop"
sidebarTitle: "Fix"
description: "Mechanically fix reversible and low-risk findings, then use aislop agent or a prompt handoff for issues that need judgment."
---

Expand All @@ -11,129 +11,140 @@ description: "Mechanically fix reversible and low-risk findings, then use aislop
Work through the stages in order to reach 100/100 with the least disruption to your codebase:

<Steps>
<Step title="Run a plain scan to see everything">
Before touching anything, get the full picture.

```bash
aislop scan
```
</Step>

<Step title="Apply only reversible fixes with --safe">
Start conservatively. `--safe` restricts the run to fixes that cannot change behaviour: unused-import removal, import merging, narrative-comment removal, and formatting. Apply these, review the diff, and commit.

```bash
aislop fix --safe
```
</Step>

<Step title="Run the standard auto-fixer">
Without `--safe`, aislop also clears console-log leftovers, removes dead code, and runs lint autofixes. Review the diff before committing.

```bash
aislop fix
```
</Step>

<Step title="Run aggressive fixes with --force">
`--force` adds dependency auditing, framework alignment checks, and unused-file removal. These are more disruptive, so review the diff carefully.

```bash
aislop fix -f
```
</Step>

<Step title="Hand off remaining issues to your agent">
For the full local repair loop, run `aislop agent`. For prompt-based handoff, pass the remaining diagnostics to your coding agent with full diagnostic information:

```bash
aislop agent # recommended local repair workflow
aislop fix --claude # Claude Code
aislop fix --codex # Codex CLI
aislop fix --cursor # Cursor (copies prompt to clipboard)
aislop fix --gemini # Gemini CLI
aislop fix -p # Print prompt (agent-agnostic)
```
</Step>

<Step title="Verify with a final scan">
Confirm everything is resolved.

```bash
aislop scan
```
</Step>
<Step title="Run a plain scan to see everything">
Before touching anything, get the full picture.

```bash
aislop scan
```
</Step>

<Step title="Apply only reversible fixes with --safe">
Start conservatively. `--safe` restricts the run to fixes that cannot change behaviour: unused-import removal,
import merging, narrative-comment removal, and formatting. Apply these, review the diff, and commit.

```bash
aislop fix --safe
```
</Step>

<Step title="Run the standard auto-fixer">
Without `--safe`, aislop also clears console-log leftovers, removes dead code, and runs lint autofixes. Review
the diff before committing.

```bash
aislop fix
```
</Step>

<Step title="Run aggressive fixes with --force">
`--force` adds dependency auditing, framework alignment checks, and unused-file removal. These are more
disruptive, so review the diff carefully.

```bash
aislop fix -f
```
</Step>

<Step title="Hand off remaining issues to your agent">
For the full local repair loop, run `aislop agent`. For prompt-based handoff, pass the remaining diagnostics to
your coding agent with full diagnostic information:

```bash
aislop agent # recommended local repair workflow
aislop fix --claude # Claude Code
aislop fix --codex # Codex CLI
aislop fix --cursor # Cursor (copies prompt to clipboard)
aislop fix --gemini # Gemini CLI
aislop fix -p # Print prompt (agent-agnostic)
```
</Step>

<Step title="Verify with a final scan">
Confirm everything is resolved.

```bash
aislop scan
```
</Step>
</Steps>

## Flags

<ParamField query="-d, --verbose" type="boolean">
Show detailed progress for each fix operation as it runs, including which files are modified and which rules are being resolved.
Show detailed progress for each fix operation as it runs, including which files are modified and which rules are
being resolved.
</ParamField>

<ParamField query="-f, --force" type="boolean">
Run aggressive fixes in addition to standard ones. This includes dependency auditing, framework dependency alignment, and unused-file removal. Changes here are more likely to affect behaviour—review the diff before committing.
Run aggressive fixes in addition to standard ones. This includes dependency auditing, framework dependency
alignment, and unused-file removal. Changes here are more likely to affect behaviour—review the diff before
committing.

```bash
aislop fix -f
```
```bash
aislop fix -f
```
</ParamField>

<ParamField query="--safe" type="boolean">
Restrict the run to reversible fixes only. Safe mode applies:
- Unused-import removal
- Import merging
- Narrative-comment removal
- Formatting
Restrict the run to reversible fixes only. Safe mode applies:
- Unused-import removal
- Import merging
- Narrative-comment removal
- Formatting

Anything that deletes code or rewrites behaviour—console removal, dead-code elimination, lint autofixes, unused-declaration pruning, and dependency changes—is skipped. A `--safe` run is designed to be "apply and commit" without review.
Anything that deletes code or rewrites behaviour—console removal, dead-code elimination, lint autofixes,
unused-declaration pruning, and dependency changes—is skipped. A `--safe` run is designed to be "apply and commit"
without review.

```bash
aislop fix --safe
```
```bash
aislop fix --safe
```
</ParamField>

<ParamField query="-p, --prompt" type="boolean">
Print an agent-ready prompt to stdout describing the remaining issues, without opening any specific agent. Use this flag when you want to paste the prompt into any tool or inspect it first.
Print an agent-ready prompt to stdout describing the remaining issues, without opening any specific agent. Use this
flag when you want to paste the prompt into any tool or inspect it first.

```bash
aislop fix -p
```
```bash
aislop fix -p
```
</ParamField>

## Prompt handoff flags

When auto-fix can't resolve an issue and you do not want the full `aislop agent` workflow, pass the remaining diagnostics to your coding agent. Each flag opens that agent and provides the structured prompt automatically. Use `--prompt` / `-p` if you prefer an agent-agnostic output you can paste anywhere.

<Tabs>
<Tab title="Terminal agents">
| Flag | Agent |
|---|---|
| `--claude` | Claude Code |
| `--codex` | Codex CLI |
| `--gemini` | Gemini CLI |
| `--kimi` | Kimi Code CLI |
| `--opencode` | OpenCode |
| `--aider` | Aider |
| `--goose` | Goose |
| `--pi` | pi |
| `--crush` | Crush |
| `--amp` | Amp |
| `--warp` | Warp |
</Tab>
<Tab title="Editor agents">
| Flag | Agent |
|---|---|
| `--cursor` | Cursor (copies prompt to clipboard) |
| `--windsurf` | Windsurf (copies prompt to clipboard) |
| `--vscode` | VS Code (copies prompt to clipboard) |
| `--antigravity` | Antigravity |
| `--deep-agents` | Deep Agents |
</Tab>
<Tab title="Terminal agents">
| Flag | Agent |
|---|---|
| `--claude` | Claude Code |
| `--codex` | Codex CLI |
| `--gemini` | Gemini CLI |
| `--kimi` | Kimi Code CLI |
| `--opencode` | OpenCode |
| `--aider` | Aider |
| `--goose` | Goose |
| `--pi` | pi |
| `--crush` | Crush |
| `--amp` | Amp |
| `--warp` | Warp |
</Tab>
<Tab title="Editor agents">
| Flag | Agent |
|---|---|
| `--cursor` | Cursor (copies prompt to clipboard) |
| `--windsurf` | Windsurf (copies prompt to clipboard) |
| `--vscode` | VS Code (copies prompt to clipboard) |
| `--antigravity` | Antigravity |
| `--deep-agents` | Deep Agents |
</Tab>
</Tabs>

<Tip>
Use `--prompt` (`-p`) to print the agent handoff prompt without opening any specific tool. You can then paste it into any agent, share it with a teammate, or inspect the diagnostics before deciding what to do next.
Use `--prompt` (`-p`) to print the agent handoff prompt without opening any specific tool. You can then paste it
into any agent, share it with a teammate, or inspect the diagnostics before deciding what to do next.
</Tip>

## What --safe restricts
Expand Down
4 changes: 2 additions & 2 deletions cli/hooks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop hook: real-time quality gates for AI agents"
sidebarTitle: "hooks"
title: "Real-time quality gates for AI agents"
sidebarTitle: "Hooks"
description: "Install hooks that run after every AI agent edit and give instant score feedback, blocking regressions before they reach your repository."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/init.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop init: create project config and CI workflow"
sidebarTitle: "init"
title: "Create project config and CI workflow"
sidebarTitle: "Init"
description: "Create .aislop/config.yml, optional architecture rules, and an optional GitHub Actions quality gate."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/rules.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop rules: inspect rule IDs, severity, fixability, and impact"
sidebarTitle: "rules"
title: "Inspect rule IDs, severity, fixability, and impact"
sidebarTitle: "Rules"
description: "List every rule, search interactively, and understand severity, fixability, and score impact before overriding or suppressing findings."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/scan.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop scan: score your codebase for AI slop"
sidebarTitle: "scan"
title: "Score your codebase for AI slop"
sidebarTitle: "Scan"
description: "Run all analysis engines in parallel, get a 0–100 score, and see exactly which AI-authored patterns are dragging your codebase down."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/trend.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop trend: local score history"
sidebarTitle: "trend"
title: "Local score history"
sidebarTitle: "Trend"
description: "Read local score history from .aislop/history.jsonl and see how a project's score changes over time."
---

Expand Down
4 changes: 2 additions & 2 deletions cli/update-version.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "aislop update, upgrade, version, and commands"
sidebarTitle: "update/version"
title: "upgrade, version, and commands"
sidebarTitle: "Update/version"
description: "Check installed versions, compare against the latest npm release, and print the built-in command reference."
---

Expand Down
2 changes: 1 addition & 1 deletion concepts/how-it-works.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "How aislop scans and scores your code"
title: "How Scanaislop scans and scores your code"
sidebarTitle: "How It Works"
description: "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."
---
Expand Down
2 changes: 1 addition & 1 deletion concepts/rules.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "aislop rule categories and what they catch"
title: "Scanaislop rule categories and what they catch"
sidebarTitle: "Rules"
description: "Explore aislop's six rule engines — Formatting, Linting, Code Quality, AI Slop, Security, and Architecture — and the 50+ patterns they detect across 8 languages."
---
Expand Down
4 changes: 2 additions & 2 deletions concepts/scoring.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Understanding aislop's 0-100 code quality score"
title: "Understanding Scanaislop's 0-100 code quality score"
sidebarTitle: "Scoring"
description: "Understand how aislop converts diagnostic findings into a single 0-100 score using severity penalties, engine weights, rule-impact tiers, density normalization, and saturation caps."
description: "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."
---

Every aislop scan produces a single number between 0 and 100. That number is calculated deterministically from the findings each engine produces - no randomness, no LLM judgment calls. Understanding how the score is built helps you tune it for your team and interpret what it means when it changes.
Expand Down
2 changes: 1 addition & 1 deletion concepts/supported-languages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Supported languages and frameworks"
sidebarTitle: "Languages"
description: "See which aislop engines run for TypeScript, JavaScript, Expo, Python, Go, Rust, Ruby, and PHP, plus the framework detection rules used during scans."
description: "See which Scanaislop engines run for TypeScript, JavaScript, Expo, Python, Go, Rust, Ruby, and PHP, plus the framework detection rules used during scans."
---

aislop detects languages and frameworks from the files and manifests in your repository, then runs every enabled engine that applies. Missing external tools are skipped instead of failing the scan; run `aislop doctor` when you want to see exactly which engines are available on your machine.
Expand Down
2 changes: 1 addition & 1 deletion configuration/config-file.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Configure aislop with .aislop/config.yml"
title: "Configure scanaislop with .aislop/config.yml"
sidebarTitle: "Config File"
description: "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."
---
Expand Down
Loading