1.7 KiB
Usage
Detector
Run the detector over one or more paths:
cargo run --bin john-slop -- [--fail-confidence 0..100] <PATH>...
Each path may be a UTF-8 text file, a directory, a ZIP archive, or a supported
ZIP-based office document (.docx, .xlsx, or .pptx). Directory traversal and
archive reading stream one result at a time, so callers do not need to retain an
entire input tree in memory.
The current human-readable output contains the source identity, bounded evidence
confidence, and finding count. Findings currently cover configured non-ASCII
hyphen-like characters. More heuristic families and source-highlighted miette
diagnostics are planned.
Exit statuses are stable:
0: every analyzed document is below the requested confidence threshold;1: at least one document reaches the threshold;2: arguments are invalid or an operational/input error prevents completion.
Confidence is a summary of observable configured evidence. It is not an AI-authorship probability.
Supported input policy
Input reads use strict UTF-8 and reject NUL-containing text. They do not follow symlinks by default. Limits on files, walk depth, archive entries, expanded bytes, compression ratio, and member paths protect analysis from unbounded or unsafe input. The exact policy is recorded in ADR 0002.
Formatter and LSP
Cargo already exposes john-slop-fmt and john-slop-lsp so packaging and CI
exercise their target names. Both are explicit scaffolds today and return an
unsupported diagnostic. Replacement planning is available through the library;
file-writing formatter behavior and the stdio language server arrive in later
milestones.