docs: document Claude Code guided-authoring workaround for agentic-workflows create - #48957
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot |
…docs Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Updated all three docs to use |
|
@copilot update other engine specific pages with the |
Triage: docsRisk: low | Priority: low (score 32/100) Breakdown: impact 12/50 (docs-only, 3 files) · urgency 8/30 (no CI signal yet, draft) · quality 12/20 (clear description, no reviews yet) Recommended action: Small, low-risk documentation addition. Draft status and no CI checks run yet reduce urgency. Safe to review whenever cycles allow.
|
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Added |
There was a problem hiding this comment.
Pull request overview
Documents guided workflow authoring for Claude Code and other non-Copilot users.
Changes:
- Adds Claude Code guided-authoring instructions.
- Documents engine-specific repository initialization.
- Updates the FAQ with Copilot and CLI-agent paths.
Show a summary per file
| File | Description |
|---|---|
engines/claude.md |
Adds Claude guided authoring. |
engines/codex.md |
Adds Codex initialization guidance. |
engines/copilot.md |
Adds Copilot initialization guidance. |
engines/gemini.md |
Adds Gemini initialization guidance. |
reference/faq.md |
Documents AI-authoring options. |
setup/creating-workflows.mdx |
Adds non-Copilot guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 6/6 changed files
- Comments generated: 6
- Review effort level: Medium
|
|
||
| ### Initialize for Claude | ||
|
|
||
| Run `gh aw init --engine claude` to configure the repository. The `--engine claude` flag skips Copilot-specific files (MCP server configuration, Copilot dispatcher skill) and only writes the files useful for any engine: `.gitattributes`, VS Code settings, and the custom agent file. |
|
|
||
| ### Initialize the repository | ||
|
|
||
| Run `gh aw init --engine gemini` to configure the repository. The `--engine gemini` flag skips Copilot-specific files (MCP server configuration, Copilot dispatcher skill) and writes only the files useful for any engine: `.gitattributes`, VS Code settings, and the custom agent file. |
|
|
||
| ### Initialize the repository | ||
|
|
||
| Run `gh aw init --engine codex` to configure the repository. The `--engine codex` flag skips Copilot-specific files (MCP server configuration, Copilot dispatcher skill) and writes only the files useful for any engine: `.gitattributes`, VS Code settings, and the custom agent file. |
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > The `agentic-workflows` Copilot Chat skill requires a GitHub Copilot subscription. If you use Claude Code or another CLI coding agent without Copilot access, run `gh aw init --engine claude` instead — it skips the Copilot-specific MCP and skill files while still writing `.gitattributes`, VS Code settings, and the custom agent file. Then use the `create.md` approach in the [VSCode/Claude/Codex/Copilot](#vscodeclaudecodexcopilot) section above for guided workflow authoring. |
| - **Claude Code and other CLI agent users**: run `gh aw init --engine claude` to initialize (skips Copilot-specific files), then use the `create.md` prompt directly — no Copilot subscription required: | ||
|
|
||
| ```text wrap | ||
| Create a workflow for GitHub Agentic Workflows using https://raw.githubusercontent.com/github/gh-aw/main/create.md | ||
|
|
||
| The purpose of the workflow is <your goal here>. | ||
| ``` |
| ```text wrap | ||
| Create a workflow for GitHub Agentic Workflows using https://raw.githubusercontent.com/github/gh-aw/main/create.md | ||
|
|
||
| The purpose of the workflow is <describe your automation goal here>. |
|
🎉 This pull request is included in a new release. Release: |
The
agentic-workflows createCopilot Chat skill (enabled bygh aw init) requires a GitHub Copilot subscription. Claude Code-only users had no documented equivalent — they were left to hand-author workflow YAML with no guidance.The
create.mdprompt already works with any CLI coding agent, including Claude Code, but this path was undocumented.Changes
engines/claude.md— adds a "Guided workflow authoring with Claude Code" section with the exactcreate.mdprompt, explains what the agent does, and calls out the Copilot-subscription requirement for the Copilot Chat skill variantsetup/creating-workflows.mdx— adds a NOTE callout at the end of "Initialize the Repository" routing Claude Code / non-Copilot CLI users to thecreate.mdapproachreference/faq.md— rewrites the "hand editing or using AI?" answer to show both paths explicitly:agentic-workflows createfor Copilot Chat users, and thecreate.mdprompt for Claude Code users