Skip to content

docs: clarify Claude quick-start auth + initialization path#39638

Closed
Copilot wants to merge 4 commits into
mainfrom
copilot/deep-report-fix-quick-start-docs
Closed

docs: clarify Claude quick-start auth + initialization path#39638
Copilot wants to merge 4 commits into
mainfrom
copilot/deep-report-fix-quick-start-docs

Conversation

Copilot AI commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Quick Start was Copilot-first and omitted two Claude-critical onboarding details: CLAUDE_CODE_OAUTH_TOKEN is unsupported, and gh aw init defaults to Copilot-oriented artifacts unless an engine is specified. This update makes those constraints explicit in the primary setup path.

  • Quick Start command flow (Claude path)

    • Adds gh aw init --engine claude to the setup commands.
    • Clarifies when to run it (new Claude setup) vs skip it (already initialized or non-Claude setup).
    • States explicitly that bare gh aw init produces Copilot-oriented init artifacts.
  • Claude auth caveat surfaced inline

    • In the ANTHROPIC_API_KEY note, adds that CLAUDE_CODE_OAUTH_TOKEN (Claude Max/Teams OAuth) is ignored and unsupported.
    • Directs users to use ANTHROPIC_API_KEY instead.
# Claude users: initialize repo artifacts for Claude
gh aw init --engine claude

# Then add a workflow
gh aw add-wizard githubnext/agentics/daily-repo-status

Copilot AI and others added 2 commits June 16, 2026 18:30
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix Quick Start docs to support CLAUDE_CODE_OAUTH_TOKEN information docs: clarify Claude quick-start auth + initialization path Jun 16, 2026
Copilot AI requested a review from pelikhan June 16, 2026 18:33
@pelikhan pelikhan marked this pull request as ready for review June 16, 2026 18:50
Copilot AI review requested due to automatic review settings June 16, 2026 18:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Quick Start documentation to make Claude-specific onboarding requirements explicit, especially around repository initialization and supported authentication methods.

Changes:

  • Adds gh aw init --engine claude to the primary Quick Start command flow, with guidance on when to run vs skip it.
  • Clarifies that running gh aw init without an engine produces Copilot-oriented initialization artifacts.
  • Adds an inline warning that CLAUDE_CODE_OAUTH_TOKEN is unsupported/ignored, and that Claude requires ANTHROPIC_API_KEY.
Show a summary per file
File Description
docs/src/content/docs/setup/quick-start.mdx Clarifies Claude initialization and authentication caveats in the Quick Start path.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

gh aw add-wizard githubnext/agentics/daily-repo-status
```

If the repository is already initialized, or if not using Claude, skip the `gh aw init --engine claude` command. By default, `gh aw init` creates Copilot-oriented artifacts unless `--engine claude` is provided.
@github-actions

Copy link
Copy Markdown
Contributor

@copilot please summarize any remaining blockers and confirm whether this PR is ready to merge.

Generated by 👨‍🍳 PR Sous Chef ·

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants