Skip to content

Commit 19d2087

Browse files
shreyas-lyzrclaude
andcommitted
docs: add all 12 pattern images to README
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 99297ad commit 19d2087

13 files changed

+52
-4
lines changed

README.md

Lines changed: 52 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,68 @@ Every AI framework has its own structure. There's no universal, portable way to
2323

2424
## Patterns
2525

26-
Four architectural patterns emerge when you treat agents as git repos:
26+
These are the architectural patterns that emerge when you define agents as git-native file systems.
2727

2828
### Human-in-the-Loop for RL Agents
29-
When an agent updates memory or learns a new skill, it creates a branch + PR for human review before merging to main. Git's review workflow becomes your supervision layer.
29+
When an agent learns a new skill or writes to memory, it opens a branch + PR for human review before merging.
3030

31-
### Shared Context
32-
Root-level `context.md`, `skills/`, `tools/`, and `knowledge/` are automatically inherited by all sub-agents. One source of truth, no duplication.
31+
<img src="patterns/human-in-the-loop.png" alt="Human-in-the-Loop" width="600" />
32+
33+
### Live Agent Memory
34+
The `memory/` folder holds a `runtime/` subfolder where agents write live knowledge — `dailylog.md`, `key-decisions.md`, and `context.md` — persisting state across sessions.
35+
36+
<img src="patterns/live-agent-memory.png" alt="Live Agent Memory" width="600" />
37+
38+
### Agent Versioning
39+
Every change to your agent is a git commit. Roll back broken prompts, revert bad skills, and explore past versions — full undo history for your agent.
40+
41+
<img src="patterns/agent-versioning.png" alt="Agent Versioning" width="600" />
42+
43+
### Shared Context & Skills via Monorepo
44+
Root-level `context.md`, `skills/`, `tools/` are automatically shared across every agent in the monorepo. No duplication, one source of truth.
45+
46+
<img src="patterns/shared-context.png" alt="Shared Context" width="600" />
3347

3448
### Branch-based Deployment
3549
Use git branches (`dev``staging``main`) to promote agent changes through environments, just like shipping software.
3650

51+
<img src="patterns/branch-deployment.png" alt="Branch-based Deployment" width="600" />
52+
3753
### Knowledge Tree
3854
The `knowledge/` folder stores entity relationships as a hierarchical tree with embeddings, letting agents reason over structured data at runtime.
3955

56+
<img src="patterns/knowledge-tree.png" alt="Knowledge Tree" width="600" />
57+
58+
### Agent Forking & Remixing
59+
Fork any public agent repo, customize its `SOUL.md`, add your own skills, and PR improvements back upstream — open-source collaboration for AI agents.
60+
61+
<img src="patterns/agent-forking.png" alt="Agent Forking & Remixing" width="600" />
62+
63+
### CI/CD for Agents
64+
Run `gitagent validate` on every push via GitHub Actions. Test agent behavior in CI, block bad merges, and auto-deploy — treat agent quality like code quality.
65+
66+
<img src="patterns/ci-cd-agents.png" alt="CI/CD for Agents" width="600" />
67+
68+
### Agent Diff & Audit Trail
69+
`git diff` shows exactly what changed between agent versions. `git blame` traces every line to who wrote it and when — full traceability out of the box.
70+
71+
<img src="patterns/agent-diff-audit.png" alt="Agent Diff & Audit Trail" width="600" />
72+
73+
### Tagged Releases
74+
Tag stable agent versions like `v1.1.0`. Pin production to a tag, canary new versions on staging, and roll back instantly if something breaks.
75+
76+
<img src="patterns/tagged-releases.png" alt="Tagged Releases" width="600" />
77+
78+
### Secret Management via .gitignore
79+
Agent tools that need API keys read from a local `.env` file — kept out of version control via `.gitignore`. Agent config is shareable, secrets stay local.
80+
81+
<img src="patterns/secret-management.png" alt="Secret Management" width="600" />
82+
83+
### Agent Lifecycle with Hooks
84+
Define `bootstrap.md` and `teardown.md` in the `hooks/` folder to control what an agent does on startup and before it stops.
85+
86+
<img src="patterns/agent-automation-hooks.png" alt="Agent Lifecycle Hooks" width="600" />
87+
4088
## Quick Start
4189

4290
```bash
2.81 MB
Loading

patterns/agent-diff-audit.png

2.27 MB
Loading

patterns/agent-forking.png

2.32 MB
Loading

patterns/agent-versioning.png

2.82 MB
Loading

patterns/branch-deployment.png

1.32 MB
Loading

patterns/ci-cd-agents.png

2.11 MB
Loading

patterns/human-in-the-loop.png

2.17 MB
Loading

patterns/knowledge-tree.png

2.04 MB
Loading

patterns/live-agent-memory.png

2.51 MB
Loading

0 commit comments

Comments
 (0)