Added an error when invalid subcommand is provided for CLI commands

.codegen/service.go.tmpl

@@ -73,6 +73,7 @@ func New() *cobra.Command {
 		// This service is being previewed; hide from help output.
 		Hidden: true,
 		{{- end }}
+		RunE: root.ReportUnknownSubcommand,
 	}
 
 	{{ if gt (len .Methods) 0 -}}

NEXT_CHANGELOG.md

@@ -10,6 +10,7 @@
 * Upgraded TF provider to 1.73.0 ([#2728](https://github.com/databricks/cli/pull/2728))
 
 ### CLI
+* Added an error when invalid subcommand is provided for CLI commands ([#2655](https://github.com/databricks/cli/pull/2655))
 * Added dry-run flag support to sync command ([#2657](https://github.com/databricks/cli/pull/2657))
 
 ### Bundles

acceptance/cmd/unknown-subcommand/output.txt

@@ -0,0 +1,39 @@
+
+>>> errcode [CLI] secrets list-scopes
+Scope  Backend Type
+
+>>> errcode [CLI] secrets unknown
+Error: unknown command "unknown" for "databricks secrets"
+
+Usage:
+  databricks secrets [flags]
+  databricks secrets [command]
+
+Available Commands
+  create-scope  Create a new secret scope.
+  delete-acl    Delete an ACL.
+  delete-scope  Delete a secret scope.
+  delete-secret Delete a secret.
+  get-acl       Get secret ACL details.
+  get-secret    Get a secret.
+  list-acls     Lists ACLs.
+  list-scopes   List all scopes.
+  list-secrets  List secret keys.
+  put-acl       Create/update an ACL.
+  put-secret    Add a secret.
+
+Permission Commands
+
+Flags:
+  -h, --help   help for secrets
+
+Global Flags:
+      --debug            enable debug logging
+  -o, --output type      output type: text or json (default text)
+  -p, --profile string   ~/.databrickscfg profile
+  -t, --target string    bundle target to use (if applicable)
+
+Use "databricks secrets [command] --help" for more information about a command.
+
+
+Exit code: 1

acceptance/cmd/unknown-subcommand/script

@@ -0,0 +1,2 @@
+trace errcode $CLI secrets list-scopes
+trace errcode $CLI secrets unknown

acceptance/cmd/unknown-subcommand/test.toml

@@ -0,0 +1,8 @@
+Local = true
+Cloud = false
+
+[[Server]]
+Pattern = "GET /api/2.0/secrets/scopes/list"
+Response.Body = """
+{}
+"""

acceptance/help/output.txt

@@ -99,6 +99,7 @@ Vector Search
 Dashboards
   genie                                  Genie provides a no-code experience for business users, powered by AI/BI.
   lakeview                               These APIs provide specific management operations for Lakeview dashboards.
+  lakeview-embedded                      Token-based Lakeview APIs for embedding dashboards in external applications.
 
 Marketplace
   consumer-fulfillments                  Fulfillments are entities that allow consumers to preview installations.

cmd/root/root.go

@@ -185,3 +185,19 @@ Stack Trace:
 
 	return err
 }
+
+// This function is used to report an unknown subcommand.
+// It is used in the [cobra.Command.RunE] field of commands that have subcommands.
+// If user provided a valid subcommand, RunE for the
+// If there are any arguments, it means the user has provided an unknown subcommand.
+// If there are no arguments, it means the user has not provided any subcommand, and the help
+// command should be displayed.
+func ReportUnknownSubcommand(cmd *cobra.Command, args []string) error {
+	if len(args) > 0 {
+		return &InvalidArgsError{
+			Message: fmt.Sprintf("unknown command %q for %q", args[0], cmd.CommandPath()),
+			Command: cmd,
+		}
+	}
+	return cmd.Help()
+}