Browse Source

improve a bit cscli examples when it comes to list mgmt (#2911)

Thibault "bui" Koechlin 1 year ago
parent
commit
75a50c0c9d
2 changed files with 9 additions and 6 deletions
  1. 7 5
      cmd/crowdsec-cli/alerts.go
  2. 2 1
      cmd/crowdsec-cli/decisions.go

+ 7 - 5
cmd/crowdsec-cli/alerts.go

@@ -177,9 +177,9 @@ func (cli *cliAlerts) displayOneAlert(alert *models.Alert, withDetail bool) erro
 	return nil
 	return nil
 }
 }
 
 
-type cliAlerts struct{
+type cliAlerts struct {
 	client *apiclient.ApiClient
 	client *apiclient.ApiClient
-	cfg configGetter
+	cfg    configGetter
 }
 }
 
 
 func NewCLIAlerts(getconfig configGetter) *cliAlerts {
 func NewCLIAlerts(getconfig configGetter) *cliAlerts {
@@ -253,8 +253,10 @@ func (cli *cliAlerts) NewListCmd() *cobra.Command {
 		Example: `cscli alerts list
 		Example: `cscli alerts list
 cscli alerts list --ip 1.2.3.4
 cscli alerts list --ip 1.2.3.4
 cscli alerts list --range 1.2.3.0/24
 cscli alerts list --range 1.2.3.0/24
+cscli alerts list --origin lists
 cscli alerts list -s crowdsecurity/ssh-bf
 cscli alerts list -s crowdsecurity/ssh-bf
 cscli alerts list --type ban`,
 cscli alerts list --type ban`,
+		Long:              `List alerts with optional filters`,
 		DisableAutoGenTag: true,
 		DisableAutoGenTag: true,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			if err := manageCliDecisionAlerts(alertListFilter.IPEquals, alertListFilter.RangeEquals,
 			if err := manageCliDecisionAlerts(alertListFilter.IPEquals, alertListFilter.RangeEquals,
@@ -358,7 +360,7 @@ func (cli *cliAlerts) NewDeleteCmd() *cobra.Command {
 	var (
 	var (
 		ActiveDecision *bool
 		ActiveDecision *bool
 		AlertDeleteAll bool
 		AlertDeleteAll bool
-		delAlertByID string
+		delAlertByID   string
 	)
 	)
 
 
 	var alertDeleteFilter = apiclient.AlertsDeleteOpts{
 	var alertDeleteFilter = apiclient.AlertsDeleteOpts{
@@ -449,7 +451,7 @@ cscli alerts delete -s crowdsecurity/ssh-bf"`,
 			return nil
 			return nil
 		},
 		},
 	}
 	}
-	
+
 	flags := cmd.Flags()
 	flags := cmd.Flags()
 	flags.SortFlags = false
 	flags.SortFlags = false
 	flags.StringVar(alertDeleteFilter.ScopeEquals, "scope", "", "the scope (ie. ip,range)")
 	flags.StringVar(alertDeleteFilter.ScopeEquals, "scope", "", "the scope (ie. ip,range)")
@@ -520,7 +522,7 @@ func (cli *cliAlerts) NewInspectCmd() *cobra.Command {
 func (cli *cliAlerts) NewFlushCmd() *cobra.Command {
 func (cli *cliAlerts) NewFlushCmd() *cobra.Command {
 	var (
 	var (
 		maxItems int
 		maxItems int
-		maxAge string
+		maxAge   string
 	)
 	)
 
 
 	cmd := &cobra.Command{
 	cmd := &cobra.Command{

+ 2 - 1
cmd/crowdsec-cli/decisions.go

@@ -195,7 +195,7 @@ func (cli *cliDecisions) newListCmd() *cobra.Command {
 		Example: `cscli decisions list -i 1.2.3.4
 		Example: `cscli decisions list -i 1.2.3.4
 cscli decisions list -r 1.2.3.0/24
 cscli decisions list -r 1.2.3.0/24
 cscli decisions list -s crowdsecurity/ssh-bf
 cscli decisions list -s crowdsecurity/ssh-bf
-cscli decisions list -t ban
+cscli decisions list --origin lists --scenario list_name
 `,
 `,
 		Args:              cobra.ExactArgs(0),
 		Args:              cobra.ExactArgs(0),
 		DisableAutoGenTag: true,
 		DisableAutoGenTag: true,
@@ -436,6 +436,7 @@ func (cli *cliDecisions) newDeleteCmd() *cobra.Command {
 cscli decisions delete -i 1.2.3.4
 cscli decisions delete -i 1.2.3.4
 cscli decisions delete --id 42
 cscli decisions delete --id 42
 cscli decisions delete --type captcha
 cscli decisions delete --type captcha
+cscli decisions delete --origin lists  --scenario list_name
 `,
 `,
 		/*TBD : refaire le Long/Example*/
 		/*TBD : refaire le Long/Example*/
 		PreRunE: func(cmd *cobra.Command, _ []string) error {
 		PreRunE: func(cmd *cobra.Command, _ []string) error {