pipelines: updated descriptions and inconsistencies (#3272)

## Changes
- Added new deploy and open descriptions
- made [flags] [KEY] be consistent
- added [KEY] to open: this is unlike Bundle implementation but is more
consistent with the other functions
- specified that run, dryrun, and open will auto-select when there is
only one pipeline

## Why
Bugbash feedback and consistency

---------

Co-authored-by: Jeffery Cheng <[email protected]>

Author: alyssa-db

cmd/pipelines/deploy.go

@@ -19,6 +19,7 @@ func deployCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "deploy",
 		Short: "Deploy pipelines",
+		Long:  `Deploy pipelines by uploading all files defined in the project to the target workspace, and creating or updating the pipelines defined in the workspace.`,
 		Args:  root.NoArgs,
 	}
 

cmd/pipelines/dry_run.go

@@ -23,10 +23,11 @@ import (
 
 func dryRunCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "dry-run [KEY]",
+		Use:   "dry-run [flags] [KEY]",
 		Short: "Validate correctness of the pipeline's graph",
 		Long: `Validates correctness of the pipeline's graph, identified by KEY. Does not materialize or publish any datasets.
-The KEY is the unique identifier of the pipeline to run.`,
+KEY is the unique name of the pipeline to dry run, as defined in its YAML file.
+If there is only one pipeline in the project, KEY is optional and the pipeline will be auto-selected.`,
 	}
 
 	var noWait bool

cmd/pipelines/open.go

@@ -63,9 +63,12 @@ func resolveOpenArgument(ctx context.Context, b *bundle.Bundle, args []string) (
 
 func openCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "open",
+		Use:   "open [flags] [KEY]",
 		Short: "Open a pipeline in the browser",
-		Args:  root.MaximumNArgs(1),
+		Long: `Open a pipeline in the browser, identified by KEY.
+KEY is the unique name of the pipeline to open, as defined in its YAML file.
+If there is only one pipeline in the project, KEY is optional and the pipeline will be auto-selected.`,
+		Args: root.MaximumNArgs(1),
 	}
 
 	var forcePull bool

cmd/pipelines/run.go

@@ -27,7 +27,8 @@ func runCommand() *cobra.Command {
 		Use:   "run [flags] [KEY]",
 		Short: "Run a pipeline",
 		Long: `Run the pipeline identified by KEY.
-The KEY is the unique identifier of the pipeline to run.`,
+KEY is the unique name of the pipeline to run, as defined in its YAML file.
+If there is only one pipeline in the project, KEY is optional and the pipeline will be auto-selected.`,
 	}
 
 	var refreshAll bool