claude-code-action README

The project's README from github.com/anthropics/claude-code-action. As one markdown file: README.md.

Claude Code Action responding to a comment

Claude Code Action

A general-purpose Claude Code action for GitHub PRs and issues that can answer questions and implement code changes. This action intelligently detects when to activate based on your workflow context—whether responding to @claude mentions, issue assignments, or executing automation tasks with explicit prompts. It supports multiple authentication methods including Anthropic direct API (API key or workload identity federation), Amazon Bedrock, Google Vertex AI, and Microsoft Foundry.

Features

📦 Upgrading from v0.x?

See our Migration Guide for step-by-step instructions on updating your workflows to v1.0. The new version simplifies configuration while maintaining compatibility with most existing setups.

Quickstart

The easiest way to set up this action is through Claude Code in the terminal. Just open claude and run /install-github-app.

This command will guide you through setting up the GitHub app and required secrets.

Note:

📚 Solutions & Use Cases

Looking for specific automation patterns? Check our Solutions Guide for complete working examples including:

Each solution includes complete working examples, configuration details, and expected outcomes.

Documentation

📚 FAQ

Having issues or questions? Check out our Frequently Asked Questions for solutions to common problems and detailed explanations of Claude's capabilities and limitations.

License

This project is licensed under the MIT License—see the LICENSE file for details.

claude-code-action (anthropics/claude-code-action)

Searching Database…

What is this?Claude Code Action is a GitHub Action from Anthropic that lets Claude answer questions and implement code changes directly in your repo's pull requests and issues. It activates on @claude mentions, issue assignments, or explicit automation prompts.
Is this a standalone app or something I add to my CI workflow?It is a GitHub Action you drop into your repository's workflow YAML, and it runs entirely on your own GitHub runner rather than on Anthropic-hosted infrastructure.
How do I get it running on my repo?Open Claude Code in your terminal and run '/install-github-app', which walks you through installing the GitHub app and adding the required secrets.
Which auth providers does it support?It supports Anthropic's direct API (API key or workload identity federation), Amazon Bedrock, Google Vertex AI, and Microsoft Foundry for authentication.
Do I need special permissions to install it?Yes, you must be a repository admin to install the GitHub app and add secrets, and the one-command quickstart only works for direct Anthropic API users—Bedrock, Vertex AI, or Foundry setups require manual configuration.
How does Claude decide when to activate on a PR or issue?It uses intelligent mode detection that automatically picks the right execution mode based on workflow context—@claude mentions, issue assignment, or an explicit automation prompt—without needing extra configuration.
What kinds of tasks can Claude actually do in a repo?It can answer questions about code and architecture, review PR diffs and suggest improvements, implement simple fixes or new features, and post progress-tracking comments with checkboxes as it works.
I was on the old v0.x version—do I need to rewrite my workflows?No full rewrite needed: v1.0 unifies config around 'prompt' and 'claudeargs' inputs while staying compatible with most existing v0.x setups; there's a dedicated Migration Guide for the upgrade.
Can it feed results into other automation steps?Yes, it can return validated JSON results that automatically become GitHub Action outputs, so you can chain it into more complex automation pipelines.
Creator
anthropics
Size
3.1 MB
Stars
9.5K
Age
1y
Commits · 90 Days