# Git Slop CLI Reference
Generated from the live Clap command tree.
## `git-slop`
Find the files that cost too much context.
| `--repo` | Repository or path inside a repository to analyze |
| `--error-format` | Render runtime errors as human text or stable JSON |
## `git-slop init`
Scaffold .slop/ config, ignore rules, and state directories
| `--force` | Overwrite generated config files |
## `git-slop find`
Scan the repository and generate hotspot reports
| `--allow-shallow` | Acknowledge incomplete history and continue in a shallow clone |
| `--scope` | Analyze only this repo-relative path while retaining repository-wide Git evidence |
| `--allow-empty-scope` | Permit a scope that selects no tracked paths and emit an empty analysis |
| `--quiet` | Suppress human progress and report-path messages |
| `--no-progress` | Suppress phase progress while preserving the final result |
| `--state-dir` | Mutable cache/state directory. Relative paths resolve from the repository root |
| `--output-dir` | Report output directory. Relative paths resolve from the repository root |
| `--no-cache` | Disable token-cache reads and writes for an ephemeral scan |
| `--allow-degraded` | Deterministically analyze the largest path prefix that fits the memory budget |
| `--report-profile` | Report evidence profile |
| `--compression` | Also write a compressed report beside report.json |
| `--estimate-only` | Estimate scope, memory, cache, report size, time, and inodes without scanning |
## `git-slop show`
Show metrics and reasons for one file or folder
| `target_path` | Repo-relative file or folder path |
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--format` | |
## `git-slop explain`
Explain why selected hotspots or structural findings are expensive
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--path` | Repo-relative file or folder path |
| `--cluster` | Cluster identifier |
| `--relationship` | Relationship identifier |
| `--top` | Explain the top N hotspots from the action queue |
| `--format` | |
| `--prompt-pack` | Write a deterministic local-model prompt pack to this directory |
| `--include-repository-context` | Include bounded local source/test excerpts, guidance, and verification hints |
| `--excerpt-bytes` | Maximum bytes read from each included repository file |
## `git-slop plan`
Propose bounded maintenance slices from the current detector report
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--path` | Repo-relative file or folder path |
| `--cluster` | Cluster identifier |
| `--relationship` | Relationship identifier |
| `--max-slices` | Maximum number of bounded maintenance slices to propose |
| `--format` | |
| `--prompt-pack` | Write a deterministic local-model prompt pack to this directory |
| `--include-repository-context` | Include bounded local source/test excerpts, guidance, and verification hints |
| `--excerpt-bytes` | Maximum bytes read from each included repository file |
## `git-slop check`
Evaluate an existing report against CI thresholds
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--fail-on-context-band` | Override the config default fail threshold for context_band |
| `--fail-on-slop-band` | Override the config default fail threshold for slop_band |
| `--format` | |
| `--details` | Include complete finding records in JSON output |
## `git-slop compare`
Compare two existing schema-5 reports without rerunning the detector
| `--base` | Base report.json path |
| `--base-ref` | Safely resolve and scan this Git revision in an isolated worktree |
| `--head` | Head report.json path |
| `--scope` | Apply the head repository's scope to an isolated --base-ref scan |
| `--allow-shallow` | Permit incomplete history in an isolated --base-ref scan |
| `--top` | Maximum number of changed files and queue movements to show |
| `--format` | |
| `--detail` | Detail level for machine output |
| `--offset` | Zero-based record offset for --detail full |
| `--limit` | Maximum records per collection for --detail full |
| `--force` | Compare reports with incompatible identity or analyzer metadata |
| `--fail-on-regression` | Exit 1 when an existing file worsens or a newly added file is a finding |
## `git-slop report`
Validate or inspect the versioned report contract
## `git-slop report validate`
Validate one report against the complete schema-5 contract
| `path` | |
| `--allow-legacy` | Accept schema 4 as migration input and validate its normalized schema-5 form |
## `git-slop report migrate`
Migrate a schema-4 report to normalized schema 5
| `path` | |
| `--output` | |
## `git-slop report schema`
Print the published JSON Schema for report schema 5
## `git-slop sarif`
Export action-queue findings from an existing schema-5 report as SARIF
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--top` | Maximum number of action-queue findings to export |
| `--output` | Optional SARIF output path. Defaults to stdout |
## `git-slop health`
Render repository health for CI summaries, annotations, or automation
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--format` | Output suited for a job summary, workflow annotations, or automation |
| `--max-annotations` | Maximum number of GitHub workflow annotations to emit |
## `git-slop config`
Inspect or migrate effective configuration
## `git-slop config show`
Show configuration; --effective includes defaults
| `--effective` | |
## `git-slop config validate`
Validate the local configuration
## `git-slop config diff-defaults`
Show only values that differ from defaults
## `git-slop config migrate`
Rewrite legacy schema configuration as a minimal schema-2 override
## `git-slop config schema`
Print the supported configuration schema as JSON
## `git-slop doctor`
Diagnose repository readiness and optionally write a redacted bundle
| `--bundle` | Write a privacy-safe diagnostic JSON bundle |
| `--format` | |
| `--scope` | Estimate only this repo-relative scope |
## `git-slop list`
List findings, relationships, clusters, or profiles
## `git-slop list findings`
| `--report` | |
| `--path` | |
| `--profile` | |
| `--language` | |
| `--classification` | |
| `--severity` | |
| `--top` | |
| `--format` | |
| `--wide` | Use a wider terminal layout before truncating fields |
| `--no-truncate` | Never truncate terminal fields |
## `git-slop list relationships`
| `--report` | |
| `--path` | |
| `--profile` | |
| `--language` | |
| `--classification` | |
| `--severity` | |
| `--top` | |
| `--format` | |
| `--wide` | Use a wider terminal layout before truncating fields |
| `--no-truncate` | Never truncate terminal fields |
## `git-slop list clusters`
| `--report` | |
| `--path` | |
| `--profile` | |
| `--language` | |
| `--classification` | |
| `--severity` | |
| `--top` | |
| `--format` | |
| `--wide` | Use a wider terminal layout before truncating fields |
| `--no-truncate` | Never truncate terminal fields |
## `git-slop list profiles`
| `--report` | |
| `--path` | |
| `--profile` | |
| `--language` | |
| `--classification` | |
| `--severity` | |
| `--top` | |
| `--format` | |
| `--wide` | Use a wider terminal layout before truncating fields |
| `--no-truncate` | Never truncate terminal fields |
## `git-slop prune`
Remove old immutable run snapshots according to retention policy
| `--keep` | Number of newest run snapshots to retain; defaults to output.retention_runs |
| `--max-bytes` | Maximum total bytes retained; defaults to output.retention_bytes |
| `--dry-run` | Print removals without changing files |
| `--format` | Select text, JSON, or YAML output |
## `git-slop cache`
Inspect or prune the packed token cache
| `--state-dir` | |
## `git-slop cache status`
| `--format` | |
## `git-slop cache prune`
| `--max-entries` | |
| `--max-bytes` | |
| `--dry-run` | |
| `--format` | |
## `git-slop completions`
Generate shell completion source
| `shell` | |
## `git-slop man`
Generate the roff manual from the live Clap command tree
| `--output` | |
## `git-slop reference`
Generate Markdown command reference from the live Clap command tree
| `--output` | |
## `git-slop html`
Write a self-contained, local, searchable HTML report
| `--report` | Report path. Defaults to .slop/latest/report.json |
| `--output` | Destination. Defaults to .slop/latest/report.html |
## `git-slop version`
Print version information
## `git-slop build-info`
Print package and source-build provenance
| `--format` | |
## `git-slop schema`
Print a published JSON Schema for a machine contract
| `contract` | |