Skip to content

Commit b996e31

Browse files
committed
docs(cli): update docs for refactored command surface
1 parent 940c842 commit b996e31

3 files changed

Lines changed: 69 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4949
- Added an agent workflow guide covering JSON-first review, cleanup, health,
5050
and MCP-assisted usage patterns.
5151

52+
**Local impact and opt-in telemetry**
53+
54+
- Added repo-local impact tracking commands:
55+
- `slop-detector impact enable`
56+
- `slop-detector impact`
57+
- `slop-detector impact disable`
58+
- Impact snapshots are stored in gitignored `.slop-detector/impact.json` and
59+
summarize trend deltas across repeated runs.
60+
- Added telemetry control commands:
61+
- `slop-detector telemetry status`
62+
- `slop-detector telemetry enable`
63+
- `slop-detector telemetry disable`
64+
- `slop-detector telemetry inspect --example`
65+
- Added anonymized telemetry payload construction and local queueing.
66+
- Added inspect-first telemetry mode:
67+
- `AI_SLOP_DETECTOR_TELEMETRY=inspect`
68+
- prints a real payload without queueing or sending it
69+
5270
### Changed
5371

5472
- Adaptive suggestions stay conservative and evidence-backed:
@@ -61,6 +79,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6179
adaptive preview, and explicit merge as distinct flows.
6280
- npm wrapper documentation now states explicitly that Node is a transport
6381
surface over the Python core, not a second implementation.
82+
- Impact and telemetry surfaces are kept out of the scoring path:
83+
scoring remains deterministic, while adoption observability is opt-in and
84+
separately controlled.
6485

6586
---
6687

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ File-level evidence. Machine-readable output. No LLM in the scoring path.
2727
- Previous stable tag: `v3.8.0`
2828
- `v3.8.0` establishes the canonical `scan / review / pulse / sweep` CLI surface and hardens dogfood operation paths used by `health` and `audit`.
2929
- `v3.8.1` adds confidence-ranked cleanup plans, manifest hygiene, and opt-in layered architecture review.
30+
- Unreleased work adds repo-local impact tracking and default-off telemetry controls.
3031

3132
---
3233

@@ -127,6 +128,14 @@ import type { ReviewOutput, ScanOutput } from "ai-slop-detector/types"
127128
# Programmatic Node API
128129
import { scanProject, reviewChanges, computeHealth, runCleanupFamily } from "ai-slop-detector"
129130

131+
# Local impact story
132+
slop-detector impact enable .
133+
slop-detector impact .
134+
135+
# Telemetry controls (default: off)
136+
slop-detector telemetry status
137+
slop-detector telemetry inspect --example
138+
130139
# Local wrapper development
131140
cd npm-wrapper
132141
node ./bin/ai-slop-detector.js --version
@@ -213,6 +222,14 @@ slop-detector mcp
213222
slop-mcp
214223
```
215224
225+
Adoption and observability surfaces are intentionally separate from scoring:
226+
227+
- `slop-detector impact` tracks local, gitignored repository progress in
228+
`.slop-detector/impact.json`
229+
- `slop-detector telemetry` stays default-off and only builds anonymized
230+
payloads; `AI_SLOP_DETECTOR_TELEMETRY=inspect` prints a real payload without
231+
queueing it
232+
216233
---
217234
218235
## Scope And Boundaries

docs/CLI_USAGE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,37 @@ slop-detector --export-history history.jsonl
312312
slop-detector mycode.py --no-history
313313
```
314314

315+
## Local Impact & Telemetry
316+
317+
```bash
318+
# Enable repo-local impact tracking (.slop-detector/impact.json)
319+
slop-detector impact enable .
320+
321+
# Show local impact summary
322+
slop-detector impact .
323+
slop-detector impact --json
324+
325+
# Telemetry stays off by default
326+
slop-detector telemetry status
327+
328+
# Inspect an example anonymized payload
329+
slop-detector telemetry inspect --example
330+
331+
# Inspect a live payload without queueing it
332+
AI_SLOP_DETECTOR_TELEMETRY=inspect slop-detector review . --format json
333+
334+
# Opt in to local telemetry queueing
335+
slop-detector telemetry enable
336+
slop-detector telemetry disable
337+
```
338+
339+
Contracts:
340+
341+
- `impact` is repository-local and gitignored
342+
- telemetry is default-off
343+
- telemetry payloads are anonymized and keyed by `project_id`, not path names
344+
- inspect mode prints a real payload without appending to the telemetry queue
345+
315346
---
316347

317348
## CI/CD Integration

0 commit comments

Comments
 (0)