docs(code): clarify GitHub token vs App credentials - #9
Merged
Conversation
GITHUB_TOKEN and GitHub App credentials are complementary, not interchangeable. Update env examples and docs so it is obvious which each is required for, and that precedence differs between CLI (token-first) and worker --listen (App-first).
Lead GitHub auth docs with the product split that matches pricing: GITHUB_TOKEN for free interactive CLI use, GitHub App for team and unattended automation. Keep the capability table so Issues still requires a token and LICENSE_KEY stays the automation license gate.
The capability table listed GitHub App as a personal-use option because the CLI can fall back to App auth. That is a team-setup side effect, not the path to recommend for interactive use.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GITHUB_TOKENand GitHub App credentials (GITHUB_APP_ID+ private key) were documented as interchangeable "option 1 / option 2" for PR creation. They are complementary, and skipping the App (or the token) silently breaks some paths.This updates env examples and docs so the split is explicit:
GITHUB_TOKENis required forTASK_TRACKER=github(the App cannot substitute). It is enough for CLI task implementation,--create-pr, and worker review polling on the agent's own PRs.GITHUB_APP_ID+ private key) is required for@mentionmatching on any PR (worker mention sweep andworker --listen/ webhook) and forslug[bot]commit attribution.worker --listen/ webhook server prefers the App so the bot identity resolves.GITHUB_APP_IDwithout a private key does not configure the App.Test plan
bun run test init-wizard.test.ts workspace-init.test.tsinpackages/code