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: docs/src/content/docs/reference/engines.md
+14-89Lines changed: 14 additions & 89 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,17 +34,17 @@ The Copilot engine does not have built-in `web-search` support. You can add web
34
34
**Environment Variables:**
35
35
- **`COPILOT_MODEL`**: Alternative way to set the model (e.g., `gpt-5`)
36
36
37
-
#### Secrets
37
+
**Secrets:**
38
38
39
-
- `COPILOT_CLI_TOKEN`secret is required for authentication.
39
+
- **`COPILOT_CLI_TOKEN`** secret is required for authentication.
40
40
41
41
Please [create a GitHub Personal Access Token (PAT) for an account with a GitHub Copilot subscription](https://github.com/settings/tokens) and add this as a repository secret:
42
42
43
43
```bash
44
44
gh secret set COPILOT_CLI_TOKEN -a actions --body "<your-github-pat>"
45
45
```
46
46
47
-
- `GITHUB_MCP_TOKEN`secret (optional) is required when using remote mode for GitHub tools.
47
+
- **`GITHUB_MCP_TOKEN`** secret (optional) is required when using remote mode for GitHub tools.
48
48
49
49
If you use `mode: remote` for GitHub tools (for faster startup without Docker), you'll need a separate GitHub Personal Access Token:
50
50
@@ -74,17 +74,17 @@ engine:
74
74
DEBUG_MODE: "true"
75
75
```
76
76
77
-
#### Secrets
77
+
**Secrets:**
78
78
79
-
- `ANTHROPIC_API_KEY`secret is required for authentication.
79
+
- **`ANTHROPIC_API_KEY`** secret is required for authentication.
80
80
81
81
Use this to set the secret for your repo:
82
82
83
83
```bash
84
84
gh secret set ANTHROPIC_API_KEY -a actions --body "<your-anthropic-api-key>"
85
85
```
86
86
87
-
- `GITHUB_MCP_TOKEN`secret (optional) is required when using remote mode for GitHub tools.
87
+
- **`GITHUB_MCP_TOKEN`** secret (optional) is required when using remote mode for GitHub tools.
88
88
89
89
If you use `mode: remote` for GitHub tools (for faster startup without Docker), you'll need a GitHub Personal Access Token:
90
90
@@ -120,27 +120,22 @@ engine:
120
120
retries = 3
121
121
```
122
122
123
-
**Features:**
124
-
- Code-focused AI engine
125
-
- Generates `config.toml` for MCP server configuration
126
-
- Supports custom TOML configuration via `config` field
127
-
- Configurable user agent for GitHub MCP server
128
-
- Requires `CODEX_API_KEY` or `OPENAI_API_KEY` secret
129
-
130
123
**Codex-specific fields:**
131
124
- **`user-agent`** (optional): Custom user agent string for GitHub MCP server configuration
132
125
- **`config`** (optional): Additional TOML configuration text appended to generated config.toml
133
126
134
-
#### Secrets
127
+
**Secrets:**
135
128
136
-
- `OPENAI_API_KEY`secret is required for authentication.
129
+
- **`OPENAI_API_KEY`** secret is required for authentication.
137
130
138
131
Use this to set the secret for your repo:
139
132
140
133
```bash
141
134
gh secret set OPENAI_API_KEY -a actions --body "<your-openai-api-key>"
142
135
```
143
136
137
+
The Codex engine supports additional customization through the `config` field, which allows you to append raw TOML configuration to the generated `config.toml` file.
138
+
144
139
### Custom Engine
145
140
146
141
For advanced users who want to define completely custom GitHub Actions steps instead of using AI interpretation.
@@ -163,9 +158,7 @@ engine:
163
158
- No AI interpretation - direct step execution
164
159
- Useful for deterministic workflows or hybrid approaches
165
160
166
-
## Engine-Specific Configuration
167
-
168
-
### Environment Variables
161
+
## Engine Environment Variables
169
162
170
163
All engines support custom environment variables through the `env` field:
171
164
@@ -178,15 +171,9 @@ engine:
178
171
CUSTOM_API_ENDPOINT: https://api.example.com
179
172
```
180
173
181
-
**Common use cases:**
182
-
- Override default API keys (e.g., `OPENAI_API_KEY` for Codex)
183
-
- Set region-specific configuration
184
-
- Enable debug modes
185
-
- Configure custom endpoints
186
-
187
-
### Error Patterns
174
+
## Engine Error Patterns
188
175
189
-
Claude, Copilot, and Codex engines support custom error pattern recognition for enhanced log validation:
176
+
All engines support custom error pattern recognition for enhanced log validation:
190
177
191
178
```yaml
192
179
engine:
@@ -198,68 +185,6 @@ engine:
198
185
description: "Custom error format with timestamp"
199
186
```
200
187
201
-
## Codex Engine Advanced Configuration
202
-
203
-
The Codex engine supports additional customization through the `config` field, which allows you to append raw TOML configuration to the generated `config.toml` file.
204
-
205
-
### Custom Configuration Example
206
-
207
-
```yaml
208
-
engine:
209
-
id: codex
210
-
config: |
211
-
# Custom logging configuration
212
-
[logging]
213
-
level = "debug"
214
-
file = "/tmp/gh-aw/codex-debug.log"
215
-
216
-
# Server timeout settings
217
-
[server]
218
-
timeout = 120
219
-
max_connections = 10
220
-
221
-
# Custom tool configurations
222
-
[tools.custom_analyzer]
223
-
enabled = true
224
-
mode = "strict"
225
-
```
226
-
227
-
### Generated Output
228
-
229
-
This configuration generates a `config.toml` file with the structure:
1. **Validate TOML**: Ensure your configuration is valid TOML syntax
258
-
2. **Avoid conflicts**: Don't override standard sections like `[history]` or `[mcp_servers.*]`
259
-
3. **Use descriptive sections**: Name your configuration sections clearly
260
-
4. **Document purpose**: Include comments in your TOML to explain custom settings
261
-
5. **Test thoroughly**: Validate that your custom configuration works as expected
262
-
263
188
## Migration Between Engines
264
189
265
190
Switching between engines is straightforward - just change the `engine` field in your frontmatter:
@@ -280,7 +205,7 @@ engine:
280
205
version: latest
281
206
```
282
207
283
-
Note that engine-specific features (like `config` for Codex, `max-turns` for Claude, or `model` for Copilot) may not be available when switching engines.
208
+
Note that engine-specific features may not be available when switching engines.
0 commit comments