-
Notifications
You must be signed in to change notification settings - Fork 156
[docs] Update documentation for features from 2026-05-01 #1095
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -20,7 +20,7 @@ When you run `apm compile` without specifying a target, APM automatically detect | |||
|
|
||||
| | Project Structure | Target | What Gets Generated | | ||||
| |-------------------|--------|---------------------| | ||||
| | `.github/` folder only | `copilot` | AGENTS.md (instructions only) | | ||||
| | `.github/` folder only | `copilot` | AGENTS.md + `.github/copilot-instructions.md` (global instructions) | | ||||
| | `.claude/` folder only | `claude` | CLAUDE.md (instructions only) | | ||||
| | `.codex/` folder exists | `codex` | AGENTS.md (instructions only) | | ||||
| | `.gemini/` folder exists | `gemini` | GEMINI.md (instructions only) | | ||||
|
|
@@ -53,7 +53,7 @@ target: [claude, copilot] # multiple targets -- only these are compiled | |||
|
|
||||
| | Target | Files Generated | Consumers | | ||||
| |--------|-----------------|-----------| | ||||
| | `copilot` | `AGENTS.md` | GitHub Copilot, Cursor, OpenCode | | ||||
| | `copilot` | `AGENTS.md` + `.github/copilot-instructions.md` | GitHub Copilot, Cursor, OpenCode | | ||||
| | `claude` | `CLAUDE.md` | Claude Code, Claude Desktop | | ||||
| | `gemini` | `GEMINI.md` | Gemini CLI | | ||||
| | `codex` | `AGENTS.md` | Codex CLI | | ||||
|
|
@@ -62,6 +62,8 @@ target: [claude, copilot] # multiple targets -- only these are compiled | |||
|
|
||||
| > **Aliases**: `vscode` and `agents` are accepted as aliases for `copilot`. | ||||
|
|
||||
| > **Note**: For the `copilot` target, instructions without an `applyTo` pattern (global instructions) are also synthesized into `.github/copilot-instructions.md`. Instructions with `applyTo` patterns continue to flow into per-pattern `.github/instructions/*.instructions.md` files. The generated `.github/copilot-instructions.md` carries a build-id marker so `apm compile` can cleanly remove it when switching to a non-Copilot target -- manually-authored files at the same path are preserved. | ||||
|
|
||||
| > **Note**: `AGENTS.md`, `CLAUDE.md`, and `GEMINI.md` contain **only instructions** (grouped by `applyTo` patterns). Prompts, agents, commands, hooks, and skills are integrated by `apm install`, not `apm compile`. See the [Integrations Guide](../../integrations/ide-tool-integration/) for details on how `apm install` populates `.github/prompts/`, `.github/agents/`, `.github/skills/`, `.claude/commands/`, `.cursor/rules/`, `.cursor/agents/`, `.opencode/agents/`, `.opencode/commands/`, `.codex/agents/`, `.gemini/commands/`, and `.agents/skills/`. | ||||
|
|
||||
| ### How It Works | ||||
|
|
@@ -73,11 +75,13 @@ target: [claude, copilot] # multiple targets -- only these are compiled | |||
|
|
||||
| ### Example Output | ||||
|
|
||||
| **After `apm compile`:** | ||||
| **After `apm compile` (copilot target):** | ||||
| ``` | ||||
| my-project/ | ||||
| βββ AGENTS.md # Instructions only (for Copilot, Cursor, etc.) | ||||
| βββ CLAUDE.md # Instructions only (for Claude) | ||||
| βββ AGENTS.md # Instructions (for Copilot, Cursor, etc.) | ||||
| βββ CLAUDE.md # Instructions (for Claude) | ||||
|
||||
| βββ CLAUDE.md # Instructions (for Claude) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The tables/readme-style text imply
.github/copilot-instructions.mdis always generated for thecopilottarget, but the compiler only writes it when there is at least one global instruction (noapplyTo); otherwise it will remove a previously-generated file. Consider annotating the table entry (and/or the note) with this condition so users don't expect the file to appear in projects that only use per-pattern instructions.