devguard 0.2.0 → 0.2.1
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 +40 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# devguard
|
|
2
2
|
|
|
3
|
-
MCP server that
|
|
3
|
+
MCP server that keeps a dev diary for you — what changed, what decisions were made, what broke, what's next. Picks up where you left off so you never lose context between sessions.
|
|
4
4
|
|
|
5
5
|
## Why
|
|
6
6
|
|
|
7
|
-
You vibe code for 3 hours, close your laptop, and come back the next day with no idea what you were doing.
|
|
7
|
+
You vibe code for 3 hours, close your laptop, and come back the next day with no idea what you were doing. Devguard fixes that. It reads your git state, tracks your branches, and writes diary entries automatically.
|
|
8
8
|
|
|
9
9
|
## Install
|
|
10
10
|
|
|
11
11
|
Add to Claude Code:
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
claude mcp add
|
|
14
|
+
claude mcp add devguard -- npx devguard
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
That's it. On first run,
|
|
18
|
-
- Adds `.
|
|
17
|
+
That's it. On first run, devguard automatically:
|
|
18
|
+
- Adds `.devguard/` to your `.gitignore`
|
|
19
19
|
- Adds an auto-logging instruction to your `CLAUDE.md` (or `.cursorrules` if that exists)
|
|
20
20
|
|
|
21
21
|
From then on, your AI writes diary entries on its own — after finishing a feature, after a big commit, before context gets lost. You never think about it. The diary just fills itself.
|
|
@@ -25,9 +25,40 @@ From then on, your AI writes diary entries on its own — after finishing a feat
|
|
|
25
25
|
| Tool | What it does |
|
|
26
26
|
|------|-------------|
|
|
27
27
|
| `get_context` | Reads git branch, status, recent commits, and diffs |
|
|
28
|
-
| `write_entry` | Saves a diary entry
|
|
28
|
+
| `write_entry` | Saves a diary entry with what changed, decisions, issues, and next steps |
|
|
29
29
|
| `read_entries` | Reads recent entries to catch you up |
|
|
30
|
-
| `catch_me_up` | Morning briefing — diary entries + git state in one shot |
|
|
30
|
+
| `catch_me_up` | Morning briefing — diary entries + git state + branch map in one shot |
|
|
31
|
+
| `branch_map` | Opens a visual branch map in your browser |
|
|
31
32
|
| `setup` | Re-run setup manually if needed |
|
|
32
33
|
|
|
33
|
-
|
|
34
|
+
## Branch Map
|
|
35
|
+
|
|
36
|
+
Run `branch_map` to open an interactive HTML visualization of your repo in the browser. It shows:
|
|
37
|
+
|
|
38
|
+
- **All branches** with status (ahead/behind main), files changed, and latest commit
|
|
39
|
+
- **Collapsible diary summaries** per branch — what changed, decisions made, issues hit, next steps
|
|
40
|
+
- **Commit navigator** — click any branch to explore its commits on a visual timeline
|
|
41
|
+
- **Per-commit detail** — files changed, insertions/deletions, and diary entries linked to each commit
|
|
42
|
+
- **Auto-generated summaries** for commits without diary entries — categorized by type (Feature, Fix, Refactor, etc.) with affected areas and change scale
|
|
43
|
+
|
|
44
|
+
Designed for people who don't want to think about git.
|
|
45
|
+
|
|
46
|
+
## Branch-Aware Diary
|
|
47
|
+
|
|
48
|
+
Entries are automatically routed by branch:
|
|
49
|
+
- **main/master** → `.devguard/entries/` (daily files)
|
|
50
|
+
- **feature branches** → `.devguard/branches/<branch-name>.md` (one file per branch)
|
|
51
|
+
|
|
52
|
+
This means `catch_me_up` shows you the current branch's full story first, then the main stem, then other active branches — so you always know what's happening everywhere.
|
|
53
|
+
|
|
54
|
+
## How It Works
|
|
55
|
+
|
|
56
|
+
Entries are markdown files stored locally in your project under `.devguard/`. Each entry captures:
|
|
57
|
+
- **Summary** — one-line description of what happened
|
|
58
|
+
- **What Changed** — files modified, features added, bugs fixed
|
|
59
|
+
- **Decisions** — key choices made and why
|
|
60
|
+
- **Issues** — what broke, what's stuck
|
|
61
|
+
- **Next Steps** — what to do next session
|
|
62
|
+
- **Commit hash** — links the entry to a specific commit for traceability
|
|
63
|
+
|
|
64
|
+
Multiple sessions and agents all append to the same file. The diary builds up over time, making summaries richer and the branch map more useful with every session.
|