Skip to content

Commit df22f48

Browse files
committed
feat: v0.4.0 -- saar stats, saar init, saar scan (3 new commands)
saar stats ./repo Quality score 0-100 for your AGENTS.md. Shareable. Size (20pts): optimal 50-100 lines Freshness (20pts): based on saar diff snapshot age Coverage (40pts): 6 sections checked -- verify, never-do, auth, exceptions, tribal, stack Precision (20pts): penalises generic filler lines + emojis Grade: A+/A/B/C/D/F Tips: specific actionable improvements saar init ./new-project Bootstrap AGENTS.md before you have any code 6 stack presets: FastAPI, Next.js, Django, Express, Flask, React 5 quick questions -- project purpose, stack, verify command, never-do, team size Team section auto-added for team > solo Tribal knowledge placeholder always included Student play: run this before git commit on any new project saar scan https://github.com/tiangolo/fastapi Shallow clone + extract + show detection summary + quality score Works on any public GitHub URL Great for demo + exploring unknown codebases --index flag to also index into OCI New modules: saar/scorer.py, saar/init_wizard.py Tests: tests/test_new_commands.py (40 tests, 40/40 passing) Total: 426 tests
1 parent 92e8f16 commit df22f48

13 files changed

Lines changed: 1290 additions & 3 deletions

docs/saar-add.tape

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# saar-add.tape -- Tribal knowledge correction GIF
2+
# Usage: vhs docs/saar-add.tape
3+
4+
Output docs/saar-add.gif
5+
Set FontSize 13
6+
Set Width 880
7+
Set Height 300
8+
Set Theme "Catppuccin Mocha"
9+
Set Padding 20
10+
Set TypingSpeed 45ms
11+
Set Shell "zsh"
12+
Set Framerate 24
13+
Env PATH "/Users/devanshu/.local/bin:/opt/homebrew/bin:/usr/bin:/bin"
14+
15+
Hide
16+
Type "cd /tmp/studymate-demo && clear"
17+
Enter
18+
Show
19+
20+
Sleep 500ms
21+
Type `saar add "Never use npm. This project uses bun only"`
22+
Enter
23+
Sleep 1500ms
24+
Type `saar add --off-limits "billing/ frozen until Q3"`
25+
Enter
26+
Sleep 1500ms
27+
Type `saar add --domain "Workspace means tenant not directory"`
28+
Enter
29+
Sleep 1500ms
30+
Sleep 2s

docs/saar-demo.gif

68.8 KB
Loading

docs/saar-demo.tape

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# saar-demo.tape -- Core demo GIF
2+
# Usage: vhs docs/saar-demo.tape
3+
4+
Output docs/saar-demo.gif
5+
Set FontSize 13
6+
Set Width 880
7+
Set Height 460
8+
Set Theme "Catppuccin Mocha"
9+
Set Padding 20
10+
Set TypingSpeed 45ms
11+
Set Shell "zsh"
12+
Set Framerate 24
13+
Env PATH "/Users/devanshu/.local/bin:/opt/homebrew/bin:/usr/bin:/bin"
14+
15+
Hide
16+
Type "cd /tmp/studymate-demo && clear"
17+
Enter
18+
Show
19+
20+
Sleep 500ms
21+
Type "ls"
22+
Enter
23+
Sleep 1200ms
24+
25+
Ctrl+L
26+
Sleep 300ms
27+
28+
Type "saar extract . --no-interview"
29+
Enter
30+
Sleep 12s
31+
32+
Sleep 4s

docs/saar-diff.gif

44.2 KB
Loading

docs/saar-diff.tape

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# saar-diff.tape -- Staleness detection GIF
2+
# Usage: vhs docs/saar-diff.tape
3+
4+
Output docs/saar-diff.gif
5+
Set FontSize 13
6+
Set Width 880
7+
Set Height 360
8+
Set Theme "Catppuccin Mocha"
9+
Set Padding 20
10+
Set TypingSpeed 45ms
11+
Set Shell "zsh"
12+
Set Framerate 24
13+
Env PATH "/Users/devanshu/.local/bin:/opt/homebrew/bin:/usr/bin:/bin"
14+
15+
Hide
16+
Type "cd /tmp/studymate-demo && clear"
17+
Enter
18+
Show
19+
20+
Sleep 500ms
21+
Type "# 2 weeks later. did anything change?"
22+
Enter
23+
Sleep 1000ms
24+
Type "saar diff ."
25+
Enter
26+
Sleep 10s
27+
Sleep 3s

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "saar"
7-
version = "0.3.7"
7+
version = "0.4.0"
88
description = "Extract the essence of your codebase. Auto-generate AGENTS.md, CLAUDE.md, .cursorrules and more."
99
readme = "README.md"
1010
license = "MIT"

saar/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""Saar -- extract the essence of your codebase."""
22

3-
__version__ = "0.3.7"
3+
__version__ = "0.4.0"

0 commit comments

Comments
 (0)