Standardize CLI workflow identifier terminology to "workflow-id" (#3867)

Author: Copilot

cmd/gh-aw/main.go

@@ -34,7 +34,11 @@ var rootCmd = &cobra.Command{
 
 A natural language GitHub Action is a Markdown file checked into the .github/workflows directory of a repository.
 The file contains a natural language description of the workflow, which is then compiled into a GitHub Actions workflow file.
-The workflow file is then executed by GitHub Actions in response to events in the repository.`,
+The workflow file is then executed by GitHub Actions in response to events in the repository.
+
+Note: A workflow-id is the basename of the markdown file without the .md extension.
+For example, for 'weekly-research.md', the workflow-id is 'weekly-research'.
+This is different from the optional 'name' field in the workflow frontmatter, which sets the display name in GitHub Actions UI.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		_ = cmd.Help()
 	},
@@ -84,9 +88,9 @@ var removeCmd = &cobra.Command{
 }
 
 var enableCmd = &cobra.Command{
-	Use:   "enable [workflow-name]...",
+	Use:   "enable [workflow-id]...",
 	Short: "Enable agentic workflows",
-	Long: `Enable one or more workflows by name, or all workflows if no names are provided.
+	Long: `Enable one or more workflows by ID, or all workflows if no IDs are provided.
 
 Examples:
   ` + constants.CLIExtensionPrefix + ` enable                    # Enable all workflows
@@ -101,9 +105,9 @@ Examples:
 }
 
 var disableCmd = &cobra.Command{
-	Use:   "disable [workflow-name]...",
+	Use:   "disable [workflow-id]...",
 	Short: "Disable agentic workflows and cancel any in-progress runs",
-	Long: `Disable one or more workflows by name, or all workflows if no names are provided.
+	Long: `Disable one or more workflows by ID, or all workflows if no IDs are provided.
 
 Examples:
   ` + constants.CLIExtensionPrefix + ` disable                    # Disable all workflows
@@ -192,11 +196,11 @@ Examples:
 }
 
 var runCmd = &cobra.Command{
-	Use:   "run <workflow-id-or-name>...",
+	Use:   "run <workflow-id>...",
 	Short: "Run one or more agentic workflows on GitHub Actions",
 	Long: `Run one or more agentic workflows on GitHub Actions using the workflow_dispatch trigger.
 
-This command accepts one or more workflow IDs or agentic workflow names.
+This command accepts one or more workflow IDs.
 The workflows must have been added as actions and compiled.
 
 This command only works with workflows that have workflow_dispatch triggers.

pkg/cli/logs.go

@@ -298,7 +298,7 @@ const (
 // NewLogsCommand creates the logs command
 func NewLogsCommand() *cobra.Command {
 	logsCmd := &cobra.Command{
-		Use:   "logs [agentic-workflow-id]",
+		Use:   "logs [workflow-id]",
 		Short: "Download and analyze agentic workflow logs with aggregated metrics",
 		Long: `Download workflow run logs and artifacts from GitHub Actions for agentic workflows.
 
@@ -314,12 +314,12 @@ Downloaded artifacts include:
 - aw.patch: Git patch of changes made during execution
 - workflow-logs/: GitHub Actions workflow run logs (job logs organized in subdirectory)
 
-The agentic-workflow-id is the basename of the markdown file without the .md extension.
+The workflow-id is the basename of the markdown file without the .md extension.
 For example, for 'weekly-research.md', use 'weekly-research' as the workflow ID.
 
 Examples:
   ` + constants.CLIExtensionPrefix + ` logs                           # Download logs for all workflows
-  ` + constants.CLIExtensionPrefix + ` logs weekly-research           # Download logs for specific agentic workflow
+  ` + constants.CLIExtensionPrefix + ` logs weekly-research           # Download logs for specific workflow
   ` + constants.CLIExtensionPrefix + ` logs -c 10                     # Download last 10 matching runs
   ` + constants.CLIExtensionPrefix + ` logs --start-date 2024-01-01   # Download all runs after date
   ` + constants.CLIExtensionPrefix + ` logs --end-date 2024-01-31     # Download all runs before date
@@ -345,8 +345,8 @@ Examples:
 		Run: func(cmd *cobra.Command, args []string) {
 			var workflowName string
 			if len(args) > 0 && args[0] != "" {
-				// Convert agentic workflow ID to GitHub Actions workflow name
-				// First try to resolve as an agentic workflow ID
+				// Convert workflow ID to GitHub Actions workflow name
+				// First try to resolve as a workflow ID
 				resolvedName, err := workflow.ResolveWorkflowName(args[0])
 				if err != nil {
 					// If that fails, check if it's already a GitHub Actions workflow name
@@ -356,10 +356,10 @@ Examples:
 						// It's already a valid GitHub Actions workflow name
 						workflowName = args[0]
 					} else {
-						// Neither agentic workflow ID nor valid GitHub Actions workflow name
+						// Neither workflow ID nor valid GitHub Actions workflow name
 						fmt.Fprintln(os.Stderr, console.FormatError(console.CompilerError{
 							Type:    "error",
-							Message: fmt.Sprintf("workflow '%s' not found. Expected either an agentic workflow ID (e.g., 'test-claude') or GitHub Actions workflow name (e.g., 'Test Claude'). Original error: %v", args[0], err),
+							Message: fmt.Sprintf("workflow '%s' not found. Expected either a workflow ID (e.g., 'test-claude') or GitHub Actions workflow name (e.g., 'Test Claude'). Original error: %v", args[0], err),
 						}))
 						os.Exit(1)
 					}

pkg/cli/update_command.go

@@ -18,7 +18,7 @@ import (
 // NewUpdateCommand creates the update command
 func NewUpdateCommand(validateEngine func(string) error) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "update [workflow-name]...",
+		Use:   "update [workflow-id]...",
 		Short: "Update workflows from their source repositories and check for gh-aw updates",
 		Long: `Update one or more workflows from their source repositories and check for gh-aw updates.