skannr 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,9 +45,32 @@ skannr --cache-clear
|
|
|
45
45
|
skannr --question "..." --skip-cache
|
|
46
46
|
|
|
47
47
|
# Output: human (default), markdown, or json
|
|
48
|
+
skannr --question "..." --root . --format markdown
|
|
48
49
|
skannr --question "..." --root . --format json
|
|
50
|
+
|
|
51
|
+
# Repository health report (JSON on stdout)
|
|
52
|
+
skannr --report --root .
|
|
53
|
+
|
|
54
|
+
# Re-run analysis when files change (debounced; uses fresh analysis each pass)
|
|
55
|
+
skannr --question "..." --root . --watch
|
|
49
56
|
```
|
|
50
57
|
|
|
58
|
+
### Watch mode (`--watch`)
|
|
59
|
+
|
|
60
|
+
Use `--watch` when you want Skannr to stay running and **re-analyze after relevant file changes** (large repos you edit often). Changes under common build/vendor dirs are ignored (`node_modules`, `.git`, `dist`, etc.). Press **Ctrl+C** to stop.
|
|
61
|
+
|
|
62
|
+
Each run bypasses the analysis cache so results reflect the tree as it is now.
|
|
63
|
+
|
|
64
|
+
### Anonymous telemetry (opt-in)
|
|
65
|
+
|
|
66
|
+
Telemetry is **off unless you enable it** (or accept deferred opt-in — see below). It sends **only which CLI flags were used** — never your question text, file paths, or code.
|
|
67
|
+
|
|
68
|
+
- Enable: `skannr --telemetry-on`
|
|
69
|
+
- Disable: `skannr --telemetry-off`
|
|
70
|
+
|
|
71
|
+
Settings are stored under `~/.skannr/config.json`. The first time you run an analyze command with no config yet, Skannr may show a short notice; you can opt in or out anytime with the flags above.
|
|
72
|
+
|
|
73
|
+
If you take no action, telemetry may turn on automatically **after 7 days** from that notice unless you explicitly disabled it with `--telemetry-off`.
|
|
51
74
|
|
|
52
75
|
## MCP Server
|
|
53
76
|
|