Skip to content

Commit 380a137

Browse files
committed
updated path to instruction files
1 parent 5413fb8 commit 380a137

File tree

6 files changed

+22
-35
lines changed

6 files changed

+22
-35
lines changed

AI_INTEGRATION.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -201,14 +201,13 @@ graph LR
201201

202202

203203

204-
Additionally, agent configuration files are created for you:
204+
Additionally, agent configuration files are created for you (paths defined in `AgentRegistry.cfc`):
205205

206206
* `CLAUDE.md` - Claude Desktop/Code assistant
207207
* `.github/copilot-instructions.md` - GitHub Copilot
208208
* `.cursorrules` - Cursor IDE
209-
* `.codex/instructions.md` - Codex
210-
* `.gemini/instructions.md` - Gemini CLI
211-
* `.opencode/instructions.md` - OpenCode
209+
* `AGENTS.md` - Codex & OpenCode (shared file)
210+
* `GEMINI.md` - Gemini CLI
212211

213212
### Keeping Resources Updated
214213

@@ -907,14 +906,16 @@ ColdBox AI Integration supports **6 major AI agents** with automatic configurati
907906

908907
### Supported Agents
909908

909+
> **Note**: Agent configuration paths are centrally managed in `models/AgentRegistry.cfc`
910+
910911
| Agent | Config File | Description |
911912
| ------------------ | --------------------------------- | ------------------------------ |
912913
| **Claude** | `CLAUDE.md` | Claude Desktop and Claude Code |
913914
| **GitHub Copilot** | `.github/copilot-instructions.md` | VS Code Copilot integration |
914915
| **Cursor** | `.cursorrules` | Cursor IDE rules |
915-
| **Codex** | `.codex/instructions.md` | Codex AI assistant |
916-
| **Gemini** | `.gemini/instructions.md` | Gemini CLI integration |
917-
| **OpenCode** | `.opencode/instructions.md` | OpenCode assistant |
916+
| **Codex** | `AGENTS.md` (shared) | Codex AI assistant |
917+
| **Gemini** | `GEMINI.md` | Gemini CLI integration |
918+
| **OpenCode** | `AGENTS.md` (shared) | OpenCode assistant |
918919

919920
### Agent Configuration
920921

@@ -975,9 +976,9 @@ graph TB
975976
Guidelines --> ClaudeConfig["CLAUDE.md"]
976977
Guidelines --> CopilotConfig[".github/copilot-instructions.md"]
977978
Guidelines --> CursorConfig[".cursorrules"]
978-
Guidelines --> CodexConfig[".codex/instructions.md"]
979-
Guidelines --> GeminiConfig[".gemini/instructions.md"]
980-
Guidelines --> OpenCodeConfig[".opencode/instructions.md"]
979+
Guidelines --> CodexConfig["AGENTS.md"]
980+
Guidelines --> GeminiConfig["GEMINI.md"]
981+
Guidelines --> OpenCodeConfig["AGENTS.md"]
981982
982983
Skills --> ClaudeConfig
983984
Skills --> CopilotConfig
@@ -1772,14 +1773,6 @@ coldbox ai stats
17721773
.ai/skills/custom/
17731774
.ai/manifest.json
17741775
1775-
# DON'T commit these (regenerated):
1776-
CLAUDE.md
1777-
.github/copilot-instructions.md
1778-
.cursorrules
1779-
.codex/instructions.md
1780-
.gemini/instructions.md
1781-
.opencode/instructions.md
1782-
.mcp.json
17831776
```
17841777

17851778
**Team Workflow:**

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ coldbox ai agents remove cursor # Remove an agent
546546
coldbox ai agents refresh # Regenerate all configurations
547547
```
548548

549-
**Supported Agents**: Claude (CLAUDE.md), GitHub Copilot (.github/copilot-instructions.md), Cursor (.cursorrules), Codex (.codex/instructions.md), Gemini (.gemini/instructions.md), OpenCode (.opencode/instructions.md)
549+
**Supported Agents**: Claude (CLAUDE.md), GitHub Copilot (.github/copilot-instructions.md), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
550550

551551
#### Guidelines
552552

changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6060

6161
##### Multi-Agent Support (6 Agents)
6262

63-
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`.github/copilot-instructions.md`), Cursor (`.cursorrules`), Codex (`.codex/instructions.md`), Gemini (`.gemini/instructions.md`), OpenCode (`.opencode/instructions.md`)
63+
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`.github/copilot-instructions.md`), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
6464
- Layout-specific templates (modern, flat)
6565
- Project context detection (Vite, Docker, ORM, Migrations)
6666
- Agents commands: `list`, `add`, `remove`, `active`, `open`

commands/coldbox/ai/install.cfc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ component extends="coldbox-cli.models.BaseAICommand" {
6666

6767
// Success!
6868
printSuccess( "🍭 AI integration installed successfully!" );
69-
print.line();
7069

7170
// Show what was installed
7271
printInfo( "Guidelines installed: #result.guidelines.len()#" );

commands/coldbox/ai/tree.cfc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
*/
99
component extends="coldbox-cli.models.BaseAICommand" {
1010

11+
property name="agentRegistry" inject="AgentRegistry@coldbox-cli";
12+
1113
/**
1214
* Run the command
1315
*
@@ -276,14 +278,7 @@ component extends="coldbox-cli.models.BaseAICommand" {
276278
var result = {};
277279

278280
if ( agents.len() ) {
279-
var agentFiles = {
280-
"claude" : "CLAUDE.md",
281-
"copilot" : ".github/copilot-instructions.md",
282-
"cursor" : ".cursorrules",
283-
"codex" : ".codex/instructions.md",
284-
"gemini" : ".gemini/instructions.md",
285-
"opencode" : ".opencode/instructions.md"
286-
};
281+
var agentFiles = variables.agentRegistry.AGENT_FILES
287282

288283
agents.each( ( agent ) => {
289284
if ( verbose && structKeyExists( agentFiles, agent ) ) {

models/AgentRegistry.cfc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ component singleton {
2424
"claude" : "CLAUDE.md",
2525
"copilot" : ".github/copilot-instructions.md",
2626
"cursor" : ".cursorrules",
27-
"codex" : ".codex/instructions.md",
28-
"gemini" : ".gemini/instructions.md",
29-
"opencode" : ".opencode/instructions.md"
27+
"codex" : "AGENTS.md",
28+
"gemini" : "GEMINI.md",
29+
"opencode" : "AGENTS.md"
3030
}
3131
AGENT_OPTIONS = [
3232
{
@@ -183,11 +183,11 @@ component singleton {
183183
case "cursor":
184184
return "#arguments.directory#/.cursorrules"
185185
case "codex":
186-
return "#arguments.directory#/.codex/instructions.md"
186+
return "#arguments.directory#/AGENTS.md"
187187
case "gemini":
188-
return "#arguments.directory#/.gemini/instructions.md"
188+
return "#arguments.directory#/GEMINI.md"
189189
case "opencode":
190-
return "#arguments.directory#/.opencode/instructions.md"
190+
return "#arguments.directory#/AGENTS.md"
191191
default:
192192
return "#arguments.directory#/AI_INSTRUCTIONS.md"
193193
}

0 commit comments

Comments
 (0)