Skip to content

docs: clarify github token configuration #23488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jjangga0214 wants to merge 2 commits into
base: dev
Choose a base branch
from
+5 −4
Open

docs: clarify github token configuration #23488

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d5893d
docs: clarify github token configuration
jjangga0214 Apr 20, 2026
00580d4
docs: keep github token clarification in english only
jjangga0214 Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions packages/web/src/content/docs/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,11 @@ Or you can set it up manually.
uses: anomalyco/opencode/github@latest
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
model: anthropic/claude-sonnet-4-20250514
# share: true
# github_token: xxxx
# use_github_token: true
```

3. **Store the API keys in secrets**
Expand All @@ -85,9 +86,9 @@ Or you can set it up manually.
- `agent`: The agent to use. Must be a primary agent. Falls back to `default_agent` from config or `"build"` if not found.
- `share`: Whether to share the OpenCode session. Defaults to **true** for public repositories.
- `prompt`: Optional custom prompt to override the default behavior. Use this to customize how OpenCode processes requests.
- `token`: Optional GitHub access token for performing operations such as creating comments, committing changes, and opening pull requests. By default, OpenCode uses the installation access token from the OpenCode GitHub App, so commits, comments, and pull requests appear as coming from the app.
- `use_github_token`: When set to **true**, OpenCode uses the `GITHUB_TOKEN` environment variable directly instead of exchanging an OpenCode GitHub App token. By default, OpenCode uses the installation access token from the OpenCode GitHub App, so commits, comments, and pull requests appear as coming from the app.

Alternatively, you can use the GitHub Action runner's [built-in `GITHUB_TOKEN`](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) without installing the OpenCode GitHub App. Just make sure to grant the required permissions in your workflow:
To use the GitHub Action runner's [built-in `GITHUB_TOKEN`](https://docs.github.com/en/actions/tutorials/authenticate-with-github_token), set `use_github_token: true`, pass the token through `env`, and grant the required permissions in your workflow:

```yaml
permissions:
Expand All @@ -97,7 +98,7 @@ Or you can set it up manually.
issues: write
```

You can also use a [personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)(PAT) if preferred.
You can also pass a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) through `GITHUB_TOKEN` if preferred.

---

Expand Down
Loading