You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-36Lines changed: 36 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# cagent GitHub Action
2
2
3
-
A GitHub Action for running [cagent](https://github.com/docker/cagent) AI agents in your workflows. This action simplifies the setup and execution of cagent, handling binary downloads and environment configuration automatically.
3
+
A GitHub Action for running [Docker Agent](https://github.com/docker/docker-agent) AI agents in your workflows. This action simplifies the setup and execution of cagent, handling binary downloads and environment configuration automatically.
4
4
5
5
## Quick Start
6
6
@@ -15,7 +15,6 @@ A GitHub Action for running [cagent](https://github.com/docker/cagent) AI agents
15
15
```
16
16
17
17
2. **Configure API key** in your repository settings:
18
-
19
18
- Go to `Settings` → `Secrets and variables` → `Actions`
20
19
- Add `ANTHROPIC_API_KEY` (or another provider's key) from [Anthropic Console](https://console.anthropic.com/)
21
20
@@ -51,11 +50,11 @@ For automated pull request reviews with a multi-agent system, see the [PR Review
51
50
```yaml
52
51
name: PR Review
53
52
on:
54
-
issue_comment: # Enables /review command in PR comments
53
+
issue_comment: # Enables /review command in PR comments
55
54
types: [created]
56
55
pull_request_review_comment: # Captures feedback on review comments for learning
57
56
types: [created]
58
-
pull_request_target: # Triggers auto-review on PR open; uses base branch context so secrets work with forks
57
+
pull_request_target: # Triggers auto-review on PR open; uses base branch context so secrets work with forks
| `mcp-gateway-version` | Version of mcp-gateway to use (specifying this will enable mcp-gateway installation) | No | `v0.22.0` |
145
+
| `anthropic-api-key` | Anthropic API key for Claude models (at least one API key required) | No\* | - |
146
+
| `openai-api-key` | OpenAI API key (at least one API key required) | No\* | - |
147
+
| `google-api-key` | Google API key for Gemini models (at least one API key required) | No\* | - |
148
+
| `aws-bearer-token-bedrock` | AWS Bearer token for Bedrock models (at least one API key required) | No\*| - |
149
+
| `xai-api-key` | xAI API key for Grok models (at least one API key required) | No\* | - |
150
+
| `nebius-api-key` | Nebius API key (at least one API key required) | No\* | - |
151
+
| `mistral-api-key` | Mistral API key (at least one API key required) | No\* | - |
152
+
| `github-token` | GitHub token for API access | No | `github.token` |
153
+
| `github-app-id` | GitHub App ID for custom identity (comments/reviews appear as the app) | No | - |
154
+
| `github-app-private-key` | GitHub App private key (required if `github-app-id` is provided) | No| - |
155
+
| `timeout` | Timeout in seconds for agent execution (0 for no timeout) | No | `0` |
156
+
| `debug` | Enable debug mode with verbose logging (`true`/`false`) | No | `false` |
157
+
| `working-directory` | Working directory to run the agent in | No | `.` |
158
+
| `yolo` | Auto-approve all prompts (`true`/`false`) | No | `true` |
159
+
| `max-retries` | Maximum number of retries on failure (0 = no retries) | No | `2` |
160
+
| `retry-delay` | Base delay in seconds between retries (doubles each attempt) | No | `5` |
161
+
| `extra-args` | Additional arguments to pass to `cagent run` | No | - |
162
+
| `add-prompt-files` | Comma-separated list of files to append to the prompt (e.g., `AGENTS.md,CLAUDE.md`) | No | - |
164
163
165
164
### Prompt Files (`add-prompt-files`)
166
165
@@ -169,6 +168,7 @@ The `add-prompt-files` input allows you to include additional context files as s
169
168
> **Note:** The `review-pr` action automatically reads `AGENTS.md` and `CLAUDE.md` from the repository root — you don't need to specify them via `add-prompt-files`. Use this input for additional files beyond those defaults.
170
169
171
170
**File Resolution (handled by cagent):**
171
+
172
172
- Searches up the directory hierarchy (like `.gitignore`)
173
173
- Also checks the home folder (`~/`)
174
174
- Files are added as system messages, not appended to the user prompt
@@ -201,6 +201,7 @@ add-prompt-files: "STYLE_GUIDE.md" # Found via hierarchy search
201
201
**At least one API key is required.** The action validates this at startup and fails fast with a clear error if no API key is provided.
202
202
203
203
Supported providers:
204
+
204
205
- **Anthropic** (`anthropic-api-key`): Claude models - [Get API key](https://console.anthropic.com/)
205
206
- **OpenAI** (`openai-api-key`): GPT models - [Get API key](https://platform.openai.com/)
206
207
- **Google** (`google-api-key`): Gemini models - [Get API key](https://aistudio.google.com/)
@@ -218,10 +219,9 @@ permissions:
218
219
contents: read
219
220
pull-requests: write
220
221
issues: write
221
-
checks: write # Optional: show review progress as a check run on PRs
222
+
checks: write # Optional: show review progress as a check run on PRs
222
223
```
223
224
224
-
225
225
## Examples
226
226
227
227
### Multiple Agents in a Workflow
@@ -314,5 +314,5 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS
Copy file name to clipboardExpand all lines: review-pr/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ The workflow automatically handles:
61
61
62
62
## Running Locally
63
63
64
-
Requires [cagent](https://github.com/docker/cagent) installed locally. The reviewer agent automatically detects its environment. When running locally, it diffs your current branch against the base branch and outputs findings to the console.
64
+
Requires [Docker Agent](https://github.com/docker/docker-agent›) installed locally. The reviewer agent automatically detects its environment. When running locally, it diffs your current branch against the base branch and outputs findings to the console.
0 commit comments