Skip to content

Migrate GitHub Copilot agent config from .github/copilot-instructions.md to AGENTS.md #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmajano merged 2 commits into from
Apr 27, 2026
Merged

Migrate GitHub Copilot agent config from .github/copilot-instructions.md to AGENTS.md #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
626ad7c
Initial plan
Copilot Apr 27, 2026
a71c338
Migrate GitHub Copilot agent from .github/copilot-instructions.md to …
Copilot Apr 27, 2026
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
11 changes: 5 additions & 6 deletions AI_INTEGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ graph LR

Root --> Agents["Agent Configs"]
Agents --> Claude["CLAUDE.md"]
Agents --> Copilot[".github/copilot-instructions.md"]
Agents --> Copilot["AGENTS.md (shared)"]
Agents --> Cursor[".cursorrules"]
Agents --> Other["+ 3 more agents"]

Expand All @@ -203,9 +203,8 @@ graph LR
Additionally, agent configuration files are created for you (paths defined in `AgentRegistry.cfc`):

* `CLAUDE.md` - Claude Desktop/Code assistant (points to `AGENTS.md` via `@AGENTS.md`)
* `.github/copilot-instructions.md` - GitHub Copilot
* `AGENTS.md` - Codex, OpenCode & GitHub Copilot (shared file)
* `.cursorrules` - Cursor IDE
* `AGENTS.md` - Codex, OpenCode & Claude (shared file)
* `GEMINI.md` - Gemini CLI

### Keeping Resources Updated
Expand Down Expand Up @@ -244,7 +243,7 @@ After installation, configure your AI agents:

**GitHub Copilot (VS Code):**

1. Agent configuration is automatically in `.github/copilot-instructions.md`
1. Agent configuration is automatically in `AGENTS.md`
2. Reload VS Code window
3. Copilot will use the instructions automatically

Expand Down Expand Up @@ -890,7 +889,7 @@ ColdBox AI Integration supports **6 major AI agents** with automatic configurati
| Agent | Config File | Description |
| ------------------ | --------------------------------- | ------------------------------ |
| **Claude** | `CLAUDE.md` → `AGENTS.md` | Claude Desktop and Claude Code |
| **GitHub Copilot** | `.github/copilot-instructions.md` | VS Code Copilot integration |
| **GitHub Copilot** | `AGENTS.md` (shared) | VS Code Copilot integration |
| **Cursor** | `.cursorrules` | Cursor IDE rules |
| **Codex** | `AGENTS.md` (shared) | Codex AI assistant |
| **Gemini** | `GEMINI.md` | Gemini CLI integration |
Expand Down Expand Up @@ -952,7 +951,7 @@ graph TB

subgraph "Agent Configurations"
Guidelines --> ClaudeConfig["CLAUDE.md"]
Guidelines --> CopilotConfig[".github/copilot-instructions.md"]
Guidelines --> CopilotConfig["AGENTS.md (shared)"]
Guidelines --> CursorConfig[".cursorrules"]
Guidelines --> CodexConfig["AGENTS.md"]
Guidelines --> GeminiConfig["GEMINI.md"]
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ coldbox ai agents remove cursor # Remove an agent
coldbox ai agents refresh # Regenerate all configurations
```

**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot (.github/copilot-instructions.md), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot (AGENTS.md, shared), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This supported-agents list marks Copilot as using AGENTS.md (shared) but does not indicate that Codex and OpenCode also share AGENTS.md. Update the wording for accuracy/consistency (or phrase it as a single shared AGENTS.md used by multiple agents).

Suggested change
**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot (AGENTS.md, shared), Cursor (.cursorrules), Codex (AGENTS.md), Gemini (GEMINI.md), OpenCode (AGENTS.md)
**Supported Agents**: Claude (CLAUDE.md → AGENTS.md), GitHub Copilot/Codex/OpenCode (shared `AGENTS.md`), Cursor (.cursorrules), Gemini (GEMINI.md)

Copilot uses AI. Check for mistakes.

#### Guidelines

Expand Down
8 changes: 7 additions & 1 deletion changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- **GitHub Copilot migrated to `AGENTS.md`**
- GitHub Copilot agent configuration now uses `AGENTS.md` (shared with Codex and OpenCode) instead of `.github/copilot-instructions.md`
- Follows the [Agents.md standard](https://github.blog/changelog/2025-08-28-copilot-coding-agent-now-supports-agents-md-custom-instructions/) now supported by GitHub Copilot
- Provides a single source of truth for Copilot, Codex, and OpenCode agents
- Existing `.github/copilot-instructions.md` files are not removed automatically; run `coldbox ai refresh` to write the updated location
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bullet is a bit misleading: coldbox ai refresh will create/write the new AGENTS.md location, but it will not remove existing .github/copilot-instructions.md files. Consider rewording to explicitly state that old files must be removed manually if desired.

Suggested change
- Existing `.github/copilot-instructions.md` files are not removed automatically; run `coldbox ai refresh` to write the updated location
- Running `coldbox ai refresh` writes the new `AGENTS.md` location, but any existing `.github/copilot-instructions.md` files are not removed automatically and must be deleted manually if desired

Copilot uses AI. Check for mistakes.

- **AI Directory Structure Standardized**
- Renamed `/.ai/` directory to `/.agents/` to follow BoxLang skill repository conventions
- All generated agent configurations, guidelines, and skills now use `/.agents/` instead of `/.ai/`
Expand Down Expand Up @@ -140,7 +146,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

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

- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`.github/copilot-instructions.md`), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`AGENTS.md`, shared), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Supported Agents" list marks Copilot as using AGENTS.md (shared) but leaves Codex/OpenCode as just AGENTS.md. Since all three now share the same file, this line should mark Codex and OpenCode as shared as well (or rephrase to avoid inconsistency).

Suggested change
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`AGENTS.md`, shared), Cursor (`.cursorrules`), Codex (`AGENTS.md`), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`)
- **Supported Agents**: Claude (`CLAUDE.md`), GitHub Copilot (`AGENTS.md`, shared), Cursor (`.cursorrules`), Codex (`AGENTS.md`, shared), Gemini (`GEMINI.md`), OpenCode (`AGENTS.md`, shared)

Copilot uses AI. Check for mistakes.
- Layout-specific templates (modern, flat)
- Project context detection (Vite, Docker, ORM, Migrations)
- Agents commands: `list`, `add`, `remove`, `active`, `open`
Expand Down
2 changes: 1 addition & 1 deletion commands/coldbox/ai/agents/help.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ component excludeFromHelp=true extends="coldbox-cli.models.BaseCommand" {
.line()
.yellowLine( "Note: Each agent creates its own configuration file:" )
.line( " Claude: CLAUDE.md" )
.line( " Copilot: .github/copilot-instructions.md" )
.line( " Copilot: AGENTS.md (shared)" )
.line( " Cursor: .cursorrules" )
Comment on lines 47 to 50
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The help text says "Each agent creates its own configuration file", but Copilot (and also Codex/OpenCode) now share AGENTS.md. Update this wording to avoid implying one-file-per-agent (e.g., "Agent configuration files:" or explicitly note which agents share AGENTS.md).

Copilot uses AI. Check for mistakes.
.line()
}
Expand Down
6 changes: 3 additions & 3 deletions models/AgentRegistry.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Registry for AI agent configurations
* Manages agent-specific files (CLAUDE.md, .github/copilot-instructions.md, etc.)
* Manages agent-specific files (CLAUDE.md, AGENTS.md, .cursorrules, etc.)
*/
component singleton {

Expand All @@ -22,7 +22,7 @@ component singleton {
]
AGENT_FILES = {
"claude" : "CLAUDE.md",
"copilot" : ".github/copilot-instructions.md",
"copilot" : "AGENTS.md",
"cursor" : ".cursorrules",
"codex" : "AGENTS.md",
"gemini" : "GEMINI.md",
Expand Down Expand Up @@ -262,7 +262,7 @@ component singleton {
case "claude":
return "#arguments.directory#/CLAUDE.md"
case "copilot":
return "#arguments.directory#/.github/copilot-instructions.md"
return "#arguments.directory#/AGENTS.md"
case "cursor":
return "#arguments.directory#/.cursorrules"
case "codex":
Expand Down