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
+8-8Lines changed: 8 additions & 8 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 [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.
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 Docker Agent, handling binary downloads and environment configuration automatically.
4
4
5
5
## Quick Start
6
6
@@ -19,7 +19,7 @@ A GitHub Action for running [Docker Agent](https://github.com/docker/docker-agen
19
19
- Add `ANTHROPIC_API_KEY` (or another provider's key) from [Anthropic Console](https://console.anthropic.com/)
20
20
21
21
3. **That's it!** The action will automatically:
22
-
- Download the cagent binary
22
+
- Download the Docker Agent binary
23
23
- Run your specified agent
24
24
- Scan outputs for leaked secrets
25
25
- Provide results in workflow logs
@@ -92,7 +92,7 @@ See the [full PR Review documentation](review-pr/README.md) for more details.
92
92
### Advanced Configuration
93
93
94
94
```yaml
95
-
- name: Run cagent with Custom Settings
95
+
- name: Run Docker Agent with Custom Settings
96
96
uses: docker/cagent-action@latest
97
97
with:
98
98
agent: docker/code-analyzer
@@ -111,7 +111,7 @@ See the [full PR Review documentation](review-pr/README.md) for more details.
111
111
### Using Outputs
112
112
113
113
```yaml
114
-
- name: Run cagent
114
+
- name: Run Docker Agent
115
115
id: agent
116
116
uses: docker/cagent-action@latest
117
117
with:
@@ -158,16 +158,16 @@ See the [full PR Review documentation](review-pr/README.md) for more details.
158
158
| `yolo` | Auto-approve all prompts (`true`/`false`) | No | `true` |
159
159
| `max-retries` | Maximum number of retries on failure (0 = no retries) | No | `2` |
160
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 | - |
161
+
| `extra-args` | Additional arguments to pass to `docker agent run` | No | - |
162
162
| `add-prompt-files` | Comma-separated list of files to append to the prompt (e.g., `AGENTS.md,CLAUDE.md`) | No | - |
163
163
164
164
### Prompt Files (`add-prompt-files`)
165
165
166
-
The `add-prompt-files` input allows you to include additional context files as system messages. This uses cagent's `--prompt-file` flag under the hood.
166
+
The `add-prompt-files` input allows you to include additional context files as system messages. This uses Docker Agent's `--prompt-file` flag under the hood.
167
167
168
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.
169
169
170
-
**File Resolution (handled by cagent):**
170
+
**File Resolution (handled by Docker Agent):**
171
171
172
172
- Searches up the directory hierarchy (like `.gitignore`)
173
173
- Also checks the home folder (`~/`)
@@ -188,7 +188,7 @@ add-prompt-files: "STYLE_GUIDE.md" # Found via hierarchy search
0 commit comments