@claude in a pull request or issue comment to have Claude analyze code, implement changes, and push commits. You can also give the Claude Code GitHub Action a prompt to run automatically on any GitHub event. Use it to turn issues into pull requests, fix bugs from a comment, or automate recurring tasks.
Several products share the Claude Code name. This page covers the claude-code-action workflow integration, which you configure with workflow files in your repository. For the related products, see:
- Code Review: automatic review on every pull request, without writing a workflow
- Claude Code on the web: Claude Code sessions from your browser or phone
- Claude Agent SDK: custom automation outside GitHub Actions. The Claude Code GitHub Action is built on the SDK
- GitHub Enterprise Server: Claude Code with self-hosted GitHub
Setup
You can set up the Claude Code GitHub Action in one of two ways:- Quick setup: run
/install-github-appfrom Claude Code. Claude Code installs the GitHub App, adds your authentication secret, and prepares the workflow pull request for you - Manual setup: install the app, add the secret, and copy the workflow file into your repository yourself. Use this path when you don’t run Claude Code locally, when the command fails, or when you want full control of the workflow files
Quick setup
Before you start, install the GitHub CLI and authenticate it withgh auth login. Claude Code checks for it and warns you if it’s missing.
Open claude in the repository you want to connect, run /install-github-app, and follow the prompts. Claude Code installs the Claude GitHub App, then sets up an authentication secret for the workflows:
- If Claude Code already has an API key, it reuses that key, and offers to keep the repository’s existing
ANTHROPIC_API_KEYsecret if one is already set - Otherwise, choose between creating a long-lived token with your Claude subscription and pasting in an API key
ANTHROPIC_API_KEY for an API key or CLAUDE_CODE_OAUTH_TOKEN for a subscription token.
Claude Code then pushes a branch with the workflow files you select, already set to use that secret, and opens GitHub in your browser with a pull request ready to create. Create and merge that pull request, and @claude works in the repository.
After installing the GitHub App, Claude Code asks whether to continue with GitHub Actions setup. Choose Skip for now to stop with only the GitHub App installed. Run /install-github-app again later to finish the workflow and secret steps. Before v2.1.187, Claude Code proceeded straight to workflow selection.
- When you install the GitHub App, you grant it several permissions. See GitHub App permissions for the full set
- Quick setup works with the Claude API and Claude subscriptions. If you use Amazon Bedrock, Google Cloud’s Agent Platform, or Microsoft Foundry, see Use Claude Code GitHub Actions with cloud providers
Manual setup
To configure the Claude Code GitHub Action without running/install-github-app, install the app, add a secret, and copy a workflow file yourself:
1
Install the Claude GitHub App
Install the Claude GitHub App to your repository. The Claude Code GitHub Action relies on three of the app’s permissions:
- Contents: read and write, so Claude can modify repository files
- Issues: read and write, so Claude can respond to issues
- Pull requests: read and write, so Claude can create PRs and push changes
2
Add an authentication secret
Add one of the following secrets to your repository, depending on how you authenticate. See GitHub’s guide to using secrets in GitHub Actions.
ANTHROPIC_API_KEY: a Claude API key from the Claude ConsoleCLAUDE_CODE_OAUTH_TOKEN: an OAuth token that authenticates with your Claude subscription, available on Pro, Max, Team, and Enterprise plans. Generate one by runningclaude setup-tokenlocally. See Generate a long-lived token
anthropic_api_key for an API key, or claude_code_oauth_token for an OAuth token.3
Copy the workflow file
Copy examples/claude.yml into your repository’s
.github/workflows/ directory. The file is a working workflow, not just an example. As committed, Claude responds whenever someone mentions @claude in an issue or pull request, authenticating with the ANTHROPIC_API_KEY secret. If you added CLAUDE_CODE_OAUTH_TOKEN instead, change the workflow’s anthropic_api_key line to claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}.Set up for an organization
With quick setup or manual setup, you configure one repository at a time. To roll the Claude Code GitHub Action out across an organization:- Install the Claude GitHub App once at the organization level, choosing all repositories or a selected list
- Store the authentication secret as an organization-level Actions secret so each repository doesn’t need its own copy
- Add the workflow file to each repository that should run the Claude Code GitHub Action, or define the job once as a reusable workflow that each repository calls
claude setup-token.
To avoid storing a long-lived secret entirely, authenticate through workload identity federation, where the Claude Code GitHub Action exchanges the workflow’s GitHub OpenID Connect (OIDC) token for Claude API access through a Claude Console service account. Set these inputs:
anthropic_federation_rule_id: the federation rule ID,fdrl_...anthropic_organization_id: your Anthropic organization IDanthropic_service_account_id: the service account ID,svac_.... Optional, since the federation rule you create in the Console already targets a service accountanthropic_workspace_id: the workspace ID,wrkspc_.... Optional when the federation rule targets a single workspace
id-token: write permission, which the Claude Code GitHub Action needs for the federation exchange even when you pass your own github_token. See the Claude Code GitHub Action’s setup guide for the Console-side configuration.
For data handling and retention questions in a security review, see data usage and security.
Uninstall
To remove the Claude Code GitHub Action, undo each piece of the setup that applies to your installation:- Workflow files: delete the workflows that use
anthropics/claude-code-actionfrom.github/workflows/. If you used quick setup, look forclaude.ymland, if you selected the review workflow,claude-code-review.yml. With the workflows deleted, the Claude Code GitHub Action no longer runs - Secrets: delete the
ANTHROPIC_API_KEYorCLAUDE_CODE_OAUTH_TOKENsecret from the repository, and from organization-level Actions secrets if you shared it across repositories. If you delete a secret, the credential it held stays valid. To retire an API key entirely, also delete the key in the Claude Console - GitHub App: uninstall the Claude GitHub App in your repository or organization settings under GitHub Apps, but only if you don’t use it for another Claude feature, such as Code Review or web auto-fix
AWS_ROLE_TO_ASSUME, the GCP_* secrets, or the AZURE_* secrets, and uninstall the custom GitHub App along with its APP_ID and APP_PRIVATE_KEY secrets.
GitHub App permissions
The Claude GitHub App is shared by every Claude feature that integrates with GitHub, including the Claude Code GitHub Action, Code Review, and auto-fix for pull requests on Claude Code on the web. A GitHub App has a single permission set covering all of its features, so the set includes some permissions that the Claude Code GitHub Action doesn’t use. When you install the app, you grant the following permissions:
The permission set can also change ahead of the features that use it. When the app requests a permission it didn’t have before, GitHub prompts the account owner to approve it, an organization owner for an organization install, and the installation keeps its old permissions until they do. For example, when Actions access changes from read to write, the app can re-run workflows rather than only view runs and logs, so GitHub asks the owner to approve the change.
When you install the app, you accept its full permission set. GitHub doesn’t let you accept a subset. If your organization requires only the permissions the Claude Code GitHub Action uses, create a custom GitHub App with Contents, Issues, and Pull requests instead, following the Claude Code GitHub Action’s setup guide. A custom app covers only the Claude Code GitHub Action. Code Review and web auto-fix still require the official app.
For details on how the Claude Code GitHub Action limits what Claude can do with these permissions, see the security documentation.
Interactive and automation modes
The Claude Code GitHub Action detects how to run from your workflow configuration:- Interactive mode: when the workflow provides no
promptinput, Claude waits for the trigger phrase,@claudeby default, in an issue or pull request comment, in a pull request review, or in the body or title of a newly opened issue, then responds to that request. Progress and results appear as a comment on the triggering issue or PR. - Automation mode: when the workflow provides a
promptinput, Claude runs without waiting for a mention, subject only to the access checks below. Results appear in the workflow run log rather than a comment.
Who can trigger runs
In both modes, the Claude Code GitHub Action runs two checks on the triggering actor before Claude starts, and the run fails when either check rejects it:- Write access: on issue and pull request events, the triggering user must have write access to the repository. To allow specific users without write access, set
allowed_non_write_usersand pass your owngithub_tokeninput. Events that no user authors, such as ascheduletrigger, skip this check. - Human actor: on every event, the Claude Code GitHub Action rejects a bot actor unless you list it in
allowed_bots, which keeps bots from triggering Claude in a loop. This check also applies to scheduled runs, which GitHub attributes to a repository user, usually the one who last changed the workflow’scronschedule. If that user is a bot, list it inallowed_bots.
Example use cases
The examples directory contains ready-to-use workflows for different scenarios. The examples on this page show API key authentication. If you authenticate with a Claude subscription, replace theanthropic_api_key line in any example with claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}.
Respond to @claude mentions
This workflow runs the Claude Code GitHub Action in interactive mode, so Claude responds whenever someone mentions@claude in an issue or PR comment.
id-token: write: required for the Claude Code GitHub Action’s default GitHub App authenticationactions: read: lets Claude read CI results on PRsactions/checkout: gives Claude a local copy of the repository to work inif: keeps runners from starting on comments that don’t mention@claude. The Claude Code GitHub Action also checks the trigger phrase itself before responding
@claude in any issue or PR comment with a request:
Run a skill
Theprompt input accepts a skill invocation as well as plain text:
- For a skill in your repository’s
.claude/skills/directory, runactions/checkoutbefore theanthropics/claude-code-actionstep so the skill files are available on the runner, then pass/skill-nameas theprompt. - For a skill packaged in a plugin, install the plugin with the
plugin_marketplacesandpluginsinputs, then pass the namespaced/plugin-name:skill-nameas theprompt. Thepluginsinput takesplugin-name@marketplace-name, where the marketplace name comes from the marketplace’s own manifest rather than its repository URL.
code-review plugin and runs its skill on each new or updated pull request. It runs the same plugin as the review workflow from quick setup. Use a workflow like this when you want to control the prompt, model, and triggers yourself. For automatic reviews without maintaining a workflow file, see Code Review. On public repositories, GitHub withholds secrets from runs triggered by fork pull requests, so the review runs only on pull requests from branches in the same repository.
Run on a schedule
With aprompt input, the Claude Code GitHub Action runs in automation mode on any GitHub event, including a cron schedule. For a plain-text prompt, Claude has no shell or GitHub API access until you grant the tools the prompt needs, with --allowedTools in claude_args or a permissions.allow rule in the settings input. If you invoke a skill instead, Claude can use the tools its allowed-tools frontmatter grants. GitHub runs scheduled workflows only from the default branch and, in public repositories, disables the schedule after 60 days without repository activity.
This workflow generates a report in the workflow run log at 09:00 UTC each day. Its claude_args line passes CLI arguments that select the model and allow two GitHub MCP tools. Claude reads commits and issues through the GitHub API with those tools, so you can omit the checkout step:
Best practices
Define project standards in CLAUDE.md
Create aCLAUDE.md file in your repository root to define code style guidelines, review criteria, project-specific rules, and preferred patterns. Claude follows these guidelines when creating PRs and responding to requests. See the memory documentation for details.
Protect your credentials
Grant the workflow only the permissions it needs, and review Claude’s changes before merging. For comprehensive security guidance including permissions and authentication, see the Claude Code Action security documentation.Manage costs
Each run consumes two kinds of resources:- GitHub Actions minutes: the Claude Code GitHub Action runs on GitHub-hosted runners, which consume your GitHub Actions minutes. See GitHub’s billing documentation for pricing and minute limits.
- API tokens: each interaction consumes tokens based on the length of prompts and responses, task complexity, and codebase size. See Claude’s pricing page for current token rates. If you authenticate with an OAuth token, runs use your Claude subscription instead of API billing.
- Write specific
@clauderequests so Claude needs fewer turns to finish - Use issue templates to provide context up front
- Keep your
CLAUDE.mdconcise, since Claude reads it on every run - Set
--max-turnsinclaude_argsto limit iterations - Set workflow-level timeouts to avoid runaway jobs
- Use GitHub’s concurrency controls to limit parallel runs
Use a cloud provider
By default, the Claude Code GitHub Action calls the Claude API directly with your API key or OAuth token. To route inference through your own cloud account instead, set the input for your provider and follow Use Claude Code GitHub Actions with cloud providers:- Amazon Bedrock:
use_bedrock: "true" - Google Cloud’s Agent Platform:
use_vertex: "true" - Microsoft Foundry:
use_foundry: "true"
Troubleshooting
Claude not responding to @claude commands
- Verify the GitHub App is installed on the repository
- Check that workflows are enabled for the repository
- Ensure your API key or OAuth token is set in repository secrets
- Confirm the comment contains
@claudeas a complete word, not/claudeor@claude-bot - Confirm the commenting user has write access to the repository. See Who can trigger runs for the exceptions
CI not running on Claude’s commits
- GitHub doesn’t trigger workflows on commits made with the default
GITHUB_TOKEN. If you passgithub_token: ${{ secrets.GITHUB_TOKEN }}to the Claude Code GitHub Action, remove it so it authenticates as the Claude GitHub App, or pass a custom app token instead - Check that your CI workflow’s triggers include the events Claude’s pushes produce, such as
pushorpull_request
Authentication errors
- Confirm the API key or OAuth token is valid by testing it locally with
claudebefore debugging the workflow - For Bedrock, Agent Platform, and Foundry, see the cloud provider page’s troubleshooting section
Advanced configuration
Action parameters
These are the most commonly used inputs. Each maps to awith: key in the anthropics/claude-code-action step.
For the full input list, see the Claude Code GitHub Action’s configuration reference.
Pass CLI arguments
Theclaude_args parameter accepts any Claude Code CLI argument:
--max-turns: limit the number of conversation turns--model: model to use, for exampleclaude-sonnet-5. Without this argument, the Claude Code GitHub Action uses the Claude Code default model--mcp-config: path to MCP configuration--allowedTools: comma-separated list of allowed tools. The--allowed-toolsalias also works--debug: enable debug output
Upgrade from beta
If your workflows still referenceanthropics/claude-code-action@beta, update them to v1:
- Change
@betato@v1in theusesline - Remove the
modeinput, since the Claude Code GitHub Action now detects the mode automatically - Replace
direct_promptwithprompt - Move CLI options such as
max_turnsandmodelintoclaude_args.custom_instructionshas no same-name flag and becomes--append-system-prompt
What’s next
- Use Claude Code GitHub Actions with cloud providers: route inference through Amazon Bedrock, Google Cloud’s Agent Platform, or Microsoft Foundry
- Configuration reference: the full list of action inputs
- Examples directory: ready-to-use workflows for more scenarios
- Code Review: automatic pull request review without maintaining a workflow file