mirror of
https://github.com/anthropics/claude-code-action.git
synced 2026-01-22 22:44:13 +08:00
0d9513b3b3
- Move FAQ.md to docs/faq.md - Create structured documentation files: - setup.md: Manual setup and custom GitHub app instructions - usage.md: Basic usage and workflow configuration - custom-automations.md: Automation examples - configuration.md: MCP servers and advanced settings - experimental.md: Execution modes and network restrictions - cloud-providers.md: AWS Bedrock and Google Vertex setup - capabilities-and-limitations.md: Features and constraints - security.md: Security information - Condense README.md to overview with links to detailed docs - Keep CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md at top level
127 lines
8.0 KiB
Markdown
127 lines
8.0 KiB
Markdown
# Usage
|
|
|
|
Add a workflow file to your repository (e.g., `.github/workflows/claude.yml`):
|
|
|
|
```yaml
|
|
name: Claude Assistant
|
|
on:
|
|
issue_comment:
|
|
types: [created]
|
|
pull_request_review_comment:
|
|
types: [created]
|
|
issues:
|
|
types: [opened, assigned, labeled]
|
|
pull_request_review:
|
|
types: [submitted]
|
|
|
|
jobs:
|
|
claude-response:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: anthropics/claude-code-action@beta
|
|
with:
|
|
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
# Or use OAuth token instead:
|
|
# claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
# Optional: set execution mode (default: tag)
|
|
# mode: "tag"
|
|
# Optional: add custom trigger phrase (default: @claude)
|
|
# trigger_phrase: "/claude"
|
|
# Optional: add assignee trigger for issues
|
|
# assignee_trigger: "claude"
|
|
# Optional: add label trigger for issues
|
|
# label_trigger: "claude"
|
|
# Optional: add custom environment variables (YAML format)
|
|
# claude_env: |
|
|
# NODE_ENV: test
|
|
# DEBUG: true
|
|
# API_URL: https://api.example.com
|
|
# Optional: limit the number of conversation turns
|
|
# max_turns: "5"
|
|
# Optional: grant additional permissions (requires corresponding GitHub token permissions)
|
|
# additional_permissions: |
|
|
# actions: read
|
|
```
|
|
|
|
## Inputs
|
|
|
|
| Input | Description | Required | Default |
|
|
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
|
|
| `mode` | Execution mode: 'tag' (default - triggered by mentions/assignments), 'agent' (for automation with no trigger checking) | No | `tag` |
|
|
| `anthropic_api_key` | Anthropic API key (required for direct API, not needed for Bedrock/Vertex) | No\* | - |
|
|
| `claude_code_oauth_token` | Claude Code OAuth token (alternative to anthropic_api_key) | No\* | - |
|
|
| `direct_prompt` | Direct prompt for Claude to execute automatically without needing a trigger (for automated workflows) | No | - |
|
|
| `override_prompt` | Complete replacement of Claude's prompt with custom template (supports variable substitution) | No | - |
|
|
| `base_branch` | The base branch to use for creating new branches (e.g., 'main', 'develop') | No | - |
|
|
| `max_turns` | Maximum number of conversation turns Claude can take (limits back-and-forth exchanges) | No | - |
|
|
| `timeout_minutes` | Timeout in minutes for execution | No | `30` |
|
|
| `use_sticky_comment` | Use just one comment to deliver PR comments (only applies for pull_request event workflows) | No | `false` |
|
|
| `github_token` | GitHub token for Claude to operate with. **Only include this if you're connecting a custom GitHub app of your own!** | No | - |
|
|
| `model` | Model to use (provider-specific format required for Bedrock/Vertex) | No | - |
|
|
| `fallback_model` | Enable automatic fallback to specified model when primary model is unavailable | No | - |
|
|
| `anthropic_model` | **DEPRECATED**: Use `model` instead. Kept for backward compatibility. | No | - |
|
|
| `use_bedrock` | Use Amazon Bedrock with OIDC authentication instead of direct Anthropic API | No | `false` |
|
|
| `use_vertex` | Use Google Vertex AI with OIDC authentication instead of direct Anthropic API | No | `false` |
|
|
| `allowed_tools` | Additional tools for Claude to use (the base GitHub tools will always be included) | No | "" |
|
|
| `disallowed_tools` | Tools that Claude should never use | No | "" |
|
|
| `custom_instructions` | Additional custom instructions to include in the prompt for Claude | No | "" |
|
|
| `mcp_config` | Additional MCP configuration (JSON string) that merges with the built-in GitHub MCP servers | No | "" |
|
|
| `assignee_trigger` | The assignee username that triggers the action (e.g. @claude). Only used for issue assignment | No | - |
|
|
| `label_trigger` | The label name that triggers the action when applied to an issue (e.g. "claude") | No | - |
|
|
| `trigger_phrase` | The trigger phrase to look for in comments, issue/PR bodies, and issue titles | No | `@claude` |
|
|
| `branch_prefix` | The prefix to use for Claude branches (defaults to 'claude/', use 'claude-' for dash format) | No | `claude/` |
|
|
| `claude_env` | Custom environment variables to pass to Claude Code execution (YAML format) | No | "" |
|
|
| `settings` | Claude Code settings as JSON string or path to settings JSON file | No | "" |
|
|
| `additional_permissions` | Additional permissions to enable. Currently supports 'actions: read' for viewing workflow results | No | "" |
|
|
| `experimental_allowed_domains` | Restrict network access to these domains only (newline-separated). | No | "" |
|
|
| `use_commit_signing` | Enable commit signing using GitHub's commit signature verification. When false, Claude uses standard git commands | No | `false` |
|
|
|
|
\*Required when using direct Anthropic API (default and when not using Bedrock or Vertex)
|
|
|
|
> **Note**: This action is currently in beta. Features and APIs may change as we continue to improve the integration.
|
|
|
|
## Ways to Tag @claude
|
|
|
|
These examples show how to interact with Claude using comments in PRs and issues. By default, Claude will be triggered anytime you mention `@claude`, but you can customize the exact trigger phrase using the `trigger_phrase` input in the workflow.
|
|
|
|
Claude will see the full PR context, including any comments.
|
|
|
|
### Ask Questions
|
|
|
|
Add a comment to a PR or issue:
|
|
|
|
```
|
|
@claude What does this function do and how could we improve it?
|
|
```
|
|
|
|
Claude will analyze the code and provide a detailed explanation with suggestions.
|
|
|
|
### Request Fixes
|
|
|
|
Ask Claude to implement specific changes:
|
|
|
|
```
|
|
@claude Can you add error handling to this function?
|
|
```
|
|
|
|
### Code Review
|
|
|
|
Get a thorough review:
|
|
|
|
```
|
|
@claude Please review this PR and suggest improvements
|
|
```
|
|
|
|
Claude will analyze the changes and provide feedback.
|
|
|
|
### Fix Bugs from Screenshots
|
|
|
|
Upload a screenshot of a bug and ask Claude to fix it:
|
|
|
|
```
|
|
@claude Here's a screenshot of a bug I'm seeing [upload screenshot]. Can you fix it?
|
|
```
|
|
|
|
Claude can see and analyze images, making it easy to fix visual bugs or UI issues.
|