🤖 Add GitHub Copilot CLI support (#1017)

* Copilot CLI support

* Copilot CLI support

* Copilot CLI support

* fix tests

* transfer fixes

* transfer fixes

* changes

* changes

* changes

* fix build

* fix build

* fix build

* fix build

* fix build

Author: dsyme

.github/instructions/github-agentic-workflows.instructions.md

@@ -5,7 +5,7 @@ on:
   push:
     branches:
       - copilot/*
-engine: claude
+engine: copilot
 safe-outputs:
     staged: true
 safe-jobs:

.github/workflows/dev.lock.yml

@@ -20,8 +20,8 @@ var verbose bool
 
 // validateEngine validates the engine flag value
 func validateEngine(engine string) error {
-	if engine != "" && engine != "claude" && engine != "codex" {
-		return fmt.Errorf("invalid engine value '%s'. Must be 'claude' or 'codex'", engine)
+	if engine != "" && engine != "claude" && engine != "codex" && engine != "copilot" {
+		return fmt.Errorf("invalid engine value '%s'. Must be 'claude', 'codex', or 'copilot'", engine)
 	}
 	return nil
 }
@@ -285,7 +285,7 @@ func init() {
 	uninstallCmd.Flags().BoolP("local", "l", false, "Uninstall packages from local .aw/packages instead of global ~/.aw/packages")
 
 	// Add AI flag to compile and add commands
-	compileCmd.Flags().StringP("engine", "a", "", "Override AI engine (claude, codex)")
+	compileCmd.Flags().StringP("engine", "a", "", "Override AI engine (claude, codex, copilot)")
 	compileCmd.Flags().Bool("validate", true, "Enable GitHub Actions workflow schema validation (default: true)")
 	compileCmd.Flags().BoolP("watch", "w", false, "Watch for changes to workflow files and recompile automatically")
 	compileCmd.Flags().String("workflows-dir", "", "Relative directory containing workflows (default: .github/workflows)")

.github/workflows/dev.md

@@ -33,6 +33,11 @@ func TestValidateEngine(t *testing.T) {
 			engine:    "codex",
 			expectErr: false,
 		},
+		{
+			name:      "valid copilot engine",
+			engine:    "copilot",
+			expectErr: false,
+		},
 		{
 			name:       "invalid engine",
 			engine:     "gpt4",
@@ -75,7 +80,7 @@ func TestValidateEngine(t *testing.T) {
 					return
 				}
 
-				if tt.errMessage != "" && err.Error() != fmt.Sprintf("invalid engine value '%s'. Must be 'claude' or 'codex'", tt.engine) {
+				if tt.errMessage != "" && err.Error() != fmt.Sprintf("invalid engine value '%s'. Must be 'claude', 'codex', or 'copilot'", tt.engine) {
 					t.Errorf("validateEngine(%q) error message = %v, want to contain %v", tt.engine, err.Error(), tt.errMessage)
 				}
 			} else {

cmd/gh-aw/main.go

@@ -7,9 +7,9 @@ sidebar:
 
 GitHub Agentic Workflows support multiple AI engines to interpret and execute natural language instructions. Each engine has unique capabilities and configuration options.
 
-## Available Engines
+## Agentic Engines
 
-### Claude (Default)
+### Anthropic Claude Code (Default)
 
 Claude Code is the default and recommended AI engine for most workflows. It excels at reasoning, code analysis, and understanding complex contexts.
 
@@ -29,13 +29,23 @@ engine:
     DEBUG_MODE: "true"
 ```
 
-**Features:**
-- Excellent reasoning and code analysis capabilities
-- Supports max-turns for cost control
-- Uses MCP servers for tool integration
-- Generates `mcp-servers.json` configuration
+#### Secrets
+
+- `ANTHROPIC_API_KEY` secret is required for authentication.
+
+### GitHub Copilot (Experimental)
 
-### Codex (Experimental)
+[GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli) 
+
+```yaml
+engine: copilot
+```
+
+#### Secrets
+
+- `COPILOT_CLI_TOKEN ` secret is required for authentication.
+
+### OpenAI Codex (Experimental)
 
 OpenAI Codex CLI with MCP server support. Designed for code-focused tasks and integration scenarios.
 
@@ -72,6 +82,10 @@ engine:
 - **`user-agent`** (optional): Custom user agent string for GitHub MCP server configuration
 - **`config`** (optional): Additional TOML configuration text appended to generated config.toml
 
+#### Secrets
+
+- `OPENAI_API_KEY` secret is required for authentication.
+
 ### Custom Engine
 
 For advanced users who want to define completely custom GitHub Actions steps instead of using AI interpretation.

cmd/gh-aw/main_entry_test.go

@@ -232,6 +232,7 @@ gh aw logs --start-date -1mo         # Last month's runs
 # Filter by AI engine type
 gh aw logs --engine claude           # Only Claude workflows
 gh aw logs --engine codex            # Only Codex workflows
+gh aw logs --engine copilot          # Only Copilot workflows
 
 # Filter by branch name
 gh aw logs --branch main             # Only runs from main branch

docs/src/content/docs/reference/engines.md

@@ -85,7 +85,7 @@ It's a shortcut for:
 	cmd.Flags().StringP("name", "n", "", "Specify name for the added workflow (without .md extension)")
 
 	// Add AI flag to add command
-	cmd.Flags().StringP("engine", "a", "", "Override AI engine (claude, codex)")
+	cmd.Flags().StringP("engine", "a", "", "Override AI engine (claude, codex, copilot, custom)")
 
 	// Add repository flag to add command
 	cmd.Flags().StringP("repo", "r", "", "Install and use workflows from specified repository (org/repo)")

docs/src/content/docs/tools/cli.md

@@ -127,6 +127,7 @@ func (b *InteractiveWorkflowBuilder) promptForTrigger() error {
 // promptForEngine asks the user to select the AI engine
 func (b *InteractiveWorkflowBuilder) promptForEngine() error {
 	engineOptions := []huh.Option[string]{
+		huh.NewOption("copilot - GitHub Copilot CLI", "copilot"),
 		huh.NewOption("claude - Anthropic Claude Code coding agent", "claude"),
 		huh.NewOption("codex - OpenAI Codex engine", "codex"),
 		huh.NewOption("custom - Custom engine configuration", "custom"),

pkg/cli/add_command.go

@@ -159,6 +159,8 @@ Examples:
   ` + constants.CLIExtensionPrefix + ` logs --start-date -1mo         # Filter runs from last month
   ` + constants.CLIExtensionPrefix + ` logs --engine claude           # Filter logs by claude engine
   ` + constants.CLIExtensionPrefix + ` logs --engine codex            # Filter logs by codex engine
+  ` + constants.CLIExtensionPrefix + ` logs --engine copilot          # Filter logs by copilot engine
+  ` + constants.CLIExtensionPrefix + ` logs -o ./my-logs              # Custom output directory
   ` + constants.CLIExtensionPrefix + ` logs --branch main             # Filter logs by branch name
   ` + constants.CLIExtensionPrefix + ` logs --branch feature-xyz      # Filter logs by feature branch
   ` + constants.CLIExtensionPrefix + ` logs --after-run-id 1000       # Filter runs after run ID 1000
@@ -257,7 +259,7 @@ Examples:
 	logsCmd.Flags().String("start-date", "", "Filter runs created after this date (YYYY-MM-DD or delta like -1d, -1w, -1mo)")
 	logsCmd.Flags().String("end-date", "", "Filter runs created before this date (YYYY-MM-DD or delta like -1d, -1w, -1mo)")
 	logsCmd.Flags().StringP("output", "o", "./logs", "Output directory for downloaded logs and artifacts")
-	logsCmd.Flags().String("engine", "", "Filter logs by agentic engine type (claude, codex)")
+	logsCmd.Flags().String("engine", "", "Filter logs by agentic engine type (claude, codex, copilot)")
 	logsCmd.Flags().String("branch", "", "Filter runs by branch name (e.g., main, feature-branch)")
 	logsCmd.Flags().Int64("before-run-id", 0, "Filter runs with database ID before this value (exclusive)")
 	logsCmd.Flags().Int64("after-run-id", 0, "Filter runs with database ID after this value (exclusive)")
@@ -357,7 +359,7 @@ func DownloadWorkflowLogs(workflowName string, count int, startDate, endDate, ou
 				if detectedEngine != nil {
 					// Get the engine ID to compare with the filter
 					registry := workflow.GetGlobalEngineRegistry()
-					for _, supportedEngine := range []string{"claude", "codex"} {
+					for _, supportedEngine := range constants.AgenticEngines {
 						if testEngine, err := registry.GetEngine(supportedEngine); err == nil && testEngine == detectedEngine {
 							engineMatches = (supportedEngine == engine)
 							break
@@ -371,7 +373,7 @@ func DownloadWorkflowLogs(workflowName string, count int, startDate, endDate, ou
 						if detectedEngine != nil {
 							// Try to get a readable name for the detected engine
 							registry := workflow.GetGlobalEngineRegistry()
-							for _, supportedEngine := range []string{"claude", "codex"} {
+							for _, supportedEngine := range constants.AgenticEngines {
 								if testEngine, err := registry.GetEngine(supportedEngine); err == nil && testEngine == detectedEngine {
 									engineName = supportedEngine
 									break