Skip to content

Commit f512c10

Browse files
shreyas-lyzrclaude
andcommitted
docs: restructure directory tree with grouped categories and examples
Shows branching into subdirectories (skills/, agents/, memory/runtime/) and organizes by purpose: Core Identity, Behavior, Capabilities, Knowledge & Memory, Lifecycle & Ops, Composition, Runtime. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 74ff6c6 commit f512c10

1 file changed

Lines changed: 37 additions & 16 deletions

File tree

README.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,45 @@ Your repository becomes your agent. Drop these files into any git repo and it be
2727

2828
```
2929
my-agent/
30-
├── agent.yaml # [REQUIRED] Manifest — name, version, model, skills, tools, compliance
31-
├── SOUL.md # [REQUIRED] Identity, personality, communication style, values
32-
├── RULES.md # Hard constraints, must-always/must-never, safety boundaries
33-
├── AGENTS.md # Framework-agnostic fallback instructions
34-
├── skills/ # Reusable capability modules (SKILL.md + scripts)
35-
├── tools/ # MCP-compatible tool definitions (YAML schemas)
36-
├── knowledge/ # Reference documents the agent can consult
37-
├── memory/ # Persistent cross-session memory
38-
├── workflows/ # Multi-step procedures/playbooks
39-
├── hooks/ # Lifecycle event handlers (audit logging, compliance checks)
40-
├── examples/ # Calibration interactions (few-shot)
41-
├── agents/ # Sub-agent definitions (recursive structure)
42-
├── compliance/ # Regulatory compliance artifacts
43-
├── config/ # Environment-specific overrides
44-
└── .gitagent/ # Runtime state (gitignored)
30+
31+
│ # ── Core Identity (required) ──────────────────────────
32+
├── agent.yaml # Manifest — name, version, model, skills, tools, compliance
33+
├── SOUL.md # Identity, personality, communication style, values
34+
35+
│ # ── Behavior & Rules ──────────────────────────────────
36+
├── RULES.md # Hard constraints, must-always/must-never, safety boundaries
37+
├── AGENTS.md # Framework-agnostic fallback instructions
38+
39+
│ # ── Capabilities ──────────────────────────────────────
40+
├── skills/ # Reusable capability modules (SKILL.md + scripts)
41+
│ └── code-review/
42+
│ ├── SKILL.md
43+
│ └── review.sh
44+
├── tools/ # MCP-compatible tool definitions (YAML schemas)
45+
├── workflows/ # Multi-step procedures/playbooks
46+
47+
│ # ── Knowledge & Memory ────────────────────────────────
48+
├── knowledge/ # Reference documents the agent can consult
49+
├── memory/ # Persistent cross-session memory
50+
│ └── runtime/ # Live agent state (dailylog.md, context.md)
51+
52+
│ # ── Lifecycle & Ops ───────────────────────────────────
53+
├── hooks/ # Lifecycle event handlers (bootstrap.md, teardown.md)
54+
├── config/ # Environment-specific overrides
55+
├── compliance/ # Regulatory compliance artifacts
56+
57+
│ # ── Composition ───────────────────────────────────────
58+
├── agents/ # Sub-agent definitions (recursive structure)
59+
│ └── fact-checker/
60+
│ ├── agent.yaml
61+
│ └── SOUL.md
62+
├── examples/ # Calibration interactions (few-shot)
63+
64+
│ # ── Runtime ───────────────────────────────────────────
65+
└── .gitagent/ # Runtime state (gitignored)
4566
```
4667

47-
Only two files are required: **`agent.yaml`** (the manifest) and **`SOUL.md`** (the identity). Everything else is optional and additive.
68+
Only two files are required: **`agent.yaml`** (the manifest) and **`SOUL.md`** (the identity). Everything else is optional — add what you need, ignore the rest.
4869

4970
## Patterns
5071

0 commit comments

Comments
 (0)