You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a Claude Code user reviewing the gh-aw documentation, I found that Claude users CAN successfully adopt gh-aw, but the documentation has a strong Copilot-first bias that creates unnecessary friction during onboarding. The technology is engine-agnostic and works well with Claude, but the presentation assumes Copilot as the default path.
Key Finding: Claude is well-supported technically (29 example workflows, clear API key setup, full tool compatibility), but the documentation needs better balance to serve non-Copilot users effectively.
Persona Context
I reviewed this documentation as a developer who:
✅ Uses GitHub for version control
✅ Uses Claude Code as primary AI assistant
❌ Does NOT use GitHub Copilot
❌ Does NOT use Copilot CLI
❌ Does NOT have Copilot subscription
Question 1: Onboarding Experience
Can a Claude Code user understand and get started with gh-aw?
Answer: Yes, but with friction. A motivated Claude user can get started, but they must navigate through Copilot-centric documentation to find their path.
Lists "GitHub Copilot subscription" as the FIRST option under "AI Account"
While it mentions Claude as "or", the ordering suggests Copilot is the primary/recommended choice
Claude users might question whether they're using a "secondary" option
Main README Example (README.md:40-62)
The "How It Works" example only mentions Copilot: "The gh aw cli converts this into a GitHub Actions Workflow (.yml) that runs an AI agent (Copilot, Claude, Codex, ...)"
Lists engines in parenthetical order: Copilot first, Claude second
No standalone Claude example to show it's a first-class citizen
How They Work Page (docs/src/content/docs/introduction/how-they-work.mdx:26)
States: "Workflows support GitHub Copilot (default), Claude Code, and Codex"
The word "default" reinforces Copilot-first thinking
Claude users wonder: "Am I using the non-default path? Will things work differently?"
Says "You'll be prompted to choose between Claude, Copilot, or Codex"
This is GREAT, but it's buried in Step 2
Should be highlighted earlier as "Choose YOUR preferred engine"
Recommended Fixes:
Reorder Prerequisites to be neutral:
- ✅ **AI Account** - Choose one:
-[Anthropic Claude](https://www.anthropic.com/) API key
-[GitHub Copilot](https://github.com/features/copilot) subscription
-[OpenAI Codex]((openai.com/redacted) API key
Add Engine-Neutral Language in How They Work:
Workflows support multiple AI engines including **GitHub Copilot**, **Anthropic Claude**, and **OpenAI Codex**. Choose the engine that fits your workflow and preferences.
Create a "Choosing Your Engine" Section in Quick Start that appears BEFORE Step 1, explaining:
All engines are equally supported
No feature limitations by engine
Links to engine-specific setup (Claude API keys, Copilot tokens, etc.)
Question 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Answer: Nearly everything works with Claude! This is excellent news. The system is genuinely engine-agnostic.
Features That Require Copilot:
None that are required for core functionality
Features That Work Without Copilot:
✅ All workflow types (scheduled, event-driven, manual)
✅ All tools (github, bash, edit, playwright, web-fetch)
✅ All safe-outputs (create-issue, add-comment, create-pull-request)
Impact: Claude users can't make informed decisions about whether to use Claude vs alternatives
Current State:
Engines documentation shows how to configure each engine
No comparison of capabilities, costs, or trade-offs
No guidance on "when to choose Claude over Copilot"
Why It's Problematic:
Users can't evaluate if Claude is the right choice for their needs
Hidden advantages (like built-in web-search for Claude) aren't surfaced
No cost comparison to help budget decisions
No feature parity matrix to understand limitations
Suggested Fix:
Create a new "Engine Comparison" page with:
## Engine Comparison| Feature | Copilot | Claude | Codex ||---------|---------|--------|-------||**Cost Model**| Subscription | Pay-per-use | Pay-per-use ||**Authentication**| GitHub PAT | API Key | API Key ||**Web Search**| Via MCP | Built-in ✅ | Via MCP ||**Model Selection**| gpt-5, claude-sonnet-4 | claude-opus-4-5, claude-sonnet-4-5 | gpt-4, gpt-3.5 ||**Token Limits**|[link]|[link]|[link]||**Setup Complexity**| Medium | Low | Low |### When to Choose Claude- You prefer pay-per-use pricing over subscriptions
- You need built-in web search capabilities
- You want access to latest Claude models
- You're already using Claude Code for development
### When to Choose Copilot- You have an existing Copilot subscription
- You want GitHub-integrated authentication
- You prefer subscription-based pricing
``````**Affected Files:** - New file needed: `docs/src/content/docs/reference/engine-comparison.md`- Update `docs/src/content/docs/reference/engines.md` to link to comparison</details>---### 💡 Minor Confusion Points (Score: 8/10)1. **Issue: Architecture diagrams show "Copilot CLI" specifically** - File: `docs/src/content/docs/introduction/architecture.mdx:168` - Should show generic "AI Engine" or "Coding Agent"2. **Issue: CLI examples predominantly use Copilot workflows** - File: `docs/src/content/docs/setup/cli.md` - Should mix Claude and Copilot examples3. **Issue: No explanation of engine differences for web-search tool** - File: `docs/src/content/docs/reference/tools.md:51` - Should clarify which engines have built-in support4. **Issue: "Copilot instructions" mentioned in gh aw init** - File: `docs/src/content/docs/setup/cli.md:163` - Should say "AI agent instructions" generically5. **Issue: No guidance on ANTHROPIC_API_KEY best practices** - File: `docs/src/content/docs/reference/engines.md:78-82` - Could add more detail on API key scoping, rotation, cost tracking6. **Issue: FAQ "default" language** - File: `docs/src/content/docs/reference/faq.md:125` - Remove "default" references to Copilot7. **Issue: No Claude-specific troubleshooting** - Files: troubleshooting docs - Add section for Claude-specific error messages8. **Issue: Example workflows are 65% Copilot** - Files: `.github/workflows/*.md` - While 29 Claude examples exist (26%), more balance would help---## Engine Comparison Analysis### Available EnginesBased on my review, gh-aw supports these engines:- **`engine: copilot`** - GitHub Copilot CLI - Documentation: ⭐⭐⭐⭐⭐ (Excellent - most detailed) - Examples: 73 workflows (65%) - Setup: Clear PAT instructions with "Copilot Requests" permission - Positioned as "default and recommended"- **`engine: claude`** - Anthropic Claude - Documentation: ⭐⭐⭐⭐ (Very Good - complete but secondary) - Examples: 29 workflows (26%) - Setup: Clear API key instructions - Full working example provided- **`engine: codex`** - OpenAI Codex - Documentation: ⭐⭐⭐ (Good - basic coverage) - Examples: 10 workflows (9%) - Setup: Clear API key instructions - Minimal detail### Documentation Quality by Engine| Engine | Setup Docs | Examples | Auth Docs | Feature Docs | Overall Score ||--------|-----------|----------|-----------|--------------|---------------|| Copilot | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ || Claude | ⭐⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐⭐ || Codex | ⭐⭐⭐ | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐ | ⭐⭐⭐ |**Rating Scale:** ⭐⭐⭐⭐⭐ (Excellent) to ⭐ (Poor/Missing)**Key Observations:**- Copilot has comprehensive documentation across all areas- Claude has excellent auth docs and good examples, but less feature documentation- Codex is minimally documented with fewer examples- All engines have clear authentication setup---## Tool Availability Analysis### Tools ReviewAnalyzed tool compatibility across engines using reference documentation:**Engine-Agnostic Tools (Work with ALL engines):**- ✅ `edit:` - File editing- ✅ `bash:` - Shell command execution - ✅ `github:` - GitHub API operations (all toolsets)- ✅ `playwright:` - Browser automation- ✅ `web-fetch:` - Fetch web content- ✅ `agentic-workflows:` - Workflow introspection- ✅ `cache-memory:` - Persistent memory storage- ✅ `repo-memory:` - Repository-specific memory- ✅ All safe-outputs (create-issue, add-comment, create-pull-request, etc.)- ✅ All MCP servers (custom integrations)**Engine-Specific Differences:**- ⚠️ `web-search:` - **Claude: Built-in** | **Copilot: Requires third-party MCP** | **Codex: Unknown** - This is documented in engines.md:56 but not highlighted as a Claude advantage**Unclear/Undocumented:**- ❓ Performance characteristics per engine- ❓ Token usage patterns- ❓ Context window limits- ❓ Model selection options per engine**Verdict:** Tools are genuinely engine-agnostic. The architecture successfully abstracts engine differences.---## Authentication Requirements### Current DocumentationQuick Start guide covers authentication for:- ✅ **Copilot** - Detailed instructions (engines.md:14-54) - Secret name: `COPILOT_GITHUB_TOKEN` - Type: GitHub PAT with "Copilot Requests" permission - Additional notes about "Public repositories" requirement- ✅ **Claude** - Clear instructions (engines.md:64-82) - Secret name: `ANTHROPIC_API_KEY` - Type: Anthropic API key - Link to console.anthropic.com - Full working example provided- ✅ **Codex** - Basic instructions (engines.md:132-150) - Secret name: `OPENAI_API_KEY` - Type: OpenAI API key - Link to platform.openai.com### Missing for Claude Users1. **No cost estimation guidance** - How much will API usage cost per workflow run?2. **No API key scoping best practices** - Should users create separate keys per repo?3. **No rate limit discussion** - What happens when hitting API limits?4. **No model selection guidance** - Which Claude model should users choose for different tasks?5. **No token usage optimization tips** - How to reduce costs with Claude specifically?### Secret NamesDocument what secret names are needed:- **Copilot:** `COPILOT_GITHUB_TOKEN` (documented ✅)- **Claude:** `ANTHROPIC_API_KEY` (documented ✅)- **Codex:** `OPENAI_API_KEY` (documented ✅)- **GitHub Tools Remote Mode:** `GH_AW_GITHUB_TOKEN` or `GH_AW_GITHUB_MCP_SERVER_TOKEN` (documented ✅)**All required secrets are clearly documented!** This is a strength.---## Example Workflow Analysis### Workflow Count by Engine``````
Engine: copilot - 73 workflows (65.2%)
Engine: claude - 29 workflows (25.9%)
Engine: codex - 10 workflows (8.9%)
Total workflows analyzed: 112
Quality of Examples
Copilot Examples:
Comprehensive coverage across all workflow types
Include complex patterns (campaigns, multi-repo, MCP integration)
Well-documented with clear descriptions
Cover security, monitoring, automation use cases
Claude Examples:
Good variety including: audit-workflows, blog-auditor, claude-code-user-docs-review (this workflow!)
Demonstrate that Claude works for production use cases
Include complex scenarios (repo-memory, playwright, network configuration)
Notably: This very review workflow uses Claude engine, proving Claude is production-ready
Assessment:
26% Claude representation is GOOD and shows real support
Would benefit from 30-35% to feel fully balanced
Quality of Claude examples is high - they're not just "also works" examples
Recommended Actions
Priority 1: Critical Documentation Fixes
Remove "Default" Language - Impact: High | Effort: Low
Replace all "(default)" references with neutral language
✅ This Very Workflow Uses Claude! - The claude-code-user-docs-review workflow itself uses Claude, proving it works
✅ Built-in Web Search for Claude - Claude has advantage over Copilot for web-search tool
✅ No Feature Limitations - Claude users get full access to all gh-aw capabilities
Conclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer:Yes, with moderate effort to navigate Copilot-first documentation.
Reasoning:
The gh-aw system is architecturally sound and genuinely engine-agnostic. Claude is well-supported technically with 29 example workflows, clear API key setup, and full tool compatibility. The code works excellently with Claude.
However, the documentation presentation creates unnecessary friction through:
Consistent "default" framing that positions Copilot as primary
Copilot-first ordering in prerequisites and examples
Missing comparison documentation to help users choose engines
No Claude-specific quick start path
A Claude user who persists through this friction will successfully set up and use gh-aw. The technical barriers are minimal. But the psychological barrier of feeling like a "non-default" user discourages adoption.
The fix is straightforward: Neutral language, engine comparison docs, and balanced presentation would make gh-aw equally welcoming to all engine users.
Overall Assessment Score: 7.5/10
Breakdown:
Clarity for non-Copilot users: 7/10
Good: Technical accuracy, engine-agnostic design
Bad: Copilot-first presentation, "default" language
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
-
Executive Summary
As a Claude Code user reviewing the gh-aw documentation, I found that Claude users CAN successfully adopt gh-aw, but the documentation has a strong Copilot-first bias that creates unnecessary friction during onboarding. The technology is engine-agnostic and works well with Claude, but the presentation assumes Copilot as the default path.
Key Finding: Claude is well-supported technically (29 example workflows, clear API key setup, full tool compatibility), but the documentation needs better balance to serve non-Copilot users effectively.
Persona Context
I reviewed this documentation as a developer who:
Question 1: Onboarding Experience
Can a Claude Code user understand and get started with gh-aw?
Answer: Yes, but with friction. A motivated Claude user can get started, but they must navigate through Copilot-centric documentation to find their path.
Specific Issues Found:
Quick Start Prerequisites (docs/src/content/docs/setup/quick-start.md:18-21)
Main README Example (README.md:40-62)
gh awcli converts this into a GitHub Actions Workflow (.yml) that runs an AI agent (Copilot, Claude, Codex, ...)"How They Work Page (docs/src/content/docs/introduction/how-they-work.mdx:26)
Quick Start Interactive Mode (docs/src/content/docs/setup/quick-start.md:38-43)
Recommended Fixes:
Reorder Prerequisites to be neutral:
Add Engine-Neutral Language in How They Work:
Create a "Choosing Your Engine" Section in Quick Start that appears BEFORE Step 1, explaining:
Question 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Answer: Nearly everything works with Claude! This is excellent news. The system is genuinely engine-agnostic.
Features That Require Copilot:
Features That Work Without Copilot:
Engine-Specific Differences Found:
web-searchsupport" (requires third-party MCP)Missing Documentation:
No Engine Comparison Table showing:
No "Engine Migration Guide" for users switching between engines
No explanation of
COPILOT_MODELenvironment variable for Claude users (does it apply? Is there a Claude equivalent?)Question 3: Documentation Gaps and Assumptions
Where does the documentation assume Copilot usage?
Copilot-Centric Language Found In:
File: README.md:40
File: docs/src/content/docs/introduction/how-they-work.mdx:26
File: docs/src/content/docs/reference/engines.md:10-12
File: docs/src/content/docs/introduction/architecture.mdx:168
File: docs/src/content/docs/setup/cli.md:163
gh aw initsays "Copilot instructions, prompt files" specificallyFile: docs/src/content/docs/reference/faq.md:125
Missing Alternative Instructions:
No "Claude User Quick Start" - A parallel quick start guide specifically for Claude users would eliminate confusion
No Engine Selection Guide - "Which engine should I choose?" section with trade-offs:
No Claude-Specific Examples in CLI docs - All examples use Copilot workflows
No "Migrating from Copilot to Claude" guide for users who want to switch
Severity-Categorized Findings
🚫 Critical Blockers (Score: 0/10)
Good news: No critical blockers found! Claude users can successfully install, configure, and use gh-aw.
Obstacle 1: Copilot-First Quick Start Guide
Impact: Significant friction in getting started - Claude users must mentally translate "default" language
Current State:
Why It's Problematic:
Suggested Fix:
gh aw initinteractive mode helps select engineAffected Files:
docs/src/content/docs/setup/quick-start.mdObstacle 2: "Default" Framing Throughout Documentation
Impact: Significant psychological barrier - Claude users question if they're using a "lesser" option
Current State:
Why It's Problematic:
gh aw initSuggested Fix:
Affected Files:
docs/src/content/docs/introduction/how-they-work.mdxdocs/src/content/docs/reference/engines.mddocs/src/content/docs/introduction/architecture.mdxdocs/src/content/docs/reference/faq.mdREADME.mdObstacle 3: No Engine Comparison Documentation
Impact: Claude users can't make informed decisions about whether to use Claude vs alternatives
Current State:
Why It's Problematic:
Suggested Fix:
Create a new "Engine Comparison" page with:
Total workflows analyzed: 112
Quality of Examples
Copilot Examples:
Claude Examples:
Assessment:
Recommended Actions
Priority 1: Critical Documentation Fixes
Remove "Default" Language - Impact: High | Effort: Low
how-they-work.mdx,engines.md,faq.md,README.mdReorder Quick Start Prerequisites - Impact: High | Effort: Low
docs/src/content/docs/setup/quick-start.md:18-21Add "Choose Your Engine" Section - Impact: High | Effort: Medium
docs/src/content/docs/setup/quick-start.mdPriority 2: Major Improvements
Create Engine Comparison Page - Impact: High | Effort: High
docs/src/content/docs/reference/engine-comparison.mdUpdate Architecture Diagrams - Impact: Medium | Effort: Medium
docs/src/content/docs/introduction/architecture.mdxAdd More Claude Examples - Impact: Medium | Effort: High
.github/workflows/*.mdPriority 3: Nice-to-Have Enhancements
Positive Findings
What Works Well
Conclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with moderate effort to navigate Copilot-first documentation.
Reasoning:
The gh-aw system is architecturally sound and genuinely engine-agnostic. Claude is well-supported technically with 29 example workflows, clear API key setup, and full tool compatibility. The code works excellently with Claude.
However, the documentation presentation creates unnecessary friction through:
A Claude user who persists through this friction will successfully set up and use gh-aw. The technical barriers are minimal. But the psychological barrier of feeling like a "non-default" user discourages adoption.
The fix is straightforward: Neutral language, engine comparison docs, and balanced presentation would make gh-aw equally welcoming to all engine users.
Overall Assessment Score: 7.5/10
Breakdown:
Clarity for non-Copilot users: 7/10
Claude engine documentation: 8/10
Alternative approaches provided: 7/10
Engine parity: 8/10
Overall: 7.5/10 - Good technical foundation with room for improved presentation
Next Steps
Immediate Actions (This Week):
Short-Term Actions (This Month):
Long-Term Actions (This Quarter):
Appendix: Files Reviewed
Complete List of Documentation Files Analyzed
Core Documentation:
README.md- Main project READMEdocs/src/content/docs/setup/quick-start.md- Quick Start Guidedocs/src/content/docs/introduction/how-they-work.mdx- How They Workdocs/src/content/docs/introduction/architecture.mdx- Security Architecturedocs/src/content/docs/reference/tools.md- Tools Referencedocs/src/content/docs/setup/cli.md- CLI Referencedocs/src/content/docs/reference/engines.md- AI Engines Documentationdocs/src/content/docs/reference/faq.md- Frequently Asked QuestionsExample Workflows Analyzed:
.github/workflows/*.md- 112 workflow files analyzed for engine usage.github/workflows/audit-workflows.md- Claude example.github/workflows/blog-auditor.md- Claude example.github/workflows/claude-code-user-docs-review.md- Claude example (this workflow)Additional Context:
docs/src/content/docs/guides/- Various guide documentationReport Generated: 2026-02-02
Workflow Run: 21592750303
Engine Used: claude (eating our own dog food! 🐕)
Beta Was this translation helpful? Give feedback.
All reactions