Context
Created from the Claude Code User Documentation Review in discussion #31206.
Objective
Document that the .github/agents/agentic-workflows.agent.md file created by gh aw init is only used by the Copilot engine, so Claude/Codex/Gemini users aren't confused by a Copilot-only artifact in their repo.
Current State
docs/src/content/docs/setup/cli.md line ~134 says:
"Configures .gitattributes, creates the dispatcher agent file (.github/agents/agentic-workflows.agent.md)"
There is no note that this agent file is Copilot-specific. A Claude user running gh aw init gets a Copilot-only artifact committed to their repo with no guidance on what to do with it.
Approach
- Open
docs/src/content/docs/setup/cli.md around line 134
- Add a note/callout after the
gh aw init description: "The dispatcher agent file (.github/agents/agentic-workflows.agent.md) is only used by the Copilot engine. If you plan to use Claude, Codex, or Gemini exclusively, you can safely delete this file — it has no effect on other engines."
- Consider also adding
--engine <engine> flag documentation to gh aw init if that flag exists (check actual CLI behavior first)
Files to Modify
docs/src/content/docs/setup/cli.md
Acceptance Criteria
Generated by Plan Command for issue #discussion #31206 · ● 4.4M · ◷
Context
Created from the Claude Code User Documentation Review in discussion #31206.
Objective
Document that the
.github/agents/agentic-workflows.agent.mdfile created bygh aw initis only used by the Copilot engine, so Claude/Codex/Gemini users aren't confused by a Copilot-only artifact in their repo.Current State
docs/src/content/docs/setup/cli.mdline ~134 says:There is no note that this agent file is Copilot-specific. A Claude user running
gh aw initgets a Copilot-only artifact committed to their repo with no guidance on what to do with it.Approach
docs/src/content/docs/setup/cli.mdaround line 134gh aw initdescription: "The dispatcher agent file (.github/agents/agentic-workflows.agent.md) is only used by the Copilot engine. If you plan to use Claude, Codex, or Gemini exclusively, you can safely delete this file — it has no effect on other engines."--engine <engine>flag documentation togh aw initif that flag exists (check actual CLI behavior first)Files to Modify
docs/src/content/docs/setup/cli.mdAcceptance Criteria
gh aw initsection clearly states the agent file is Copilot-specificgh aw init --engineflag exists, it is documented