cscli: print command name along with errors (#3768)

mmetc · web-flow · commit 59df44330134 · 2025-07-31T14:34:24.000+02:00
diff --git a/cmd/crowdsec-cli/args/args.go b/cmd/crowdsec-cli/args/args.go
@@ -51,4 +51,3 @@ func NoArgs(cmd *cobra.Command, args []string) error {
 	}
 	return nil
 }
-
diff --git a/cmd/crowdsec-cli/clibouncer/delete.go b/cmd/crowdsec-cli/clibouncer/delete.go
@@ -57,7 +57,7 @@ func (cli *cliBouncers) delete(ctx context.Context, bouncers []string, ignoreMis
 			log.Warnf("bouncer '%s' is auto-created and cannot be deleted, delete parent bouncer %s instead", bouncerName, parentBouncer)
 			continue
 		}
-		//Try to find all child bouncers and delete them
+		// Try to find all child bouncers and delete them
 		for _, childBouncer := range allBouncers {
 			if strings.HasPrefix(childBouncer.Name, bouncerName+"@") && childBouncer.AutoCreated {
 				if err := cli.db.DeleteBouncer(ctx, childBouncer.Name); err != nil {
diff --git a/cmd/crowdsec-cli/cliconfig/backup.go b/cmd/crowdsec-cli/cliconfig/backup.go
@@ -9,7 +9,7 @@ import (
 func (cli *cliConfig) newBackupCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "backup",
-		Short: "This command has been removed. You can backup/restore the configuration by other means.",
+		Short:             "This command has been removed. You can backup/restore the configuration by other means.",
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
 			configDir := cli.cfg().ConfigPaths.ConfigDir
diff --git a/cmd/crowdsec-cli/cliconfig/restore.go b/cmd/crowdsec-cli/cliconfig/restore.go
@@ -9,7 +9,7 @@ import (
 func (cli *cliConfig) newRestoreCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "restore",
-		Short: "This command has been removed. You can backup/restore the configuration by other means.",
+		Short:             "This command has been removed. You can backup/restore the configuration by other means.",
 		DisableAutoGenTag: true,
 		RunE: func(_ *cobra.Command, _ []string) error {
 			configDir := cli.cfg().ConfigPaths.ConfigDir
diff --git a/cmd/crowdsec-cli/clidecision/decisions.go b/cmd/crowdsec-cli/clidecision/decisions.go
@@ -17,14 +17,14 @@ import (
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
+	"github.com/crowdsecurity/go-cs-lib/cstime"
+
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/args"
 	"github.com/crowdsecurity/crowdsec/cmd/crowdsec-cli/clialert"
 	"github.com/crowdsecurity/crowdsec/pkg/apiclient"
 	"github.com/crowdsecurity/crowdsec/pkg/csconfig"
 	"github.com/crowdsecurity/crowdsec/pkg/models"
 	"github.com/crowdsecurity/crowdsec/pkg/types"
-
-	"github.com/crowdsecurity/go-cs-lib/cstime"
 )
 
 type configGetter func() *csconfig.Config
diff --git a/cmd/crowdsec-cli/clidecision/import.go b/cmd/crowdsec-cli/clidecision/import.go
@@ -212,7 +212,6 @@ func (cli *cliDecisions) import_(ctx context.Context, input string, duration str
 		}
 
 		allowlistResp, _, err := cli.client.Allowlists.CheckIfAllowlistedBulk(ctx, decisionsStr)
-
 		if err != nil {
 			return err
 		}
diff --git a/cmd/crowdsec-cli/main.go b/cmd/crowdsec-cli/main.go
@@ -309,8 +309,7 @@ It is meant to allow you to manage bans, parsers/scenarios/etc, api and generall
 }
 
 func fatal(err error) {
-	red := color.New(color.FgRed).SprintFunc()
-	fmt.Fprintln(os.Stderr, red("Error:"), err)
+	fmt.Fprintln(os.Stderr, color.RedString("Error:"), err)
 	os.Exit(1)
 }
 
@@ -323,7 +322,19 @@ func mainWrap() error {
 		return err
 	}
 
-	return cmd.ExecuteContext(ctx)
+	err = cmd.ExecuteContext(ctx)
+	if err != nil {
+		cmdName := cmd.Name()
+
+		subCmd, _, subErr := cmd.Find(os.Args[1:])
+		if subErr == nil {
+			cmdName = subCmd.CommandPath()
+		}
+
+		return fmt.Errorf("%s: %w", cmdName, err)
+	}
+
+	return nil
 }
 
 func main() {
diff --git a/cmd/crowdsec-cli/reload/reload.go b/cmd/crowdsec-cli/reload/reload.go
@@ -3,8 +3,9 @@ package reload
 import (
 	"os"
 
-	"github.com/crowdsecurity/go-cs-lib/version"
 	isatty "github.com/mattn/go-isatty"
+
+	"github.com/crowdsecurity/go-cs-lib/version"
 )
 
 func UserMessage() string {
diff --git a/test/bats/01_cscli_lapi.bats b/test/bats/01_cscli_lapi.bats
@@ -113,7 +113,7 @@ teardown() {
     config_set "$LOCAL_API_CREDENTIALS" '.url="http://127.0.0.1:-80"'
 
     rune -1 cscli lapi status
-    assert_stderr 'Error: failed to authenticate to Local API (LAPI): parse "http://127.0.0.1:-80/": invalid port ":-80" after host'
+    assert_stderr 'Error: cscli lapi status: failed to authenticate to Local API (LAPI): parse "http://127.0.0.1:-80/": invalid port ":-80" after host'
 }
 
 @test "cscli - bad LAPI password" {
@@ -122,7 +122,7 @@ teardown() {
     config_set "$LOCAL_API_CREDENTIALS" '.password="meh"'
 
     rune -1 cscli lapi status
-    assert_stderr 'Error: failed to authenticate to Local API (LAPI): API error: incorrect Username or Password'
+    assert_stderr 'Error: cscli lapi status: failed to authenticate to Local API (LAPI): API error: incorrect Username or Password'
 }
 
 @test "cscli lapi register / machines validate" {
@@ -189,7 +189,7 @@ teardown() {
     rune -1 cscli machines inspect malicious
     # XXX: we may want to remove this warning
     assert_stderr --partial 'QueryMachineByID : ent: machine not found'
-    assert_stderr --partial "Error: unable to read machine data 'malicious': user 'malicious': user doesn't exist"
+    assert_stderr --partial "Error: cscli machines inspect: unable to read machine data 'malicious': user 'malicious': user doesn't exist"
 
     rune -0 cscli lapi register --machine newmachine --token 12345678901234567890123456789012
     assert_stderr --partial "Successfully registered to Local API"
diff --git a/test/bats/10_bouncers.bats b/test/bats/10_bouncers.bats
@@ -118,7 +118,7 @@ teardown() {
     rune -0 cscli bouncers add ciTestBouncer
     rune -1 cscli bouncers add ciTestBouncer
 
-    assert_stderr 'Error: unable to create bouncer: bouncer ciTestBouncer already exists'
+    assert_stderr 'Error: cscli bouncers add: unable to create bouncer: bouncer ciTestBouncer already exists'
 
     rune -0 cscli bouncers list -o json
     rune -0 jq '. | length' <(output)
@@ -134,7 +134,7 @@ teardown() {
 
 @test "cscli bouncers prune" {
     rune -1 cscli bouncers prune --duration foobar
-    assert_stderr 'Error: invalid argument "foobar" for "-d, --duration" flag: time: invalid duration "foobar"'
+    assert_stderr 'Error: cscli bouncers prune: invalid argument "foobar" for "-d, --duration" flag: time: invalid duration "foobar"'
 
     # duration takes days as well
     rune -0 cscli bouncers prune --duration 1d30m
diff --git a/test/bats/20_hub_items.bats b/test/bats/20_hub_items.bats
@@ -80,7 +80,7 @@ teardown() {
     rune -0 cscli collections install crowdsecurity/sshd
     rune -1 cscli collections inspect crowdsecurity/sshd --no-metrics
     # XXX: it would be better to trigger this during parse, not sync
-    assert_stderr "Error: failed to sync $HUB_DIR: while syncing collections sshd.yaml: 1.2.3.4: Invalid Semantic Version"
+    assert_stderr "Error: cscli collections inspect: failed to sync $HUB_DIR: while syncing collections sshd.yaml: 1.2.3.4: Invalid Semantic Version"
 }
 
 @test "removing or purging an item already removed by hand" {
diff --git a/test/bats/30_machines.bats b/test/bats/30_machines.bats
@@ -126,7 +126,7 @@ teardown() {
     rune -0 cscli metrics
 
     rune -1 cscli machines prune --duration foobar
-    assert_stderr 'Error: invalid argument "foobar" for "-d, --duration" flag: time: invalid duration "foobar"'
+    assert_stderr 'Error: cscli machines prune: invalid argument "foobar" for "-d, --duration" flag: time: invalid duration "foobar"'
 
     # if the fixture has been created some time ago,
     # the machines may be old enough to trigger a user prompt.
diff --git a/test/bats/80_alerts.bats b/test/bats/80_alerts.bats
@@ -45,7 +45,7 @@ teardown() {
 
 @test "cscli alerts list, accept duration parameters with days" {
     rune -1 cscli alerts list --until toto
-    assert_stderr 'Error: invalid argument "toto" for "--until" flag: time: invalid duration "toto"'
+    assert_stderr 'Error: cscli alerts list: invalid argument "toto" for "--until" flag: time: invalid duration "toto"'
     rune -0 cscli alerts list --until 2d12h --debug
     assert_stderr --partial "until=60h0m0s"
     rune -0 cscli alerts list --since 2d12h --debug
@@ -75,7 +75,7 @@ teardown() {
 
 @test "cscli alerts inspect" {
     rune -1 cscli alerts inspect
-    assert_stderr 'Error: requires at least 1 arg(s), only received 0'
+    assert_stderr 'Error: cscli alerts inspect: requires at least 1 arg(s), only received 0'
 
     rune -0 cscli decisions add -i 10.20.30.40 -t ban
     rune -0 cscli alerts list -o raw
diff --git a/test/bats/90_decisions.bats b/test/bats/90_decisions.bats
@@ -30,7 +30,7 @@ teardown() {
 
 @test "'decisions add' requires parameters" {
     rune -1 cscli decisions add
-    assert_stderr "Error: missing arguments, a value is required (--ip, --range or --scope and --value)"
+    assert_stderr "Error: cscli decisions add: missing arguments, a value is required (--ip, --range or --scope and --value)"
 }
 
 @test "cscli decisions list, with and without --machine" {
@@ -56,7 +56,7 @@ teardown() {
 
 @test "cscli decisions list, accept duration parameters with days" {
     rune -1 cscli decisions list --until toto
-    assert_stderr 'Error: invalid argument "toto" for "--until" flag: time: invalid duration "toto"'
+    assert_stderr 'Error: cscli decisions list: invalid argument "toto" for "--until" flag: time: invalid duration "toto"'
     rune -0 cscli decisions list --until 2d12h --debug
     assert_stderr --partial "until=60h0m0s"
     rune -0 cscli decisions list --since 2d12h --debug
@@ -66,7 +66,7 @@ teardown() {
 @test "cscli decisions import" {
     # required input
     rune -1 cscli decisions import
-    assert_stderr 'Error: required flag(s) "input" not set'
+    assert_stderr 'Error: cscli decisions import: required flag(s) "input" not set'
 
     # unsupported format
     rune -1 cscli decisions import -i - <<<'value\n5.6.7.8' --format xml
@@ -134,7 +134,7 @@ teardown() {
     # XXX: improve validation
     rune -1 cscli decisions import -i - <<<'value\n1.2.3.4,5.6.7.8' --format csv
     assert_output "Parsing csv"
-    assert_stderr "Error: no decisions found"
+    assert_stderr "Error: cscli decisions import: no decisions found"
 
     #----------
     # VALUES
@@ -182,7 +182,7 @@ teardown() {
         1.2.3.5
 	EOT
     assert_output "Parsing values"
-    assert_stderr "Error: API error: invalid ip address 'bad-apple'"
+    assert_stderr "Error: cscli decisions import: API error: invalid ip address 'bad-apple'"
 
     rune -0 cscli decisions list -a -o json
     rune -0 jq -r '.[0].decisions | length' <(output)
diff --git a/test/bats/cscli-allowlists.bats b/test/bats/cscli-allowlists.bats
@@ -61,16 +61,16 @@ teardown() {
 
 @test "cscli allowlists create" {
     rune -1 cscli allowlist create
-    assert_stderr 'Error: accepts 1 arg(s), received 0'
+    assert_stderr 'Error: cscli allowlists create: accepts 1 arg(s), received 0'
 
     rune -1 cscli allowlist create foo
-    assert_stderr 'Error: required flag(s) "description" not set'
+    assert_stderr 'Error: cscli allowlists create: required flag(s) "description" not set'
 
     rune -0 cscli allowlist create foo -d "A Foo"
     assert_output "allowlist 'foo' created successfully"
 
     rune -1 cscli allowlist create foo -d "Another Foo"
-    assert_stderr "Error: allowlist 'foo' already exists"
+    assert_stderr "Error: cscli allowlists create: allowlist 'foo' already exists"
 
     rune -0 cscli allowlists list -o json
     rune -0 jq 'del(.[].created_at) | del(.[].updated_at)' <(output)
@@ -82,13 +82,13 @@ teardown() {
 
 @test "cscli allowlists add" {
     rune -1 cscli allowlist add
-    assert_stderr 'Error: requires at least 2 arg(s), only received 0'
+    assert_stderr 'Error: cscli allowlists add: requires at least 2 arg(s), only received 0'
 
     rune -1 cscli allowlist add foo
-    assert_stderr 'Error: requires at least 2 arg(s), only received 1'
+    assert_stderr 'Error: cscli allowlists add: requires at least 2 arg(s), only received 1'
 
     rune -1 cscli allowlist add foo bar
-    assert_stderr "Error: allowlist 'foo' not found"
+    assert_stderr "Error: cscli allowlists add: allowlist 'foo' not found"
 
     rune -0 cscli allowlist create foo -d 'a foo'
 
@@ -119,12 +119,12 @@ teardown() {
 
     # comment and expiration are applied to all values
     rune -1 cscli allowlist add foo 10.10.10.10 10.20.30.40 -d comment -e toto
-    assert_stderr 'Error: invalid argument "toto" for "-e, --expiration" flag: time: invalid duration "toto"'
+    assert_stderr 'Error: cscli allowlists add: invalid argument "toto" for "-e, --expiration" flag: time: invalid duration "toto"'
     refute_output
 
     rune -1 cscli allowlist add foo 10.10.10.10 10.20.30.40 -d comment -e '1 day'
     refute_output
-    assert_stderr 'Error: invalid argument "1 day" for "-e, --expiration" flag: invalid day value in duration "1 day"'
+    assert_stderr 'Error: cscli allowlists add: invalid argument "1 day" for "-e, --expiration" flag: invalid day value in duration "1 day"'
 
     rune -0 cscli allowlist add foo 10.10.10.10 -d comment -e '1d12h'
     assert_output 'added 1 values to allowlist foo'
@@ -139,7 +139,7 @@ teardown() {
     rune -0 cscli allowlist create foo -d 'a foo'
     rune -0 cscli allowlist add foo 192.168.0.0/16
     rune -1 cscli decisions add -i 192.168.1.1
-    assert_stderr 'Error: 192.168.1.1 is allowlisted by item 192.168.0.0/16 from foo, use --bypass-allowlist to add the decision anyway'
+    assert_stderr 'Error: cscli decisions add: 192.168.1.1 is allowlisted by item 192.168.0.0/16 from foo, use --bypass-allowlist to add the decision anyway'
     refute_output
     rune -0 cscli decisions add -i 192.168.1.1 --bypass-allowlist
     assert_stderr --partial 'Decision successfully added'
@@ -197,10 +197,10 @@ teardown() {
 }
 @test "cscli allowlists delete" {
     rune -1 cscli allowlist delete
-    assert_stderr 'Error: accepts 1 arg(s), received 0'
+    assert_stderr 'Error: cscli allowlists delete: accepts 1 arg(s), received 0'
 
     rune -1 cscli allowlist delete does-not-exist
-    assert_stderr "Error: allowlist 'does-not-exist' not found"
+    assert_stderr "Error: cscli allowlists delete: allowlist 'does-not-exist' not found"
 
     rune -0 cscli allowlist create foo -d "A Foo"
     rune -0 cscli allowlist add foo 1.2.3.4
@@ -212,7 +212,7 @@ teardown() {
 
 @test "cscli allowlists inspect" {
     rune -1 cscli allowlist inspect
-    assert_stderr 'Error: accepts 1 arg(s), received 0'
+    assert_stderr 'Error: cscli allowlists inspect: accepts 1 arg(s), received 0'
 
     rune -0 cscli allowlist create foo -d "A Foo"
     assert_output "allowlist 'foo' created successfully"
@@ -250,13 +250,13 @@ teardown() {
 
 @test "cscli allowlists remove" {
     rune -1 cscli allowlist remove
-    assert_stderr 'Error: requires at least 2 arg(s), only received 0'
+    assert_stderr 'Error: cscli allowlists remove: requires at least 2 arg(s), only received 0'
 
     rune -1 cscli allowlist remove foo
-    assert_stderr 'Error: requires at least 2 arg(s), only received 1'
+    assert_stderr 'Error: cscli allowlists remove: requires at least 2 arg(s), only received 1'
 
     rune -1 cscli allowlist remove foo 1.2.3.4
-    assert_stderr "Error: allowlist 'foo' not found"
+    assert_stderr "Error: cscli allowlists remove: allowlist 'foo' not found"
 
     rune -0 cscli allowlist create foo -d 'a foo'
     # no error, should be ok
diff --git a/test/bats/cscli-hubtype-remove.bats b/test/bats/cscli-hubtype-remove.bats
@@ -185,7 +185,7 @@ teardown() {
     rune -0 cscli parsers install crowdsecurity/whitelists crowdsecurity/windows-auth
 
     rune -1 cscli parsers remove crowdsecurity/whitelists --all
-    assert_stderr "Error: can't specify items and '--all' at the same time"
+    assert_stderr "Error: cscli parsers remove: can't specify items and '--all' at the same time"
 
     rune -0 cscli parsers remove --all --dry-run
     assert_output - --regexp <<-EOT

Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,3 @@ func NoArgs(cmd *cobra.Command, args []string) error {`
`51`	`51`	`}`
`52`	`52`	`return nil`
`53`	`53`	`}`
`54`		`-`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ func (cli *cliBouncers) delete(ctx context.Context, bouncers []string, ignoreMis`
`57`	`57`	`log.Warnf("bouncer '%s' is auto-created and cannot be deleted, delete parent bouncer %s instead", bouncerName, parentBouncer)`
`58`	`58`	`continue`
`59`	`59`	`}`
`60`		`- //Try to find all child bouncers and delete them`
	`60`	`+ // Try to find all child bouncers and delete them`
`61`	`61`	`for _, childBouncer := range allBouncers {`
`62`	`62`	`if strings.HasPrefix(childBouncer.Name, bouncerName+"@") && childBouncer.AutoCreated {`
`63`	`63`	`if err := cli.db.DeleteBouncer(ctx, childBouncer.Name); err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -212,7 +212,6 @@ func (cli *cliDecisions) import_(ctx context.Context, input string, duration str`
`212`	`212`	`}`
`213`	`213`
`214`	`214`	`allowlistResp, _, err := cli.client.Allowlists.CheckIfAllowlistedBulk(ctx, decisionsStr)`
`215`		`-`
`216`	`215`	`if err != nil {`
`217`	`216`	`return err`
`218`	`217`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,9 @@ package reload`
`3`	`3`	`import (`
`4`	`4`	`"os"`
`5`	`5`
`6`		`- "github.com/crowdsecurity/go-cs-lib/version"`
`7`	`6`	`isatty "github.com/mattn/go-isatty"`
	`7`	`+`
	`8`	`+ "github.com/crowdsecurity/go-cs-lib/version"`
`8`	`9`	`)`
`9`	`10`
`10`	`11`	`func UserMessage() string {`