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
6 changes: 3 additions & 3 deletions docs/src/content/docs/integrations/copilot-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Until the flag is enabled, the `copilot-app` target stays inert: it is hidden fr

Your APM workflows appear in the Copilot App's correct project tab automatically -- no manual workspace tagging. Ship a `.prompt.md` with workflow frontmatter (any of `interval`, `schedule_hour`, `schedule_day` at the top level), run `apm install --target copilot-app` inside the repo, and the App lists the workflow under that repo's Workflows tab on next launch. Add `--global` to install from a user-scope `~/.apm/apm.yml`; omit it for project-scoped, team-shared scheduled prompts.

Prompts that do not carry workflow frontmatter are plain slash commands: they deploy to file-based targets (`copilot`, `vscode`, `claude`, ...) and APM hard-errors with an actionable diagnostic if you point them at `copilot-app` directly. A single `.prompt.md` belongs to exactly ONE surface -- whichever its frontmatter shape selects.
Prompts that do not carry workflow frontmatter are plain slash commands: they deploy to file-based targets (`copilot`, `vscode`, `claude`, ...) and APM skips them with an actionable `[!]` warning if you point them at `copilot-app` directly. A single `.prompt.md` belongs to exactly ONE surface -- whichever its frontmatter shape selects.

:::note[How it works]
The desktop App stores workflows in a SQLite database at `~/.copilot/data.db`, not as files on disk -- so `copilot-app` is a separate target from the file-based `copilot` integration. `apm install --target copilot-app` inserts one row per workflow prompt; the App picks them up on next launch or refresh. If a freshly installed workflow does not appear, restart the Copilot App once.
Expand Down Expand Up @@ -108,7 +108,7 @@ Subsequent installs into the same repo are silent. The hint is upstream-bug guid
Workflows installed with `apm install --global` run with `CWD=~/.copilot`, not a repository -- which is almost never what the user wants. APM still deploys global workflows (so global skills and commands keep working), but emits a one-time warn-and-proceed diagnostic whenever a `--global` install carries any workflow-shape prompt:

```
[!] Copilot App workflows installed with --global run with CWD=~/.copilot, not a project. Attach the workflow to a project from the App's Workflows tab to fix this, or re-run `apm install` from a repo without --global.
[!] Copilot App workflows installed with --global run with CWD=~/.copilot, not a project. Attach the workflow to a project from the App's Workflows tab to fix this, or re-run `apm install` from a repo without --global. See https://aka.ms/apm/copilot-app-global for details.
```

The remediation is per-row: attach the workflow to any project from the Workflows tab in the App. Or re-run `apm install` from inside a repo without `--global`.
Expand Down Expand Up @@ -140,7 +140,7 @@ The Copilot App owns the DB and keeps it in WAL mode while running. APM coexists

## Lockfile entries

Deployed rows are tracked in the project / user lockfile under the `copilot-app-db://workflows/<namespaced-id>` URI scheme. Standard sync semantics apply: lockfile drift triggers redeploy; removal from lockfile triggers row delete on next install.
Deployed rows are tracked in the project / user lockfile under the `copilot-app-db://workflows/<namespaced-id>` URI scheme. Standard sync semantics apply: lockfile drift triggers redeploy; `apm uninstall` deletes the tracked rows (see [Lifecycle](#lifecycle)).

## Out of scope (today)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/integrations/copilot-cowork.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Until the flag is enabled, the `copilot-cowork` target stays inert: it is hidden
When the `copilot-cowork` flag is enabled, APM can deploy package skills to Microsoft 365 Copilot Cowork at user scope. APM writes each deployed skill to Cowork's fixed OneDrive convention:

```text
<onedrive-root>/Documents/Cowork/skills/<package-name>/SKILL.md
<onedrive-root>/Documents/Cowork/skills/<skill-name>/SKILL.md
```

## Enable the flag
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/integrations/github-rulesets.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ The `GITHUB_APM_PAT` secret is only required if your `apm.yml` references privat

1. Go to your repository **Settings** > **Rules**.
2. Select an existing branch ruleset or create a new one targeting your default branch.
3. Enable **Require status checks to pass** and add `APM Audit` (the workflow job name) as a required check.
3. Enable **Require status checks to pass** and add `audit` (the workflow job name) as a required check.

Alternatively, in classic branch protection rules under **Settings** > **Branches** > **Branch protection rules**, enable **Require status checks to pass before merging** and search for `APM Audit`.
Alternatively, in classic branch protection rules under **Settings** > **Branches** > **Branch protection rules**, enable **Require status checks to pass before merging** and search for `audit`.

Once configured, any PR that introduces content issues detected by `apm audit` will fail the check.

Expand Down
16 changes: 10 additions & 6 deletions docs/src/content/docs/integrations/ide-tool-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ The full slot-by-slot capability table lives in [Targets matrix](../../reference
| Target | Marker / signal | Notes |
|----------------------|--------------------------------------|----------------------------------------|
| VS Code + Copilot | `.github/copilot-instructions.md` | Native instructions, prompts, agents |
| Claude Code | `.claude/` | Skills, agents, commands, MCP |
| Claude Code | `.claude/` | Rules, skills, agents, commands, hooks, MCP |
| Grok Build | `.grok/` | Rules, agents, commands, skills |
| Cursor | `.cursor/` | Rules, commands, MCP |
| Codex CLI | `.codex/` | Skills, MCP |
| Cursor | `.cursor/` | Rules, agents, commands, skills, hooks, MCP |
| Codex CLI | `.codex/` | Skills, agents, hooks, MCP |
| Gemini CLI | `.gemini/` or `GEMINI.md` | Single-file or distributed |
| Antigravity CLI | explicit `--target antigravity` | Rules, skills, hooks, MCP |
| Hermes | explicit `--target hermes` | Skills, compiled instructions, MCP |
| OpenCode | `.opencode/` | Agents, commands, skills, compiled instructions, MCP |
| Windsurf | `.windsurf/` | Rules + Skills + Workflows + MCP |
| Kiro | `.kiro/` | Steering + Agents + Skills + Hooks + MCP |
Expand Down Expand Up @@ -51,7 +52,7 @@ target:
- cursor
```

The `target:` field accepts either a YAML list or a CSV string. See [Manifest schema](../../reference/manifest-schema/#target).
The `target:` field accepts either a YAML list or a CSV string. See [Manifest schema](../../reference/manifest-schema/#36-target-and-targets).

## Primitive flow per target

Expand Down Expand Up @@ -91,8 +92,8 @@ Or pin in `apm.yml` and rerun install.
### Remove a target

1. Edit `apm.yml` to drop the target from `target:`.
2. `apm prune` to remove APM-managed files for the dropped target.
3. `apm install && apm compile` to verify.
2. `apm install` to remove APM-managed files for the dropped target.
3. `apm compile` to refresh compiled context files.

See [Migration paths -> target migration](../../troubleshooting/migration/#5-target-migration).

Expand All @@ -115,6 +116,9 @@ Dependency packages contribute only `dependencies.mcp`; their
- `.cursor/mcp.json` (Cursor)
- `.codex/config.toml` (Codex)
- `.vscode/mcp.json` (VS Code)
- `.github/mcp.json` (Copilot CLI)
- `.agents/mcp_config.json` (Antigravity)
- `~/.hermes/config.yaml` (Hermes, `mcp_servers:` block)
- `opencode.json` at the repo root when `.opencode/` exists (OpenCode)
- `.gemini/settings.json` (Gemini)
- `~/.codeium/windsurf/mcp_config.json` (Windsurf)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -325,9 +325,7 @@ APM's runtime system consists of three main components:

1. **Create Runtime Adapter** - Extend `RuntimeAdapter` in `src/apm_cli/runtime/your_runtime.py`
2. **Create Setup Script** - Add installation script in `scripts/runtime/setup-your-runtime.sh`
3. **Register Runtime** - Add entry to `supported_runtimes` in `RuntimeManager`
4. **Update CLI** - Add runtime to command choices in `cli.py`
5. **Update Factory** - Add runtime to `RuntimeFactory`
3. **Register Runtime** - Add a `RuntimeDescriptor` to `RUNTIME_DESCRIPTORS` in `src/apm_cli/runtime/registry.py`; `RuntimeManager`, the CLI runtime choices, and `RuntimeFactory` all read from it

### Best Practices

Expand Down
Loading