Skip to content

Commit 67d9a79

Browse files
docs: improve How It Works with before/after example and flow diagram
1 parent 9d063a6 commit 67d9a79

File tree

1 file changed

+33
-14
lines changed

1 file changed

+33
-14
lines changed

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,28 +41,47 @@ snip init
4141

4242
## How It Works
4343

44+
**Before** — Claude Code sees this (689 tokens):
4445
```
45-
Claude Code → PreToolUse hook → snip intercepts command
46-
47-
Match declarative filter (O(1) lookup)
48-
49-
Inject optimized args (e.g. --stat, --pretty=format:...)
50-
51-
Execute command, capture stdout/stderr (goroutines)
52-
53-
Apply filter pipeline (keep/remove/reformat)
54-
55-
Return filtered output → track savings in SQLite
46+
$ go test ./...
47+
ok github.com/edouard-claude/snip/internal/cli 3.728s coverage: 14.4% of statements
48+
ok github.com/edouard-claude/snip/internal/config 2.359s coverage: 65.0% of statements
49+
ok github.com/edouard-claude/snip/internal/display 1.221s coverage: 72.6% of statements
50+
ok github.com/edouard-claude/snip/internal/engine 1.816s coverage: 47.9% of statements
51+
ok github.com/edouard-claude/snip/internal/filter 4.306s coverage: 72.3% of statements
52+
ok github.com/edouard-claude/snip/internal/initcmd 2.981s coverage: 59.1% of statements
53+
ok github.com/edouard-claude/snip/internal/tee 0.614s coverage: 70.6% of statements
54+
ok github.com/edouard-claude/snip/internal/tracking 5.355s coverage: 75.0% of statements
55+
ok github.com/edouard-claude/snip/internal/utils 5.515s coverage: 100.0% of statements
5656
```
5757

58-
No filter match? The command passes through unchanged.
58+
**After** — snip returns this (16 tokens):
59+
```
60+
10 passed, 0 failed
61+
```
62+
63+
That's **97.7% fewer tokens**. The LLM gets the same signal — all tests pass — without the noise.
5964

60-
### Measured Savings
65+
```
66+
┌─────────────┐ ┌─────────────────┐ ┌──────────────┐ ┌────────────┐
67+
│ Claude Code │────▶│ snip intercept │────▶│ run command │────▶│ filter │
68+
│ runs `git` │ │ match filter │ │ capture I/O │ │ pipeline │
69+
└─────────────┘ └─────────────────┘ └──────────────┘ └─────┬──────┘
70+
71+
┌─────────────────┐ ┌──────────────┐ │
72+
│ Claude Code │◀────│ track savings │◀─────────┘
73+
│ sees filtered │ │ in SQLite │
74+
└─────────────────┘ └──────────────┘
75+
```
76+
77+
No filter match? The command passes through unchanged — zero overhead.
78+
79+
### Savings by Command
6180

6281
| Command | Before | After | Savings |
6382
|---------|-------:|------:|--------:|
64-
| `go test ./...` | 689 tokens | 16 tokens | **97.7%** |
6583
| `cargo test` | 591 tokens | 5 tokens | **99.2%** |
84+
| `go test ./...` | 689 tokens | 16 tokens | **97.7%** |
6685
| `git log` | 371 tokens | 53 tokens | **85.7%** |
6786
| `git status` | 112 tokens | 16 tokens | **85.7%** |
6887
| `git diff` | 355 tokens | 66 tokens | **81.4%** |

0 commit comments

Comments
 (0)