⚠️ 这是一个镜像仓库

本仓库是 anthropics/claude-code-action 中 base-action 目录的自动镜像。

请勿在此仓库提交 PR 或 issue。 请向主仓库贡献：

• 🐛 报告问题
• 🔧 提交拉取请求
• 📖 查看文档

---

Claude Code Base Action

这个 GitHub Action（GitHub 操作）允许你在 GitHub Actions 工作流中运行 Claude Code。你可以使用它来构建任何基于 Claude Code 的自定义工作流。

对于开箱即用地在 issue 和 PR 中 @claude，请查看 Claude Code action 和 GitHub 应用。

使用方法

将以下内容添加到你的工作流文件中：

# Using a direct prompt
- name: Run Claude Code with direct prompt
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Or using a prompt from a file
- name: Run Claude Code with prompt file
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt_file: "/path/to/prompt.txt"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Or limiting the conversation turns
- name: Run Claude Code with limited turns
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    max_turns: "5" # Limit conversation to 5 turns
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Using custom system prompts
- name: Run Claude Code with custom system prompt
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Build a REST API"
    system_prompt: "You are a senior backend engineer. Focus on security, performance, and maintainability."
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Or appending to the default system prompt
- name: Run Claude Code with appended system prompt
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Create a database schema"
    append_system_prompt: "After writing code, be sure to code review yourself."
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Using custom environment variables
- name: Run Claude Code with custom environment variables
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Deploy to staging environment"
    claude_env: |
      ENVIRONMENT: staging
      API_URL: https://api-staging.example.com
      DEBUG: true
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Using fallback model for handling API errors
- name: Run Claude Code with fallback model
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Review and fix TypeScript errors"
    model: "claude-opus-4-1-20250805"
    fallback_model: "claude-sonnet-4-20250514"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

# Using OAuth token instead of API key
- name: Run Claude Code with OAuth token
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Update dependencies"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}

输入参数

输入参数	描述	必填	默认值
prompt	发送给Claude Code的提示词	否*	''
prompt_file	包含提示词的文件路径	否*	''
allowed_tools	允许Claude Code使用的工具列表（逗号分隔）	否	''
disallowed_tools	Claude Code不能使用的禁用工具列表（逗号分隔）	否	''
max_turns	最大对话轮数（默认：无限制）	否	''
mcp_config	MCP配置文件路径，或MCP配置JSON字符串	否	''
settings	Claude Code设置JSON文件路径，或设置JSON字符串	否	''
system_prompt	覆盖系统提示词	否	''
append_system_prompt	追加到系统提示词	否	''
claude_env	传递给Claude Code执行的自定义环境变量（YAML多行格式）	否	''
model	要使用的模型（Bedrock/Vertex需要特定提供商格式）	否	'claude-4-0-sonnet-20250219'
anthropic_model	已弃用：请使用'model'代替	否	'claude-4-0-sonnet-20250219'
fallback_model	当默认模型过载时自动回退到指定模型	否	''
anthropic_api_key	Anthropic API密钥（直连Anthropic API时需要）	否	''
claude_code_oauth_token	Claude Code OAuth令牌（anthropic_api_key的替代方案）	否	''
use_bedrock	使用Amazon Bedrock配合OIDC认证，而非直连Anthropic API	否	'false'
use_vertex	使用Google Vertex AI配合OIDC认证，而非直连Anthropic API	否	'false'
use_node_cache	是否使用Node.js依赖缓存（仅当Node.js项目包含锁定文件时设为true）	否	'false'
show_full_output	显示完整JSON输出（⚠️可能泄露机密信息 - 参见安全文档）	否	'false'**

*必须提供prompt或prompt_file之一，但不能同时提供。

**当GitHub Actions调试模式激活时，show_full_output会自动启用。重要的安全注意事项请参见安全文档。

输出参数

输出参数	描述
conclusion	Claude Code的执行状态（'success'或'failure'）
execution_file	包含Claude Code执行日志的JSON文件路径

环境变量

以下环境变量可用于配置此Action：

变量名	描述	默认值
NODE_VERSION	要使用的Node.js版本（例如'18.x'、'20.x'、'22.x'）	'18.x'

使用示例：

- name: Run Claude Code with Node.js 20
  uses: anthropics/claude-code-base-action@beta
  env:
    NODE_VERSION: "20.x"
  with:
    prompt: "Your prompt here"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

自定义环境变量

您可以使用claude_env输入参数将自定义环境变量传递给Claude Code执行。这使得Claude在执行期间能够访问特定环境的配置。

claude_env输入参数接受YAML多行格式的键值对：

- name: Deploy with custom environment
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Deploy the application to the staging environment"
    claude_env: |
      ENVIRONMENT: staging
      API_BASE_URL: https://api-staging.example.com
      DATABASE_URL: ${{ secrets.STAGING_DB_URL }}
      DEBUG: true
      LOG_LEVEL: debug
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

特性：

• YAML格式：使用标准YAML键值语法（KEY: value）
• 多行支持：在单个输入中定义多个环境变量
• 注释：以#开头的行将被忽略
• GitHub Secrets：可以使用${{ secrets.SECRET_NAME }}引用GitHub机密
• 运行时访问：环境变量在执行期间对Claude可用

使用示例：

# Development configuration
claude_env: |
  NODE_ENV: development
  API_URL: http://localhost:3000
  DEBUG: true

# Production deployment
claude_env: |
  NODE_ENV: production
  API_URL: https://api.example.com
  DATABASE_URL: ${{ secrets.PROD_DB_URL }}
  REDIS_URL: ${{ secrets.REDIS_URL }}

# Feature flags and configuration
claude_env: |
  FEATURE_NEW_UI: enabled
  MAX_RETRIES: 3
  TIMEOUT_MS: 5000

使用设置配置

您可以通过两种方式提供 Claude Code 设置配置：

选项 1：设置配置文件

提供包含 Claude Code 设置的 JSON 文件路径：

- name: Run Claude Code with settings file
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    settings: "path/to/settings.json"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

选项 2：内联设置配置

直接以 JSON 字符串形式提供设置配置：

- name: Run Claude Code with inline settings
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    settings: |
      {
        "model": "claude-opus-4-1-20250805",
        "env": {
          "DEBUG": "true",
          "API_URL": "https://api.example.com"
        },
        "permissions": {
          "allow": ["Bash", "Read"],
          "deny": ["WebFetch"]
        },
        "hooks": {
          "PreToolUse": [{
            "matcher": "Bash",
            "hooks": [{
              "type": "command",
              "command": "echo Running bash command..."
            }]
          }]
        }
      }
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

设置文件支持所有 Claude Code 设置选项，包括：

• model（模型）：覆盖默认模型
• env（环境变量）：会话的环境变量
• permissions（权限）：工具使用权限
• hooks（钩子）：工具执行前/后的钩子
• includeCoAuthoredBy（包含共同作者）：在 git 提交中包含共同作者信息
• 以及更多...

注意：此操作始终将 enableAllProjectMcpServers 设置设为 true，以确保 MCP（Model Context Protocol，模型上下文协议）服务器正常工作。

使用 MCP 配置

您可以通过两种方式提供 MCP 配置：

选项 1：MCP 配置文件

提供包含 MCP 配置的 JSON 文件路径：

- name: Run Claude Code with MCP config file
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    mcp_config: "path/to/mcp-config.json"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

选项 2：内联 MCP 配置

直接以 JSON 字符串形式提供 MCP 配置：

- name: Run Claude Code with inline MCP config
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    mcp_config: |
      {
        "mcpServers": {
          "server-name": {
            "command": "node",
            "args": ["./server.js"],
            "env": {
              "API_KEY": "your-api-key"
            }
          }
        }
      }
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

MCP 配置文件应遵循以下格式：

{
  "mcpServers": {
    "server-name": {
      "command": "node",
      "args": ["./server.js"],
      "env": {
        "API_KEY": "your-api-key"
      }
    }
  }
}

您可以将 MCP 配置与其他输入（如允许的工具）结合使用：

# Using multiple inputs together
- name: Run Claude Code with MCP and custom tools
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Access the custom MCP server and use its tools"
    mcp_config: "mcp-config.json"
    allowed_tools: "Bash(git:*),View,mcp__server-name__custom_tool"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

示例：PR 代码审查

name: Claude Code Review

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  code-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Run Code Review with Claude
        id: code-review
        uses: anthropics/claude-code-base-action@beta
        with:
          prompt: "Review the PR changes. Focus on code quality, potential bugs, and performance issues. Suggest improvements where appropriate. Write your review as markdown text."
          allowed_tools: "Bash(git diff --name-only HEAD~1),Bash(git diff HEAD~1),View,GlobTool,GrepTool,Write"
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

      - name: Extract and Comment PR Review
        if: steps.code-review.outputs.conclusion == 'success'
        uses: actions/github-script@v7
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const fs = require('fs');
            const executionFile = '${{ steps.code-review.outputs.execution_file }}';
            const executionLog = JSON.parse(fs.readFileSync(executionFile, 'utf8'));

            // Extract the review content from the execution log
            // The execution log contains the full conversation including Claude's responses
            let review = '';

            // Find the last assistant message which should contain the review
            for (let i = executionLog.length - 1; i >= 0; i--) {
              if (executionLog[i].role === 'assistant') {
                review = executionLog[i].content;
                break;
              }
            }

            if (review) {
              github.rest.issues.createComment({
                issue_number: context.issue.number,
                owner: context.repo.owner,
                repo: context.repo.repo,
                body: "## Claude Code Review\n\n" + review + "\n\n*Generated by Claude Code*"
              });
            }

查看 ./examples 中的更多示例。

使用云提供商

您可以通过以下任一方式对 Claude 进行身份验证：

1. 直接 Anthropic API（默认）- 需要 API 密钥或 OAuth 令牌
2. Amazon Bedrock - 需要 OIDC（OpenID Connect，开放身份认证）身份认证，并自动使用跨区域推理配置文件
3. Google Vertex AI - 需要 OIDC 身份认证

注意：

• Bedrock 和 Vertex 仅使用 OIDC 身份认证
• AWS Bedrock 自动为某些模型使用跨区域推理配置文件
• 对于跨区域推理配置文件模型，您需要申请并获得推理配置文件所使用的所有区域中的 Claude 模型访问权限
• Bedrock API 端点 URL 使用 AWS_REGION 环境变量自动构建（例如 https://bedrock-runtime.us-west-2.amazonaws.com）
• 您可以通过设置 ANTHROPIC_BEDROCK_BASE_URL 环境变量来覆盖 Bedrock API 端点 URL

模型配置

根据您选择的提供商使用特定的模型名称：

# For direct Anthropic API (default)
- name: Run Claude Code with Anthropic API
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    model: "claude-3-7-sonnet-20250219"
    anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

对于 Amazon Bedrock（需要 OIDC 认证）

• name: Configure AWS Credentials (OIDC) uses: aws-actions/configure-aws-credentials@v4 with: role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }} aws-region: us-west-2

• name: Run Claude Code with Bedrock uses: anthropics/claude-code-base-action@beta with: prompt: "Your prompt here" model: "anthropic.claude-3-7-sonnet-20250219-v1:0" use_bedrock: "true"

对于 Google Vertex AI（需要 OIDC 认证）

• name: Authenticate to Google Cloud uses: google-github-actions/auth@v2 with: workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }} service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}

• name: Run Claude Code with Vertex AI uses: anthropics/claude-code-base-action@beta with: prompt: "Your prompt here" model: "claude-3-7-sonnet@20250219" use_vertex: "true"

## 示例：将 OIDC 认证用于 AWS Bedrock

此示例展示了如何将 OIDC 认证与 AWS Bedrock 结合使用：

```yaml
- name: Configure AWS Credentials (OIDC)
  uses: aws-actions/configure-aws-credentials@v4
  with:
    role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
    aws-region: us-west-2

- name: Run Claude Code with AWS OIDC
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    use_bedrock: "true"
    model: "anthropic.claude-3-7-sonnet-20250219-v1:0"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"

示例：将 OIDC 认证用于 GCP Vertex AI

此示例展示了如何将 OIDC 认证与 GCP Vertex AI 结合使用：

- name: Authenticate to Google Cloud
  uses: google-github-actions/auth@v2
  with:
    workload_identity_provider: ${{ secrets.GCP_WORKLOAD_IDENTITY_PROVIDER }}
    service_account: ${{ secrets.GCP_SERVICE_ACCOUNT }}

- name: Run Claude Code with GCP OIDC
  uses: anthropics/claude-code-base-action@beta
  with:
    prompt: "Your prompt here"
    use_vertex: "true"
    model: "claude-3-7-sonnet@20250219"
    allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"

安全最佳实践

⚠️ 重要提示：切勿将 API 密钥直接提交到您的仓库中！请始终使用 GitHub Actions secrets。

要安全地使用您的 Anthropic API 密钥：

1. 将您的 API 密钥添加为仓库 secret：

   • 进入您的仓库设置
   • 导航至 "Secrets and variables" → "Actions"
   • 点击 "New repository secret"
   • 将其命名为 ANTHROPIC_API_KEY
   • 将您的 API 密钥粘贴为值

2. 在您的工作流中引用该 secret：

   anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
   

切勿这样做：

# ❌ 错误 - 会暴露您的 API 密钥
anthropic_api_key: "sk-ant-..."

请始终这样做：

# ✅ 正确 - 使用 GitHub secrets
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

这适用于所有敏感值，包括 API 密钥、访问令牌和凭据。 我们还建议您在可能的情况下始终使用短期令牌。

许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件。

Claude Code Base Action 快速上手指南

环境准备

• GitHub 仓库：需要有一个 GitHub 仓库来运行 Actions
• 访问权限：确保 GitHub Actions 已启用
• API 凭证（二选一）：
  • Anthropic API 密钥：从 Anthropic Console 获取
  • Claude Code OAuth Token：如果使用 OAuth 方式
• 可选：Amazon Bedrock 或 Google Vertex AI 账号（如需使用 OIDC 认证）

安装步骤

1. 配置 API 密钥

在 GitHub 仓库中设置 Secret：

1. 进入仓库 Settings > Secrets and variables > Actions
2. 点击 New repository secret
3. 添加以下 Secret：

# 方式一：使用 Anthropic API 密钥
Name: ANTHROPIC_API_KEY
Value: 你的_api_key_here

# 方式二：使用 OAuth Token
Name: CLAUDE_CODE_OAUTH_TOKEN
Value: 你的_oauth_token_here

2. 创建工作流文件

在仓库中创建 .github/workflows/claude-code.yml：

name: Claude Code 示例
on: [workflow_dispatch]  # 手动触发

jobs:
  claude-job:
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v4
        
      - name: 运行 Claude Code
        uses: anthropics/claude-code-base-action@beta
        with:
          prompt: "你的提示词在这里"
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

基本使用

最简单示例

以下是一个完整的最小化工作流配置：

name: 基础示例
on:
  workflow_dispatch:
    inputs:
      prompt:
        description: '输入提示词'
        required: true
        default: '查看当前目录结构'

jobs:
  run-claude:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: 运行 Claude Code
        uses: anthropics/claude-code-base-action@beta
        with:
          prompt: ${{ github.event.inputs.prompt }}
          allowed_tools: "Bash(git:*),View,GlobTool,GrepTool,BatchTool"
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

关键参数说明

• prompt：直接输入提示词
• prompt_file：从文件读取提示词（与 prompt 二选一）
• allowed_tools：允许使用的工具列表（建议始终设置）
• anthropic_api_key：API 密钥引用
• max_turns：限制对话轮数（可选）

运行工作流

1. 提交工作流文件到仓库
2. 进入 GitHub 仓库的 Actions 标签页
3. 选择工作流并点击 Run workflow
4. 查看执行结果

---

注意：本仓库为镜像仓库，如需反馈问题或提交 PR，请访问主仓库。