Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ clap = { version = "4.4", features = ["derive"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
serde_yaml = "0.9"
toml = "0.8"
cliclack = "0.3.6"
regex = "1.10"
which = "8.0.0"
Expand Down
13 changes: 12 additions & 1 deletion docs/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| **AMP** | `AGENTS.md` -> inlined file | `AGENTS.md` -> `ai-rules/AGENTS.md` | - | |
| **Claude Code** | `CLAUDE.md` -> inlined file | `CLAUDE.md` -> `ai-rules/AGENTS.md` | `.mcp.json` | |
| **Cline** | `.clinerules/AGENTS.md` -> inlined file | `.clinerules/AGENTS.md` -> `../ai-rules/AGENTS.md` | - | |
| **Codex** | `AGENTS.md` -> inlined file | `AGENTS.md` -> `ai-rules/AGENTS.md` | - | |
| **Codex** | `AGENTS.md` -> inlined file | `AGENTS.md` -> `ai-rules/AGENTS.md` | `.codex/config.toml` | Optional `ai-rules/codex-config.toml` overlay supported |
| **Copilot** | `AGENTS.md` -> inlined file | `AGENTS.md` -> `ai-rules/AGENTS.md` | - | |
| **Cursor** | `.cursor/rules/*.mdc` | `AGENTS.md` -> `ai-rules/AGENTS.md` | `.cursor/mcp.json` | Symlink mode: only project root level |
| **Firebender** | `AGENTS.md` -> inlined file | `AGENTS.md` -> `ai-rules/AGENTS.md` | `firebender.json` | Commands live in `.firebender/`; skills reuse `.agents/skills`; overlay supported |
Expand All @@ -26,3 +26,14 @@ Firebender supports overlay configuration files. To customize your configuration
`firebender.json` is generated as supplemental config when `ai-rules/mcp.json` and/or `ai-rules/firebender-overlay.json` exists.

**MCP Integration:** If you have `ai-rules/mcp.json`, the MCP servers are merged into `firebender.json` first, then the overlay is applied. This allows you to override MCP configurations in the overlay if needed.

## Codex Overlay Support

Codex supports overlay configuration files. To customize your configuration:

1. Create `ai-rules/codex-config.toml` in the same parent directory as your generated `.codex/config.toml`
2. Any values defined in the overlay file will be merged into the generated Codex configuration, with overlay values taking precedence

`.codex/config.toml` is generated when `ai-rules/mcp.json` and/or `ai-rules/codex-config.toml` exists.

**MCP Integration:** If you have `ai-rules/mcp.json`, the MCP servers are converted into Codex `[mcp_servers]` TOML first, then the overlay is applied. This allows you to override MCP configurations in the overlay if needed.
1 change: 1 addition & 0 deletions docs/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ See the [Supported Agents](agents.md) table for which agents support MCP and the
| Agent | MCP File Location |
|-------|-------------------|
| Claude Code | `.mcp.json` |
| Codex | `.codex/config.toml` |
| Cursor | `.cursor/mcp.json` |
| Firebender | `firebender.json` (generated when MCP and/or overlay config exists) |
| Gemini | Embedded in `.gemini/settings.json` |
Expand Down
6 changes: 6 additions & 0 deletions docs/project-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ monorepo/
│ │ └── SKILL.md
│ ├── general.md # Repository-wide rules
│ ├── ai-rules-config.yaml # Configuration
│ ├── codex-config.toml # Codex config overlay (optional)
│ └── mcp.json # MCP server configuration
├── frontend/ # Frontend application
Expand Down Expand Up @@ -44,6 +45,8 @@ monorepo/
│ ├── commands/ # Firebender commands (generated symlinks)
├── .agents/
│ └── skills/ # Shared AMP/Firebender skills (generated symlinks)
├── .codex/
│ └── config.toml # Codex config (generated when mcp.json or codex-config.toml exists)
├── .mcp.json # Root MCP config (generated)
└── firebender.json # Root Firebender supplemental config (generated when needed)
```
Expand All @@ -61,6 +64,7 @@ project/
│ ├── skills/ # User-defined skills (optional)
│ │ └── debugging/
│ │ └── SKILL.md
│ ├── codex-config.toml # Codex config overlay (optional)
│ └── mcp.json # MCP config (optional)
├── CLAUDE.md # Symlink -> ai-rules/AGENTS.md
Expand All @@ -70,6 +74,8 @@ project/
│ ├── commands/ # Firebender commands (generated symlinks)
├── .agents/
│ └── skills/ # Shared AMP/Firebender skills (generated symlinks)
├── .codex/
│ └── config.toml # Codex config (if mcp.json or codex-config.toml exists)
├── firebender.json # Supplemental Firebender config (if mcp.json or overlay exists)
├── .clinerules/
│ └── AGENTS.md # Symlink -> ../ai-rules/AGENTS.md
Expand Down
Loading
Loading