sverklo 0.29.1 → 0.29.2

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 CHANGED
@@ -12,18 +12,22 @@ Sverklo gives coding agents repo memory: symbols, callers, diffs, blast radius,
12
12
 
13
13
  **Local-first** ◦ MIT ◦ no API keys ◦ no code upload ◦ first run downloads a local ONNX model
14
14
 
15
- Use grep when you know the exact string. Use Sverklo when the agent needs relationships: who calls this, what depends on it, what changed, and which project decisions still apply. The public bench covers 180 hand-verified tasks across 6 OSS codebases; the methodology and ground truth live in [sverklo/sverklo-bench](https://github.com/sverklo/sverklo-bench). [Bench](https://sverklo.com/bench/) · [paper](https://doi.org/10.5281/zenodo.19802051) · [90-second demo](https://www.youtube.com/watch?v=OX7aEgdlqhQ)
15
+ **Use Sverklo when** your agent needs relationships before editing: callers, dependencies, tests, diff risk, or prior repo decisions.
16
+
17
+ **Use grep/ripgrep when** you know the exact string, the repo is tiny, or the change is one file.
18
+
19
+ Start with the no-write proof command before installing MCP config. The public bench covers 180 hand-verified tasks across 6 OSS codebases; the methodology and ground truth live in [sverklo/sverklo-bench](https://github.com/sverklo/sverklo-bench). [Bench](https://sverklo.com/bench/) · [paper](https://doi.org/10.5281/zenodo.19802051) · [90-second demo](https://www.youtube.com/watch?v=OX7aEgdlqhQ)
16
20
 
17
21
  ```bash
18
22
  cd your-project
19
- npm exec --yes --package=sverklo@latest -- sverklo prove --no-write --guided
23
+ npm exec --yes --package=sverklo@latest -- sverklo prove --no-write --guided --markdown
20
24
  sverklo init --dry-run
21
25
  npm install -g sverklo && sverklo init
22
26
  ```
23
27
 
24
- `sverklo prove --no-write --guided` shows central files, a real symbol with callers, why that proof was selected, and the exact prompt to paste into your agent before any MCP config or instruction files are written. It may cache the local model/index under `~/.sverklo`, but it does not mutate your project. `sverklo init --dry-run` then previews the files `init` would touch; `sverklo init` writes the MCP config for your agent, appends local instructions to `AGENTS.md` or `CLAUDE.md`, and runs `sverklo doctor` to verify the handshake. Your code stays on your machine.
28
+ `sverklo prove --no-write --guided --markdown` shows central files, a real symbol with callers, why that proof was selected, the exact prompt to paste into your agent, and a small feedback template before any MCP config or instruction files are written. It may cache the local model/index under `~/.sverklo`, but it does not mutate your project. `sverklo init --dry-run` then previews the files `init` would touch; `sverklo init` writes the MCP config for your agent, appends local instructions to `AGENTS.md` or `CLAUDE.md`, and runs `sverklo doctor` to verify the handshake. Your code stays on your machine.
25
29
 
26
- Need something shareable? Run `sverklo prove --markdown` to print a GitHub/Discord-ready proof receipt from your repo, then [post it in the proof thread](https://github.com/sverklo/sverklo/discussions/79).
30
+ Need something shareable? Run `sverklo prove --no-write --guided --markdown` to print a GitHub/Discord-ready proof receipt from your repo, then [post it in the proof thread](https://github.com/sverklo/sverklo/discussions/79).
27
31
 
28
32
  Need local launch planning for the Sverklo account? `sverklo marketing` runs a local-first Twitter/X agent-team workflow from operator-provided snapshots. It ranks opportunities, drafts seed-content queues, checks profile health, and records human decisions without posting, scraping, replying, liking, reposting, following, or changing the profile.
29
33
 
@@ -42,7 +46,7 @@ Need local launch planning for the Sverklo account? `sverklo marketing` runs a l
42
46
  [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19802051.svg)](https://doi.org/10.5281/zenodo.19802051)
43
47
  [![GitHub stars](https://img.shields.io/github/stars/sverklo/sverklo?style=social)](https://github.com/sverklo/sverklo/stargazers)
44
48
 
45
- > If `sverklo prove` surfaces useful repo context, please star the repo. It is the fastest way to help other agent-heavy teams find it.
49
+ > If `sverklo prove` surfaces useful repo context, please post a receipt, correction, grep-better case, or setup-friction report in [the proof thread](https://github.com/sverklo/sverklo/discussions/79). If it helped, starring the repo also helps other agent-heavy teams find it.
46
50
 
47
51
  ![Sverklo bench:primitives token comparison](./docs/hero-token-comparison.png)
48
52
 
@@ -177,7 +181,7 @@ If the answer to your question is "exact string X exists somewhere," grep wins.
177
181
  | Tool | What it does |
178
182
  |------|-------------|
179
183
  | `search` | Hybrid BM25 + vector + PageRank search. Find code without knowing the literal string. |
180
- | `refs` | All references to a symbol, with caller context. Proves dead code with certainty. |
184
+ | `refs` | All references to a symbol, with caller context. Flags likely dead-code candidates from the current reference graph. |
181
185
  | `impact` | Walk the symbol graph, return ranked transitive callers — the real blast radius. |
182
186
  | `review_diff` | Risk-scored review of `git diff`: touched-symbol importance x coverage x churn. |
183
187
 
@@ -94,7 +94,7 @@ if (command && command !== "--help" && command !== "-h") {
94
94
  const HELP_BLURBS = {
95
95
  init: "Set up sverklo in your project (.mcp.json + CLAUDE.md, auto-detects Claude Code/Cursor/Windsurf/Antigravity). With --global: one-time-per-machine setup — write SVERKLO_SNIPPET to ~/.claude/CLAUDE.md and ~/.codex/AGENTS.md, register the project, gitignore .sverklo/, import memories. Skips per-project boilerplate.",
96
96
  doctor: "Diagnose MCP setup issues. Run after `init` to verify the agent can reach sverklo.",
97
- prove: "Show a first-run repo-memory proof: central files, a real symbol with callers, and a paste-ready agent prompt. Flags: --markdown, --receipt, --format text|markdown.",
97
+ prove: "Show a first-run repo-memory proof: central files, a real symbol with callers, and a paste-ready agent prompt. Flags: --no-write, --guided, --markdown, --receipt, --format text|markdown.",
98
98
  audit: "Run codebase audit and emit a graded report. Flags: --format markdown|html|json|graph|arch|obsidian, --output PATH, --open, --badge, --publish.",
99
99
  "audit-diff": "Incremental architectural quality gate. Audits `git diff` for new cycles + fan-in spikes. Flags: --against REF, --fan-in-threshold N, --format human|json, --show-existing, --verbose. Exits 1 on regression.",
100
100
  review: "Risk-scored diff review (CI-friendly). Flags: --ref REF, --ci, --format markdown|json, --max-files N, --fail-on low|medium|high.",