Skip to content

Latest commit

 

History

History
86 lines (80 loc) · 4 KB

File metadata and controls

86 lines (80 loc) · 4 KB

Project Structure Examples

Standard Mode

For projects using YAML frontmatter in rule files. Agent output files are symlinks to a single inlined file containing all rule content:

monorepo/
├── ai-rules/                     # Global rule files
│   ├── .generated-ai-rules/      # Processed files (generated)
│   │   ├── ai-rules-generated-general.md
│   │   └── ai-rules-generated-AGENTS.md  # Inlined file (all content)
│   ├── commands/                 # Custom commands
│   │   └── commit.md
│   ├── skills/                   # User-defined skills
│   │   └── debugging/
│   │       └── SKILL.md
│   ├── general.md                # Repository-wide rules
│   ├── ai-rules-config.yaml      # Configuration
│   └── mcp.json                  # MCP server configuration
│
├── frontend/                     # Frontend application
│   ├── ai-rules/                 # Frontend-specific rules
│   │   ├── .generated-ai-rules/
│   │   ├── react.md
│   │   └── styling.md
│   ├── CLAUDE.md                 # Symlink -> ai-rules/.generated-ai-rules/ai-rules-generated-AGENTS.md
│   ├── AGENTS.md                 # Symlink -> ai-rules/.generated-ai-rules/ai-rules-generated-AGENTS.md
│   └── src/
│
├── backend/                      # Backend services
│   ├── ai-rules/
│   │   ├── .generated-ai-rules/
│   │   ├── api.md
│   │   └── database.md
│   ├── CLAUDE.md                 # Symlink -> inlined file
│   ├── AGENTS.md                 # Symlink -> inlined file
│   └── api/
│
├── CLAUDE.md                     # Symlink -> ai-rules/.generated-ai-rules/ai-rules-generated-AGENTS.md
├── AGENTS.md                     # Symlink -> ai-rules/.generated-ai-rules/ai-rules-generated-AGENTS.md
├── .clinerules/                  # Root Cline rules (symlink)
├── .firebender/
│   ├── commands/                 # Firebender commands (generated symlinks)
├── .agents/
│   └── skills/                   # Shared AMP/Firebender skills (generated symlinks)
├── .mcp.json                     # Root MCP config (generated)
└── firebender.json               # Root Firebender supplemental config (generated when needed)

Symlink Mode

For simple projects with a single AGENTS.md file:

project/
├── ai-rules/
│   ├── AGENTS.md                 # Source file (your rules)
│   ├── commands/                 # Custom commands (optional)
│   │   └── commit.md
│   ├── skills/                   # User-defined skills (optional)
│   │   └── debugging/
│   │       └── SKILL.md
│   └── mcp.json                  # MCP config (optional)
│
├── CLAUDE.md                     # Symlink -> ai-rules/AGENTS.md
├── GEMINI.md                     # Symlink -> ai-rules/AGENTS.md
├── AGENTS.md                     # Symlink -> ai-rules/AGENTS.md
├── .firebender/
│   ├── commands/                 # Firebender commands (generated symlinks)
├── .agents/
│   └── skills/                   # Shared AMP/Firebender skills (generated symlinks)
├── firebender.json               # Supplemental Firebender config (if mcp.json or overlay exists)
├── .clinerules/
│   └── AGENTS.md                 # Symlink -> ../ai-rules/AGENTS.md
├── .cursor/
│   ├── commands/ai-rules/        # Commands (generated)
│   └── mcp.json                  # MCP config (if mcp.json exists)
├── .kilocode/rules/
│   └── AGENTS.md                 # Symlink -> ../../ai-rules/AGENTS.md
├── .roo/
│   ├── rules/
│   │   └── AGENTS.md             # Symlink -> ../../ai-rules/AGENTS.md
│   └── mcp.json                  # MCP config (if mcp.json exists)
└── .mcp.json                     # Claude MCP config (if mcp.json exists)