Help output and integration test naming changes

internal/cmd/api-key/command_delete.go

@@ -14,7 +14,7 @@ import (
 
 func (c *command) newDeleteCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "delete <api-key>",
+		Use:               "delete <key>",
 		Short:             "Delete an API key.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/api-key/command_describe.go

@@ -27,7 +27,7 @@ type out struct {
 
 func (c *command) newDescribeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "describe <id>",
+		Use:               "describe <key>",
 		Short:             "Describe an API key.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/api-key/command_store.go

@@ -26,7 +26,7 @@ work. For example, the Kafka topic consume and produce commands require an API s
 
 func (c *command) newStoreCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "store [api-key] [secret]",
+		Use:   "store [key] [secret]",
 		Short: "Store an API key/secret locally to use in the CLI.",
 		Long:  longDescription,
 		Args:  cobra.MaximumNArgs(2),

internal/cmd/api-key/command_update.go

@@ -12,7 +12,7 @@ import (
 
 func (c *command) newUpdateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "update <api-key>",
+		Use:               "update <key>",
 		Short:             "Update an API key.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/api-key/command_use.go

@@ -13,7 +13,7 @@ import (
 
 func (c *command) newUseCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "use <api-key>",
+		Use:               "use <key>",
 		Short:             "Set the active API key for use in other commands.",
 		Long:              "Set the active API key for use in any command which supports passing an API key with the `--api-key` flag.",
 		Args:              cobra.ExactArgs(1),

internal/cmd/connect/command_cluster_pause.go

@@ -13,7 +13,7 @@ import (
 
 func (c *clusterCommand) newPauseCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "pause <id-1> [id-2] ... [id-N]",
+		Use:               "pause <id-1> [id-2] ... [id-n]",
 		Short:             "Pause connectors.",
 		Args:              cobra.MinimumNArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgsMultiple),

internal/cmd/connect/command_cluster_resume.go

@@ -13,7 +13,7 @@ import (
 
 func (c *clusterCommand) newResumeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "resume <id-1> [id-2] ... [id-N]",
+		Use:               "resume <id-1> [id-2] ... [id-n]",
 		Short:             "Resume connectors.",
 		Args:              cobra.MinimumNArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgsMultiple),

internal/cmd/connect/command_plugin_describe.go

@@ -19,7 +19,7 @@ type pluginDescribeOut struct {
 
 func (c *pluginCommand) newDescribeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "describe <plugin>",
+		Use:               "describe <name>",
 		Short:             "Describe a connector plugin.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/context/command_create.go

@@ -13,7 +13,7 @@ import (
 
 func (c *command) newCreateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "create [context]",
+		Use:   "create <name>",
 		Short: "Create a new context.",
 		Long:  "Create a new Cloud context with an API key.",
 		Args:  cobra.ExactArgs(1),

internal/cmd/context/command_delete.go

@@ -14,7 +14,7 @@ import (
 
 func (c *command) newDeleteCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "delete <context>",
+		Use:               "delete <name>",
 		Short:             "Delete a context.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/context/command_describe.go

@@ -19,7 +19,7 @@ type out struct {
 
 func (c *command) newDescribeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "describe [context]",
+		Use:               "describe [name]",
 		Short:             "Describe a context.",
 		Long:              "Describe a context or a specific context field.",
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/context/command_update.go

@@ -11,7 +11,7 @@ import (
 
 func (c *command) newUpdateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "update [context]",
+		Use:               "update [name]",
 		Short:             "Update a context field.",
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),
 		RunE:              c.update,

internal/cmd/context/command_use.go

@@ -8,7 +8,7 @@ import (
 
 func (c *command) newUseCommand() *cobra.Command {
 	return &cobra.Command{
-		Use:               "use <context>",
+		Use:               "use <name>",
 		Short:             "Use a context.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_broker_describe.go

@@ -45,7 +45,7 @@ func (c *brokerCommand) newDescribeCommand() *cobra.Command {
 	}
 
 	cmd.Flags().Bool("all", false, "Get cluster-wide broker configurations (non-default values only).")
-	cmd.Flags().String("config-name", "", "Get a specific configuration value (pair with --all to see a cluster-wide config.")
+	cmd.Flags().String("config-name", "", `Get a specific configuration value (pair with "--all" to see a cluster-wide config).`)
 	cmd.Flags().AddFlagSet(pcmd.OnPremKafkaRestSet())
 	pcmd.AddOutputFlag(cmd)
 

internal/cmd/kafka/command_link_configuration_list.go

@@ -20,7 +20,7 @@ type linkConfigurationOut struct {
 
 func (c *linkCommand) newConfigurationListCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "list <link>",
+		Use:               "list <name>",
 		Short:             "List cluster link configurations.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_link_configuration_list_onprem.go

@@ -9,7 +9,7 @@ import (
 
 func (c *linkCommand) newConfigurationListCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "list <link>",
+		Use:   "list <name>",
 		Short: "List cluster link configurations.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.configurationListOnPrem,

internal/cmd/kafka/command_link_configuration_update.go

@@ -14,7 +14,7 @@ import (
 
 func (c *linkCommand) newConfigurationUpdateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "update <link>",
+		Use:               "update <name>",
 		Short:             "Update cluster link configurations.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_link_configuration_update_onprem.go

@@ -16,7 +16,7 @@ import (
 
 func (c *linkCommand) newConfigurationUpdateCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "update <link>",
+		Use:   "update <name>",
 		Short: "Update cluster link configurations.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.configurationUpdateOnPrem,

internal/cmd/kafka/command_link_create.go

@@ -59,7 +59,7 @@ const (
 
 func (c *linkCommand) newCreateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "create <link>",
+		Use:   "create <name>",
 		Short: "Create a new cluster link.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.create,

internal/cmd/kafka/command_link_create_onprem.go

@@ -17,7 +17,7 @@ import (
 
 func (c *linkCommand) newCreateCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "create <link>",
+		Use:   "create <name>",
 		Short: "Create a new cluster link.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.createOnPrem,

internal/cmd/kafka/command_link_delete.go

@@ -15,7 +15,7 @@ import (
 
 func (c *linkCommand) newDeleteCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "delete <link>",
+		Use:               "delete <name>",
 		Short:             "Delete a cluster link.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_link_delete_onprem.go

@@ -11,7 +11,7 @@ import (
 
 func (c *linkCommand) newDeleteCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "delete <link>",
+		Use:   "delete <name>",
 		Short: "Delete a cluster link.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.deleteOnPrem,

internal/cmd/kafka/command_mirror_describe.go

@@ -12,7 +12,7 @@ import (
 
 func (c *mirrorCommand) newDescribeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "describe <destination-topic-name>",
+		Use:               "describe <mirror-topic-name>",
 		Short:             "Describe a mirror topic.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_mirror_failover.go

@@ -14,7 +14,7 @@ import (
 
 func (c *mirrorCommand) newFailoverCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "failover <destination-topic-1> [destination-topic-2] ... [destination-topic-N]",
+		Use:               "failover <mirror-topic-name-1> [mirror-topic-name-2] ... [mirror-topic-name-n]",
 		Short:             "Failover mirror topics.",
 		Args:              cobra.MinimumNArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgsMultiple),

internal/cmd/kafka/command_mirror_pause.go

@@ -14,7 +14,7 @@ import (
 
 func (c *mirrorCommand) newPauseCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "pause <destination-topic-1> [destination-topic-2] ... [destination-topic-N]",
+		Use:               "pause <mirror-topic-name-1> [mirror-topic-name-2] ... [mirror-topic-name-n]",
 		Short:             "Pause mirror topics.",
 		Args:              cobra.MinimumNArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgsMultiple),

internal/cmd/kafka/command_mirror_promote.go

@@ -14,7 +14,7 @@ import (
 
 func (c *mirrorCommand) newPromoteCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "promote <destination-topic-1> [destination-topic-2] ... [destination-topic-N]",
+		Use:               "promote <mirror-topic-name-1> [mirror-topic-name-2] ... [mirror-topic-name-n]",
 		Short:             "Promote mirror topics.",
 		RunE:              c.promote,
 		Args:              cobra.MinimumNArgs(1),

internal/cmd/kafka/command_mirror_resume.go

@@ -17,7 +17,7 @@ import (
 
 func (c *mirrorCommand) newResumeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "resume <destination-topic-1> [destination-topic-2] ... [destination-topic-N]",
+		Use:               "resume <mirror-topic-name-1> [mirror-topic-name-2] ... [mirror-topic-name-n]",
 		Short:             "Resume mirror topics.",
 		Args:              cobra.MinimumNArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgsMultiple),

internal/cmd/kafka/command_topic_consume.go

@@ -21,7 +21,7 @@ import (
 
 func newConsumeCommand(prerunner pcmd.PreRunner, clientId string) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:         "consume <topic>",
+		Use:         "consume <name>",
 		Short:       "Consume messages from a Kafka topic.",
 		Long:        "Consume messages from a Kafka topic.\n\nTruncated message headers will be printed if they exist.",
 		Args:        cobra.ExactArgs(1),

internal/cmd/kafka/command_topic_consume_onprem.go

@@ -20,7 +20,7 @@ import (
 
 func (c *authenticatedTopicCommand) newConsumeCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "consume <topic>",
+		Use:   "consume <name>",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.consumeOnPrem,
 		Short: "Consume messages from a Kafka topic.",

internal/cmd/kafka/command_topic_create.go

@@ -21,7 +21,7 @@ import (
 
 func (c *authenticatedTopicCommand) newCreateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "create <topic>",
+		Use:   "create <name>",
 		Short: "Create a Kafka topic.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.create,

internal/cmd/kafka/command_topic_create_onprem.go

@@ -20,7 +20,7 @@ import (
 
 func (c *authenticatedTopicCommand) newCreateCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "create <topic>",
+		Use:   "create <name>",
 		Short: "Create a Kafka topic.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.createOnPrem,

internal/cmd/kafka/command_topic_delete.go

@@ -17,7 +17,7 @@ import (
 
 func (c *authenticatedTopicCommand) newDeleteCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "delete <topic>",
+		Use:               "delete <name>",
 		Short:             "Delete a Kafka topic.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_topic_delete_onprem.go

@@ -16,7 +16,7 @@ import (
 
 func (c *authenticatedTopicCommand) newDeleteCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "delete <topic>",
+		Use:   "delete <name>",
 		Short: "Delete a Kafka topic.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.deleteOnPrem,

internal/cmd/kafka/command_topic_describe.go

@@ -12,7 +12,7 @@ import (
 
 func (c *authenticatedTopicCommand) newDescribeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "describe <topic>",
+		Use:               "describe <name>",
 		Short:             "Describe a Kafka topic.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/kafka/command_topic_describe_onprem.go

@@ -28,7 +28,7 @@ type topicData struct {
 
 func (c *authenticatedTopicCommand) newDescribeCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "describe <topic>",
+		Use:   "describe <name>",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.describeOnPrem,
 		Short: "Describe a Kafka topic.",

internal/cmd/kafka/command_topic_produce.go

@@ -23,7 +23,7 @@ import (
 
 func newProduceCommand(prerunner pcmd.PreRunner, clientId string) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:         "produce <topic>",
+		Use:         "produce <name>",
 		Short:       "Produce messages to a Kafka topic.",
 		Long:        "Produce messages to a Kafka topic.\n\nWhen using this command, you cannot modify the message header, and the message header will not be printed out.",
 		Args:        cobra.ExactArgs(1),

internal/cmd/kafka/command_topic_produce_onprem.go

@@ -21,7 +21,7 @@ import (
 
 func (c *authenticatedTopicCommand) newProduceCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "produce <topic>",
+		Use:   "produce <name>",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.produceOnPrem,
 		Short: "Produce messages to a Kafka topic.",

internal/cmd/kafka/command_topic_update.go

@@ -27,7 +27,7 @@ type topicConfigurationOut struct {
 
 func (c *authenticatedTopicCommand) newUpdateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "update <topic>",
+		Use:               "update <name>",
 		Short:             "Update a Kafka topic.",
 		Args:              cobra.ExactArgs(1),
 		RunE:              c.update,

internal/cmd/kafka/command_topic_update_onprem.go

@@ -18,7 +18,7 @@ import (
 
 func (c *authenticatedTopicCommand) newUpdateCommandOnPrem() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "update <topic>",
+		Use:   "update <name>",
 		Short: "Update a Kafka topic.",
 		Args:  cobra.ExactArgs(1),
 		RunE:  c.updateOnPrem,

internal/cmd/ksql/command_cluster_configureacls.go

@@ -22,7 +22,7 @@ import (
 
 func (c *ksqlCommand) newConfigureAclsCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "configure-acls <id> [topic-1] [topic-2] ... [topic-N]",
+		Use:               "configure-acls <id> [topic-name-1] [topic-name-2] ... [topic-name-n]",
 		Short:             "Configure ACLs for a ksqlDB cluster.",
 		Args:              cobra.MinimumNArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/pipeline/command_activate.go

@@ -11,7 +11,7 @@ import (
 
 func (c *command) newActivateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "activate <pipeline-id>",
+		Use:               "activate <id>",
 		Short:             "Request to activate a pipeline.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/pipeline/command_deactivate.go

@@ -11,7 +11,7 @@ import (
 
 func (c *command) newDeactivateCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "deactivate <pipeline-id>",
+		Use:               "deactivate <id>",
 		Short:             "Request to deactivate a pipeline.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/pipeline/command_delete.go

@@ -15,7 +15,7 @@ import (
 
 func (c *command) newDeleteCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "delete <pipeline-id>",
+		Use:               "delete <id>",
 		Short:             "Delete a pipeline.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),

internal/cmd/pipeline/command_describe.go

@@ -9,7 +9,7 @@ import (
 
 func (c *command) newDescribeCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:               "describe <pipeline-id>",
+		Use:               "describe <id>",
 		Short:             "Describe a Stream Designer pipeline.",
 		Args:              cobra.ExactArgs(1),
 		ValidArgsFunction: pcmd.NewValidArgsFunction(c.validArgs),