Skip to content

Commit 17fdc9a

Browse files
Copilotmnriem
andauthored
docs(AGENTS.md): document Copilot --skills option
Agent-Logs-Url: https://github.com/github/spec-kit/sessions/a4903fab-64ff-46c3-8eb8-a47f495a70c0 Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com>
1 parent d12ba9b commit 17fdc9a

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -264,13 +264,13 @@ The base classes handle most work automatically. Override only when the agent de
264264
| Override | When to use | Example |
265265
|---|---|---|
266266
| `command_filename(template_name)` | Custom file naming or extension | Copilot → `speckit.{name}.agent.md` |
267-
| `options()` | Integration-specific CLI flags via `--integration-options` | Codex → `--skills` flag |
268-
| `setup()` | Custom install logic (companion files, settings merge) | Copilot → `.agent.md` + `.prompt.md` + `.vscode/settings.json` |
267+
| `options()` | Integration-specific CLI flags via `--integration-options` | Codex → `--skills` flag, Copilot → `--skills` flag |
268+
| `setup()` | Custom install logic (companion files, settings merge) | Copilot → `.agent.md` + `.prompt.md` + `.vscode/settings.json` (default) or `speckit-<name>/SKILL.md` (skills mode) |
269269
| `teardown()` | Custom uninstall logic | Rarely needed; base handles manifest-tracked files |
270270

271271
**Example — Copilot (fully custom `setup`):**
272272

273-
Copilot extends `IntegrationBase` directly because it creates `.agent.md` commands, companion `.prompt.md` files, and merges `.vscode/settings.json`. See `src/specify_cli/integrations/copilot/__init__.py` for the full implementation.
273+
Copilot extends `IntegrationBase` directly because it creates `.agent.md` commands, companion `.prompt.md` files, and merges `.vscode/settings.json`. It also supports a `--skills` mode that scaffolds `speckit-<name>/SKILL.md` under `.github/skills/` using composition with an internal `_CopilotSkillsHelper`. See `src/specify_cli/integrations/copilot/__init__.py` for the full implementation.
274274

275275
### 7. Update Devcontainer files (Optional)
276276

@@ -391,6 +391,24 @@ Implementation: Extends `IntegrationBase` with custom `setup()` method that:
391391
2. Generates companion `.prompt.md` files
392392
3. Merges VS Code settings
393393

394+
**Skills mode (`--skills`):** Copilot also supports an alternative skills-based layout
395+
via `--integration-options="--skills"`. When enabled:
396+
- Commands are scaffolded as `speckit-<name>/SKILL.md` under `.github/skills/`
397+
- No companion `.prompt.md` files are generated
398+
- No `.vscode/settings.json` merge
399+
- `post_process_skill_content()` injects a `mode: speckit.<stem>` frontmatter field
400+
- `build_command_invocation()` returns `/speckit-<stem>` instead of bare args
401+
402+
The two modes are mutually exclusive — a project uses one or the other:
403+
404+
```bash
405+
# Default mode: .agent.md agents + .prompt.md companions + settings merge
406+
specify init my-project --integration copilot
407+
408+
# Skills mode: speckit-<name>/SKILL.md under .github/skills/
409+
specify init my-project --integration copilot --integration-options="--skills"
410+
```
411+
394412
### Forge Integration
395413

396414
Forge has special frontmatter and argument requirements:

0 commit comments

Comments
 (0)