Skip to content

Commit 64f8a8b

Browse files
shreyas-lyzrclaude
andcommitted
docs: move directory structure to top as "The Standard" section
The file structure IS the standard — it should be the first thing readers see after the intro. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 19d2087 commit 64f8a8b

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,31 @@ Every AI framework has its own structure. There's no universal, portable way to
2121
- **Compliance-ready** — First-class support for FINRA, Federal Reserve, and SEC regulatory requirements
2222
- **Composable** — Agents can extend, depend on, and delegate to other agents
2323

24+
## The Standard
25+
26+
A gitagent is a git repo with a specific file structure. This **is** the standard — everything else (CLI, adapters, patterns) builds on top of it.
27+
28+
```
29+
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)
45+
```
46+
47+
Only two files are required: **`agent.yaml`** (the manifest) and **`SOUL.md`** (the identity). Everything else is optional and additive.
48+
2449
## Patterns
2550

2651
These are the architectural patterns that emerge when you define agents as git-native file systems.
@@ -104,27 +129,6 @@ gitagent info
104129
gitagent export --format system-prompt
105130
```
106131

107-
## Directory Structure
108-
109-
```
110-
my-agent/
111-
├── agent.yaml # [REQUIRED] Manifest — name, version, model, skills, tools, compliance
112-
├── SOUL.md # [REQUIRED] Identity, personality, communication style, values
113-
├── RULES.md # Hard constraints, must-always/must-never, safety boundaries
114-
├── AGENTS.md # Framework-agnostic fallback instructions
115-
├── skills/ # Reusable capability modules (SKILL.md + scripts)
116-
├── tools/ # MCP-compatible tool definitions (YAML schemas)
117-
├── knowledge/ # Reference documents the agent can consult
118-
├── memory/ # Persistent cross-session memory
119-
├── workflows/ # Multi-step procedures/playbooks
120-
├── hooks/ # Lifecycle event handlers (audit logging, compliance checks)
121-
├── examples/ # Calibration interactions (few-shot)
122-
├── agents/ # Sub-agent definitions (recursive structure)
123-
├── compliance/ # Regulatory compliance artifacts
124-
├── config/ # Environment-specific overrides
125-
└── .gitagent/ # Runtime state (gitignored)
126-
```
127-
128132
## agent.yaml
129133

130134
The only file with a strict schema. Minimal example:

0 commit comments

Comments
 (0)