Thibault bui Koechlin 5 年之前
父节点
当前提交
4d306fc52b
共有 55 个文件被更改,包括 2288 次插入0 次删除
  1. 57 0
      cmd/crowdsec-cli/doc/cscli.md
  2. 49 0
      cmd/crowdsec-cli/doc/cscli_api.md
  3. 40 0
      cmd/crowdsec-cli/doc/cscli_api_credentials.md
  4. 41 0
      cmd/crowdsec-cli/doc/cscli_api_enroll.md
  5. 40 0
      cmd/crowdsec-cli/doc/cscli_api_pull.md
  6. 41 0
      cmd/crowdsec-cli/doc/cscli_api_register.md
  7. 40 0
      cmd/crowdsec-cli/doc/cscli_api_reset.md
  8. 39 0
      cmd/crowdsec-cli/doc/cscli_backup.md
  9. 49 0
      cmd/crowdsec-cli/doc/cscli_backup_restore.md
  10. 50 0
      cmd/crowdsec-cli/doc/cscli_backup_save.md
  11. 38 0
      cmd/crowdsec-cli/doc/cscli_ban.md
  12. 46 0
      cmd/crowdsec-cli/doc/cscli_ban_add.md
  13. 42 0
      cmd/crowdsec-cli/doc/cscli_ban_add_ip.md
  14. 42 0
      cmd/crowdsec-cli/doc/cscli_ban_add_range.md
  15. 41 0
      cmd/crowdsec-cli/doc/cscli_ban_del.md
  16. 42 0
      cmd/crowdsec-cli/doc/cscli_ban_del_ip.md
  17. 42 0
      cmd/crowdsec-cli/doc/cscli_ban_del_range.md
  18. 42 0
      cmd/crowdsec-cli/doc/cscli_ban_flush.md
  19. 50 0
      cmd/crowdsec-cli/doc/cscli_ban_list.md
  20. 42 0
      cmd/crowdsec-cli/doc/cscli_config.md
  21. 34 0
      cmd/crowdsec-cli/doc/cscli_config_backend.md
  22. 34 0
      cmd/crowdsec-cli/doc/cscli_config_installdir.md
  23. 34 0
      cmd/crowdsec-cli/doc/cscli_config_prompt.md
  24. 34 0
      cmd/crowdsec-cli/doc/cscli_config_show.md
  25. 42 0
      cmd/crowdsec-cli/doc/cscli_dashboard.md
  26. 47 0
      cmd/crowdsec-cli/doc/cscli_dashboard_setup.md
  27. 34 0
      cmd/crowdsec-cli/doc/cscli_dashboard_start.md
  28. 35 0
      cmd/crowdsec-cli/doc/cscli_dashboard_stop.md
  29. 47 0
      cmd/crowdsec-cli/doc/cscli_inspect.md
  30. 40 0
      cmd/crowdsec-cli/doc/cscli_inspect_collection.md
  31. 40 0
      cmd/crowdsec-cli/doc/cscli_inspect_parser.md
  32. 40 0
      cmd/crowdsec-cli/doc/cscli_inspect_postoverflow.md
  33. 40 0
      cmd/crowdsec-cli/doc/cscli_inspect_scenario.md
  34. 51 0
      cmd/crowdsec-cli/doc/cscli_install.md
  35. 42 0
      cmd/crowdsec-cli/doc/cscli_install_collection.md
  36. 42 0
      cmd/crowdsec-cli/doc/cscli_install_parser.md
  37. 43 0
      cmd/crowdsec-cli/doc/cscli_install_postoverflow.md
  38. 42 0
      cmd/crowdsec-cli/doc/cscli_install_scenario.md
  39. 54 0
      cmd/crowdsec-cli/doc/cscli_list.md
  40. 35 0
      cmd/crowdsec-cli/doc/cscli_list_collections.md
  41. 35 0
      cmd/crowdsec-cli/doc/cscli_list_parsers.md
  42. 35 0
      cmd/crowdsec-cli/doc/cscli_list_postoverflows.md
  43. 35 0
      cmd/crowdsec-cli/doc/cscli_list_scenarios.md
  44. 35 0
      cmd/crowdsec-cli/doc/cscli_metrics.md
  45. 48 0
      cmd/crowdsec-cli/doc/cscli_remove.md
  46. 36 0
      cmd/crowdsec-cli/doc/cscli_remove_collection.md
  47. 36 0
      cmd/crowdsec-cli/doc/cscli_remove_parser.md
  48. 36 0
      cmd/crowdsec-cli/doc/cscli_remove_postoverflow.md
  49. 36 0
      cmd/crowdsec-cli/doc/cscli_remove_scenario.md
  50. 36 0
      cmd/crowdsec-cli/doc/cscli_update.md
  51. 62 0
      cmd/crowdsec-cli/doc/cscli_upgrade.md
  52. 44 0
      cmd/crowdsec-cli/doc/cscli_upgrade_collection.md
  53. 44 0
      cmd/crowdsec-cli/doc/cscli_upgrade_parser.md
  54. 44 0
      cmd/crowdsec-cli/doc/cscli_upgrade_postoverflow.md
  55. 43 0
      cmd/crowdsec-cli/doc/cscli_upgrade_scenario.md

+ 57 - 0
cmd/crowdsec-cli/doc/cscli.md

@@ -0,0 +1,57 @@
+## cscli
+
+cscli allows you to manage crowdsec
+
+### Synopsis
+
+cscli is the main command to interact with your crowdsec service, scenarios & db.
+It is meant to allow you to manage bans, parsers/scenarios/etc, api and generally manage you crowdsec setup.
+
+### Examples
+
+```
+View/Add/Remove bans:  
+ - cscli ban list  
+ - cscli ban add ip 1.2.3.4 24h 'go away'  
+ - cscli ban del 1.2.3.4  
+		
+View/Add/Upgrade/Remove scenarios and parsers:  
+ - cscli list  
+ - cscli install collection crowdsec/linux-web  
+ - cscli remove scenario crowdsec/ssh_enum  
+ - cscli upgrade --all  
+
+API interaction:
+ - cscli api pull
+ - cscli api register
+ 
+```
+
+### Options
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --debug               Set logging to debug.
+      --info                Set logging to info.
+      --warning             Set logging to warning.
+      --error               Set logging to error.
+  -h, --help                help for cscli
+```
+
+### SEE ALSO
+
+* [cscli api](cscli_api.md)	 - Crowdsec API interaction
+* [cscli backup](cscli_backup.md)	 - Backup or restore configuration (api, parsers, scenarios etc.) to/from directory
+* [cscli ban](cscli_ban.md)	 - Manage bans/mitigations
+* [cscli config](cscli_config.md)	 - Allows to view/edit cscli config
+* [cscli dashboard](cscli_dashboard.md)	 - Start a dashboard (metabase) container.
+* [cscli inspect](cscli_inspect.md)	 - Inspect configuration(s)
+* [cscli install](cscli_install.md)	 - Install configuration(s) from hub
+* [cscli list](cscli_list.md)	 - List enabled configs
+* [cscli metrics](cscli_metrics.md)	 - Display crowdsec prometheus metrics.
+* [cscli remove](cscli_remove.md)	 - Remove/disable configuration(s)
+* [cscli update](cscli_update.md)	 - Fetch available configs from hub
+* [cscli upgrade](cscli_upgrade.md)	 - Upgrade configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 49 - 0
cmd/crowdsec-cli/doc/cscli_api.md

@@ -0,0 +1,49 @@
+## cscli api
+
+Crowdsec API interaction
+
+### Synopsis
+
+
+Allow to register your machine into crowdsec API to send and receive signal.
+		
+
+### Examples
+
+```
+
+cscli api register      # Register to Crowdsec API
+cscli api pull          # Pull malevolant IPs from Crowdsec API
+cscli api reset         # Reset your machines credentials
+cscli api enroll        # Enroll your machine to the user account you created on Crowdsec backend
+cscli api credentials   # Display your API credentials
+
+```
+
+### Options
+
+```
+  -h, --help   help for api
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli api credentials](cscli_api_credentials.md)	 - Display api credentials
+* [cscli api enroll](cscli_api_enroll.md)	 - Associate your machine to an existing crowdsec user
+* [cscli api pull](cscli_api_pull.md)	 - Pull crowdsec API TopX
+* [cscli api register](cscli_api_register.md)	 - Register on Crowdsec API
+* [cscli api reset](cscli_api_reset.md)	 - Reset password on CrowdSec API
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_api_credentials.md

@@ -0,0 +1,40 @@
+## cscli api credentials
+
+Display api credentials
+
+### Synopsis
+
+Display api credentials
+
+```
+cscli api credentials [flags]
+```
+
+### Examples
+
+```
+cscli api credentials
+```
+
+### Options
+
+```
+  -h, --help   help for credentials
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli api](cscli_api.md)	 - Crowdsec API interaction
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 41 - 0
cmd/crowdsec-cli/doc/cscli_api_enroll.md

@@ -0,0 +1,41 @@
+## cscli api enroll
+
+Associate your machine to an existing crowdsec user
+
+### Synopsis
+
+Enrolling your machine into your user account will allow for more accurate lists and threat detection. See website to create user account.
+
+```
+cscli api enroll [flags]
+```
+
+### Examples
+
+```
+cscli api enroll -u 1234567890ffff
+```
+
+### Options
+
+```
+  -h, --help          help for enroll
+  -u, --user string   User ID (required)
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli api](cscli_api.md)	 - Crowdsec API interaction
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_api_pull.md

@@ -0,0 +1,40 @@
+## cscli api pull
+
+Pull crowdsec API TopX
+
+### Synopsis
+
+Pulls a list of malveolent IPs relevant to your situation and add them into the local ban database.
+
+```
+cscli api pull [flags]
+```
+
+### Examples
+
+```
+cscli api pull
+```
+
+### Options
+
+```
+  -h, --help   help for pull
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli api](cscli_api.md)	 - Crowdsec API interaction
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 41 - 0
cmd/crowdsec-cli/doc/cscli_api_register.md

@@ -0,0 +1,41 @@
+## cscli api register
+
+Register on Crowdsec API
+
+### Synopsis
+
+This command will register your machine to crowdsec API to allow you to receive list of malveolent IPs. 
+		The printed machine_id and password should be added to your api.yaml file.
+
+```
+cscli api register [flags]
+```
+
+### Examples
+
+```
+cscli api register
+```
+
+### Options
+
+```
+  -h, --help   help for register
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli api](cscli_api.md)	 - Crowdsec API interaction
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_api_reset.md

@@ -0,0 +1,40 @@
+## cscli api reset
+
+Reset password on CrowdSec API
+
+### Synopsis
+
+Attempts to reset your credentials to the API.
+
+```
+cscli api reset [flags]
+```
+
+### Examples
+
+```
+cscli api reset
+```
+
+### Options
+
+```
+  -h, --help   help for reset
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli api](cscli_api.md)	 - Crowdsec API interaction
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 39 - 0
cmd/crowdsec-cli/doc/cscli_backup.md

@@ -0,0 +1,39 @@
+## cscli backup
+
+Backup or restore configuration (api, parsers, scenarios etc.) to/from directory
+
+### Synopsis
+
+This command is here to help you save and/or restore crowdsec configurations to simple replication
+
+### Examples
+
+```
+cscli backup save ./my-backup
+cscli backup restore ./my-backup
+```
+
+### Options
+
+```
+  -h, --help   help for backup
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli backup restore](cscli_backup_restore.md)	 - Restore configuration (api, parsers, scenarios etc.) from directory
+* [cscli backup save](cscli_backup_save.md)	 - Backup configuration (api, parsers, scenarios etc.) to directory
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 49 - 0
cmd/crowdsec-cli/doc/cscli_backup_restore.md

@@ -0,0 +1,49 @@
+## cscli backup restore
+
+Restore configuration (api, parsers, scenarios etc.) from directory
+
+### Synopsis
+
+restore command will try to restore all saved information from <directory> to yor local setup, including :
+
+- Installation of up-to-date scenarios/parsers/... via cscli
+
+- Restauration of tainted/local/out-of-date scenarios/parsers/... file
+
+- Restauration of API credentials (if the existing ones aren't working)
+
+- Restauration of acqusition configuration
+
+
+```
+cscli backup restore <directory> [flags]
+```
+
+### Examples
+
+```
+cscli backup restore ./my-backup
+```
+
+### Options
+
+```
+  -h, --help   help for restore
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli backup](cscli_backup.md)	 - Backup or restore configuration (api, parsers, scenarios etc.) to/from directory
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 50 - 0
cmd/crowdsec-cli/doc/cscli_backup_save.md

@@ -0,0 +1,50 @@
+## cscli backup save
+
+Backup configuration (api, parsers, scenarios etc.) to directory
+
+### Synopsis
+
+backup command will try to save all relevant informations to crowdsec config, including :
+
+- List of scenarios, parsers, postoverflows and collections that are up-to-date
+
+- Actual backup of tainted/local/out-of-date scenarios, parsers, postoverflows and collections
+
+- Backup of API credentials
+
+- Backup of acqusition configuration
+		
+		
+
+```
+cscli backup save <directory> [flags]
+```
+
+### Examples
+
+```
+cscli backup save ./my-backup
+```
+
+### Options
+
+```
+  -h, --help   help for save
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli backup](cscli_backup.md)	 - Backup or restore configuration (api, parsers, scenarios etc.) to/from directory
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 38 - 0
cmd/crowdsec-cli/doc/cscli_ban.md

@@ -0,0 +1,38 @@
+## cscli ban
+
+Manage bans/mitigations
+
+### Synopsis
+
+This is the main interaction point with local ban database for humans.
+
+You can add/delete/list or flush current bans in your local ban DB.
+
+### Options
+
+```
+      --db string            Set path to SQLite DB.
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+  -h, --help                 help for ban
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli ban add](cscli_ban_add.md)	 - Adds a ban against a given ip/range for the provided duration
+* [cscli ban del](cscli_ban_del.md)	 - Delete bans from db
+* [cscli ban flush](cscli_ban_flush.md)	 - Fush ban DB
+* [cscli ban list](cscli_ban_list.md)	 - List local or api bans/remediations
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 46 - 0
cmd/crowdsec-cli/doc/cscli_ban_add.md

@@ -0,0 +1,46 @@
+## cscli ban add
+
+Adds a ban against a given ip/range for the provided duration
+
+### Synopsis
+
+
+Allows to add a ban against a specific ip or range target for a specific duration.  
+
+The duration argument can be expressed in seconds(s), minutes(m) or hours (h).
+		
+See [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) for more informations.
+
+### Examples
+
+```
+cscli ban add ip 1.2.3.4 24h "scan"  
+cscli ban add range 1.2.3.0/24 24h "the whole range"
+```
+
+### Options
+
+```
+  -h, --help   help for add
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban](cscli_ban.md)	 - Manage bans/mitigations
+* [cscli ban add ip](cscli_ban_add_ip.md)	 - Adds the specific ip to the ban db
+* [cscli ban add range](cscli_ban_add_range.md)	 - Adds the specific ip to the ban db
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_ban_add_ip.md

@@ -0,0 +1,42 @@
+## cscli ban add ip
+
+Adds the specific ip to the ban db
+
+### Synopsis
+
+Duration must be [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration), expressed in s/m/h.
+
+```
+cscli ban add ip <target> <duration> <reason> [flags]
+```
+
+### Examples
+
+```
+cscli ban add ip 1.2.3.4 12h "the scan"
+```
+
+### Options
+
+```
+  -h, --help   help for ip
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban add](cscli_ban_add.md)	 - Adds a ban against a given ip/range for the provided duration
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_ban_add_range.md

@@ -0,0 +1,42 @@
+## cscli ban add range
+
+Adds the specific ip to the ban db
+
+### Synopsis
+
+Duration must be [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) compatible, expressed in s/m/h.
+
+```
+cscli ban add range <target> <duration> <reason> [flags]
+```
+
+### Examples
+
+```
+cscli ban add range 1.2.3.0/24 12h "the whole range"
+```
+
+### Options
+
+```
+  -h, --help   help for range
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban add](cscli_ban_add.md)	 - Adds a ban against a given ip/range for the provided duration
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 41 - 0
cmd/crowdsec-cli/doc/cscli_ban_del.md

@@ -0,0 +1,41 @@
+## cscli ban del
+
+Delete bans from db
+
+### Synopsis
+
+The removal of the bans can be applied on a single IP address or directly on a IP range.
+
+### Examples
+
+```
+cscli ban del ip 1.2.3.4  
+cscli ban del range 1.2.3.0/24
+```
+
+### Options
+
+```
+  -h, --help   help for del
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban](cscli_ban.md)	 - Manage bans/mitigations
+* [cscli ban del ip](cscli_ban_del_ip.md)	 - Delete bans for given ip from db
+* [cscli ban del range](cscli_ban_del_range.md)	 - Delete bans for given ip from db
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_ban_del_ip.md

@@ -0,0 +1,42 @@
+## cscli ban del ip
+
+Delete bans for given ip from db
+
+### Synopsis
+
+Delete bans for given ip from db
+
+```
+cscli ban del ip <target> [flags]
+```
+
+### Examples
+
+```
+cscli ban del ip 1.2.3.4
+```
+
+### Options
+
+```
+  -h, --help   help for ip
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban del](cscli_ban_del.md)	 - Delete bans from db
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_ban_del_range.md

@@ -0,0 +1,42 @@
+## cscli ban del range
+
+Delete bans for given ip from db
+
+### Synopsis
+
+Delete bans for given ip from db
+
+```
+cscli ban del range <target> [flags]
+```
+
+### Examples
+
+```
+cscli ban del range 1.2.3.0/24
+```
+
+### Options
+
+```
+  -h, --help   help for range
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban del](cscli_ban_del.md)	 - Delete bans from db
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_ban_flush.md

@@ -0,0 +1,42 @@
+## cscli ban flush
+
+Fush ban DB
+
+### Synopsis
+
+Fush ban DB
+
+```
+cscli ban flush [flags]
+```
+
+### Examples
+
+```
+cscli ban flush
+```
+
+### Options
+
+```
+  -h, --help   help for flush
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban](cscli_ban.md)	 - Manage bans/mitigations
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 50 - 0
cmd/crowdsec-cli/doc/cscli_ban_list.md

@@ -0,0 +1,50 @@
+## cscli ban list
+
+List local or api bans/remediations
+
+### Synopsis
+
+List the bans, by default only local decisions.
+
+If --all/-a is specified, api-provided bans will be displayed too.
+
+Time can be specified with --at and support a variety of date formats:  
+ - Jan  2 15:04:05  
+ - Mon Jan 02 15:04:05.000000 2006  
+ - 2006-01-02T15:04:05Z07:00  
+ - 2006/01/02  
+ - 2006/01/02 15:04  
+ - 2006-01-02  
+ - 2006-01-02 15:04
+
+
+```
+cscli ban list [flags]
+```
+
+### Options
+
+```
+  -a, --all         List as well bans received from API
+      --at string   List bans at given time
+  -h, --help        help for list
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string    Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --db string            Set path to SQLite DB.
+      --debug                Set logging to debug.
+      --error                Set logging to error.
+      --info                 Set logging to info.
+  -o, --output string        Output format : human, json, raw. (default "human")
+      --remediation string   Set specific remediation type : ban|slow|captcha (default "ban")
+      --warning              Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli ban](cscli_ban.md)	 - Manage bans/mitigations
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_config.md

@@ -0,0 +1,42 @@
+## cscli config
+
+Allows to view/edit cscli config
+
+### Synopsis
+
+Allow to configure sqlite path and installation directory.
+If no commands are specified, config is in interactive mode.
+
+### Examples
+
+```
+ - cscli config show
+- cscli config prompt
+```
+
+### Options
+
+```
+  -h, --help   help for config
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli config backend](cscli_config_backend.md)	 - Configure installation directory
+* [cscli config installdir](cscli_config_installdir.md)	 - Configure installation directory
+* [cscli config prompt](cscli_config_prompt.md)	 - Prompt for configuration values in an interactive fashion
+* [cscli config show](cscli_config_show.md)	 - Displays current config
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 34 - 0
cmd/crowdsec-cli/doc/cscli_config_backend.md

@@ -0,0 +1,34 @@
+## cscli config backend
+
+Configure installation directory
+
+### Synopsis
+
+Configure the backend plugin directory of crowdsec, such as /etc/crowdsec/plugins/backend
+
+```
+cscli config backend [value] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for backend
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli config](cscli_config.md)	 - Allows to view/edit cscli config
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 34 - 0
cmd/crowdsec-cli/doc/cscli_config_installdir.md

@@ -0,0 +1,34 @@
+## cscli config installdir
+
+Configure installation directory
+
+### Synopsis
+
+Configure the installation directory of crowdsec, such as /etc/crowdsec/config/
+
+```
+cscli config installdir [value] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for installdir
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli config](cscli_config.md)	 - Allows to view/edit cscli config
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 34 - 0
cmd/crowdsec-cli/doc/cscli_config_prompt.md

@@ -0,0 +1,34 @@
+## cscli config prompt
+
+Prompt for configuration values in an interactive fashion
+
+### Synopsis
+
+Start interactive configuration of cli. It will successively ask for install dir, db path.
+
+```
+cscli config prompt [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for prompt
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli config](cscli_config.md)	 - Allows to view/edit cscli config
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 34 - 0
cmd/crowdsec-cli/doc/cscli_config_show.md

@@ -0,0 +1,34 @@
+## cscli config show
+
+Displays current config
+
+### Synopsis
+
+Displays the current cli configuration.
+
+```
+cscli config show [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for show
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli config](cscli_config.md)	 - Allows to view/edit cscli config
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_dashboard.md

@@ -0,0 +1,42 @@
+## cscli dashboard
+
+Start a dashboard (metabase) container.
+
+### Synopsis
+
+Start a metabase container exposing dashboards and metrics.
+
+### Examples
+
+```
+cscli dashboard setup
+cscli dashboard start
+cscli dashboard stop
+cscli dashboard setup --force
+```
+
+### Options
+
+```
+  -h, --help   help for dashboard
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli dashboard setup](cscli_dashboard_setup.md)	 - Setup a metabase container.
+* [cscli dashboard start](cscli_dashboard_start.md)	 - Start the metabase container.
+* [cscli dashboard stop](cscli_dashboard_stop.md)	 - Stops the metabase container.
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 47 - 0
cmd/crowdsec-cli/doc/cscli_dashboard_setup.md

@@ -0,0 +1,47 @@
+## cscli dashboard setup
+
+Setup a metabase container.
+
+### Synopsis
+
+Perform a metabase docker setup, download standard dashboards, create a fresh user and start the container
+
+```
+cscli dashboard setup [flags]
+```
+
+### Examples
+
+```
+cscli dashboard setup
+cscli dashboard setup --force
+cscli dashboard setup -l 0.0.0.0 -p 443
+ 
+```
+
+### Options
+
+```
+  -d, --dir string      Shared directory with metabase container. (default "/var/lib/crowdsec/data")
+  -f, --force           Force setup : override existing files.
+  -h, --help            help for setup
+  -l, --listen string   Listen address of container (default "127.0.0.1")
+  -p, --port string     Listen port of container (default "3000")
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli dashboard](cscli_dashboard.md)	 - Start a dashboard (metabase) container.
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 34 - 0
cmd/crowdsec-cli/doc/cscli_dashboard_start.md

@@ -0,0 +1,34 @@
+## cscli dashboard start
+
+Start the metabase container.
+
+### Synopsis
+
+Stats the metabase container using docker.
+
+```
+cscli dashboard start [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for start
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli dashboard](cscli_dashboard.md)	 - Start a dashboard (metabase) container.
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 35 - 0
cmd/crowdsec-cli/doc/cscli_dashboard_stop.md

@@ -0,0 +1,35 @@
+## cscli dashboard stop
+
+Stops the metabase container.
+
+### Synopsis
+
+Stops the metabase container using docker.
+
+```
+cscli dashboard stop [flags]
+```
+
+### Options
+
+```
+  -h, --help     help for stop
+  -r, --remove   remove (docker rm) container as well.
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli dashboard](cscli_dashboard.md)	 - Start a dashboard (metabase) container.
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 47 - 0
cmd/crowdsec-cli/doc/cscli_inspect.md

@@ -0,0 +1,47 @@
+## cscli inspect
+
+Inspect configuration(s)
+
+### Synopsis
+
+
+Inspect give you full detail about local installed configuration.
+
+[type] must be parser, scenario, postoverflow, collection.
+
+[config_name] must be a valid config name from [Crowdsec Hub](https://hub.crowdsec.net) or locally installed.
+
+
+### Examples
+
+```
+cscli inspect parser crowdsec/xxx  
+cscli inspect collection crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for inspect
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli inspect collection](cscli_inspect_collection.md)	 - Inspect given collection
+* [cscli inspect parser](cscli_inspect_parser.md)	 - Inspect given log parser
+* [cscli inspect postoverflow](cscli_inspect_postoverflow.md)	 - Inspect given postoverflow parser
+* [cscli inspect scenario](cscli_inspect_scenario.md)	 - Inspect given scenario
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_inspect_collection.md

@@ -0,0 +1,40 @@
+## cscli inspect collection
+
+Inspect given collection
+
+### Synopsis
+
+Inspect given collection from hub
+
+```
+cscli inspect collection [config] [flags]
+```
+
+### Examples
+
+```
+cscli inspect collection crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for collection
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli inspect](cscli_inspect.md)	 - Inspect configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_inspect_parser.md

@@ -0,0 +1,40 @@
+## cscli inspect parser
+
+Inspect given log parser
+
+### Synopsis
+
+Inspect given parser from hub
+
+```
+cscli inspect parser [config] [flags]
+```
+
+### Examples
+
+```
+cscli inspect parser crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for parser
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli inspect](cscli_inspect.md)	 - Inspect configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_inspect_postoverflow.md

@@ -0,0 +1,40 @@
+## cscli inspect postoverflow
+
+Inspect given postoverflow parser
+
+### Synopsis
+
+Inspect given postoverflow from hub.
+
+```
+cscli inspect postoverflow [config] [flags]
+```
+
+### Examples
+
+```
+cscli inspect postoverflow crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for postoverflow
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli inspect](cscli_inspect.md)	 - Inspect configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 40 - 0
cmd/crowdsec-cli/doc/cscli_inspect_scenario.md

@@ -0,0 +1,40 @@
+## cscli inspect scenario
+
+Inspect given scenario
+
+### Synopsis
+
+Inspect given scenario from hub
+
+```
+cscli inspect scenario [config] [flags]
+```
+
+### Examples
+
+```
+cscli inspect scenario crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for scenario
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli inspect](cscli_inspect.md)	 - Inspect configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 51 - 0
cmd/crowdsec-cli/doc/cscli_install.md

@@ -0,0 +1,51 @@
+## cscli install
+
+Install configuration(s) from hub
+
+### Synopsis
+
+
+Install configuration from the CrowdSec Hub.
+
+In order to download latest versions of configuration, 
+you should [update cscli](./cscli_update.md).
+
+[type] must be parser, scenario, postoverflow, collection.
+
+[config_name] must be a valid config name from [Crowdsec Hub](https://hub.crowdsec.net).
+
+
+### Examples
+
+```
+cscli install [type] [config_name]
+```
+
+### Options
+
+```
+  -d, --download-only   Only download packages, don't enable
+      --force           Force install : Overwrite tainted and outdated files
+  -h, --help            help for install
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli install collection](cscli_install_collection.md)	 - Install given collection
+* [cscli install parser](cscli_install_parser.md)	 - Install given log parser
+* [cscli install postoverflow](cscli_install_postoverflow.md)	 - Install given postoverflow parser
+* [cscli install scenario](cscli_install_scenario.md)	 - Install given scenario
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_install_collection.md

@@ -0,0 +1,42 @@
+## cscli install collection
+
+Install given collection
+
+### Synopsis
+
+Fetch and install given collection from hub
+
+```
+cscli install collection [config] [flags]
+```
+
+### Examples
+
+```
+cscli install collection crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for collection
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+  -d, --download-only       Only download packages, don't enable
+      --error               Set logging to error.
+      --force               Force install : Overwrite tainted and outdated files
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli install](cscli_install.md)	 - Install configuration(s) from hub
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_install_parser.md

@@ -0,0 +1,42 @@
+## cscli install parser
+
+Install given log parser
+
+### Synopsis
+
+Fetch and install given parser from hub
+
+```
+cscli install parser [config] [flags]
+```
+
+### Examples
+
+```
+cscli install parser crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for parser
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+  -d, --download-only       Only download packages, don't enable
+      --error               Set logging to error.
+      --force               Force install : Overwrite tainted and outdated files
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli install](cscli_install.md)	 - Install configuration(s) from hub
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 43 - 0
cmd/crowdsec-cli/doc/cscli_install_postoverflow.md

@@ -0,0 +1,43 @@
+## cscli install postoverflow
+
+Install given postoverflow parser
+
+### Synopsis
+
+Fetch and install given postoverflow from hub.
+As a reminder, postoverflows are parsing configuration that will occur after the overflow (before a decision is applied).
+
+```
+cscli install postoverflow [config] [flags]
+```
+
+### Examples
+
+```
+cscli install collection crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for postoverflow
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+  -d, --download-only       Only download packages, don't enable
+      --error               Set logging to error.
+      --force               Force install : Overwrite tainted and outdated files
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli install](cscli_install.md)	 - Install configuration(s) from hub
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 42 - 0
cmd/crowdsec-cli/doc/cscli_install_scenario.md

@@ -0,0 +1,42 @@
+## cscli install scenario
+
+Install given scenario
+
+### Synopsis
+
+Fetch and install given scenario from hub
+
+```
+cscli install scenario [config] [flags]
+```
+
+### Examples
+
+```
+cscli install scenario crowdsec/xxx
+```
+
+### Options
+
+```
+  -h, --help   help for scenario
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+  -d, --download-only       Only download packages, don't enable
+      --error               Set logging to error.
+      --force               Force install : Overwrite tainted and outdated files
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli install](cscli_install.md)	 - Install configuration(s) from hub
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 54 - 0
cmd/crowdsec-cli/doc/cscli_list.md

@@ -0,0 +1,54 @@
+## cscli list
+
+List enabled configs
+
+### Synopsis
+
+
+List enabled configurations (parser/scenarios/collections) on your host.
+
+It is possible to list also configuration from [Crowdsec Hub](https://hub.crowdsec.net) with the '-a' options.
+
+[type] must be parsers, scenarios, postoverflows, collections
+		
+
+```
+cscli list [-a] [flags]
+```
+
+### Examples
+
+```
+cscli list  # List all local configurations
+cscli list [type] # List all local configuration of type [type]
+cscli list -a # List all local and remote configurations
+		
+```
+
+### Options
+
+```
+  -a, --all    List as well disabled items
+  -h, --help   help for list
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli list collections](cscli_list_collections.md)	 - List enabled collections
+* [cscli list parsers](cscli_list_parsers.md)	 - List enabled parsers
+* [cscli list postoverflows](cscli_list_postoverflows.md)	 - List enabled postoverflow parsers
+* [cscli list scenarios](cscli_list_scenarios.md)	 - List enabled scenarios
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 35 - 0
cmd/crowdsec-cli/doc/cscli_list_collections.md

@@ -0,0 +1,35 @@
+## cscli list collections
+
+List enabled collections
+
+### Synopsis
+
+List enabled collections
+
+```
+cscli list collections [-a] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for collections
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --all                 List as well disabled items
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli list](cscli_list.md)	 - List enabled configs
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 35 - 0
cmd/crowdsec-cli/doc/cscli_list_parsers.md

@@ -0,0 +1,35 @@
+## cscli list parsers
+
+List enabled parsers
+
+### Synopsis
+
+List enabled parsers
+
+```
+cscli list parsers [-a] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for parsers
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --all                 List as well disabled items
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli list](cscli_list.md)	 - List enabled configs
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 35 - 0
cmd/crowdsec-cli/doc/cscli_list_postoverflows.md

@@ -0,0 +1,35 @@
+## cscli list postoverflows
+
+List enabled postoverflow parsers
+
+### Synopsis
+
+List enabled postoverflow parsers
+
+```
+cscli list postoverflows [-a] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for postoverflows
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --all                 List as well disabled items
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli list](cscli_list.md)	 - List enabled configs
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 35 - 0
cmd/crowdsec-cli/doc/cscli_list_scenarios.md

@@ -0,0 +1,35 @@
+## cscli list scenarios
+
+List enabled scenarios
+
+### Synopsis
+
+List enabled scenarios
+
+```
+cscli list scenarios [-a] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for scenarios
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --all                 List as well disabled items
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli list](cscli_list.md)	 - List enabled configs
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 35 - 0
cmd/crowdsec-cli/doc/cscli_metrics.md

@@ -0,0 +1,35 @@
+## cscli metrics
+
+Display crowdsec prometheus metrics.
+
+### Synopsis
+
+Fetch metrics from the prometheus server and display them in a human-friendly way
+
+```
+cscli metrics [flags]
+```
+
+### Options
+
+```
+  -h, --help         help for metrics
+  -u, --url string   Prometheus url (default "http://127.0.0.1:6060/metrics")
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 48 - 0
cmd/crowdsec-cli/doc/cscli_remove.md

@@ -0,0 +1,48 @@
+## cscli remove
+
+Remove/disable configuration(s)
+
+### Synopsis
+
+
+ Remove local configuration. 
+ 
+[type] must be parser, scenario, postoverflow, collection
+
+[config_name] must be a valid config name from [Crowdsec Hub](https://hub.crowdsec.net) or locally installed.
+ 
+
+### Examples
+
+```
+cscli remove [type] [config_name]
+```
+
+### Options
+
+```
+      --all     Delete all the files in selected scope
+  -h, --help    help for remove
+      --purge   Delete source file in ~/.cscli/hub/ too
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli remove collection](cscli_remove_collection.md)	 - Remove/disable collection
+* [cscli remove parser](cscli_remove_parser.md)	 - Remove/disable parser
+* [cscli remove postoverflow](cscli_remove_postoverflow.md)	 - Remove/disable postoverflow parser
+* [cscli remove scenario](cscli_remove_scenario.md)	 - Remove/disable scenario
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 36 - 0
cmd/crowdsec-cli/doc/cscli_remove_collection.md

@@ -0,0 +1,36 @@
+## cscli remove collection
+
+Remove/disable collection
+
+### Synopsis
+
+<config> must be a valid collection.
+
+```
+cscli remove collection [config] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for collection
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Delete all the files in selected scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --purge               Delete source file in ~/.cscli/hub/ too
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli remove](cscli_remove.md)	 - Remove/disable configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 36 - 0
cmd/crowdsec-cli/doc/cscli_remove_parser.md

@@ -0,0 +1,36 @@
+## cscli remove parser
+
+Remove/disable parser
+
+### Synopsis
+
+<config> must be a valid parser.
+
+```
+cscli remove parser <config> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for parser
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Delete all the files in selected scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --purge               Delete source file in ~/.cscli/hub/ too
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli remove](cscli_remove.md)	 - Remove/disable configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 36 - 0
cmd/crowdsec-cli/doc/cscli_remove_postoverflow.md

@@ -0,0 +1,36 @@
+## cscli remove postoverflow
+
+Remove/disable postoverflow parser
+
+### Synopsis
+
+<config> must be a valid collection.
+
+```
+cscli remove postoverflow [config] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for postoverflow
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Delete all the files in selected scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --purge               Delete source file in ~/.cscli/hub/ too
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli remove](cscli_remove.md)	 - Remove/disable configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 36 - 0
cmd/crowdsec-cli/doc/cscli_remove_scenario.md

@@ -0,0 +1,36 @@
+## cscli remove scenario
+
+Remove/disable scenario
+
+### Synopsis
+
+<config> must be a valid scenario.
+
+```
+cscli remove scenario [config] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for scenario
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Delete all the files in selected scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --purge               Delete source file in ~/.cscli/hub/ too
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli remove](cscli_remove.md)	 - Remove/disable configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 36 - 0
cmd/crowdsec-cli/doc/cscli_update.md

@@ -0,0 +1,36 @@
+## cscli update
+
+Fetch available configs from hub
+
+### Synopsis
+
+
+Fetches the [.index.json](https://github.com/crowdsecurity/hub/blob/master/.index.json) file from hub, containing the list of available configs.
+
+
+```
+cscli update [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for update
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 62 - 0
cmd/crowdsec-cli/doc/cscli_upgrade.md

@@ -0,0 +1,62 @@
+## cscli upgrade
+
+Upgrade configuration(s)
+
+### Synopsis
+
+
+Upgrade configuration from the CrowdSec Hub.
+
+In order to upgrade latest versions of configuration, 
+the Hub cache should be [updated](./cscli_update.md).
+ 
+Tainted configuration will not be updated (use --force to update them).
+
+[type] must be parser, scenario, postoverflow, collection.
+
+[config_name] must be a valid config name from [Crowdsec Hub](https://hub.crowdsec.net).
+ 
+
+ 
+
+```
+cscli upgrade [type] [config] [flags]
+```
+
+### Examples
+
+```
+cscli upgrade [type] [config_name]
+cscli upgrade --all   # Upgrade all configurations types
+cscli upgrade --force # Overwrite tainted configuration
+		
+```
+
+### Options
+
+```
+      --all     Upgrade all configuration in scope
+      --force   Overwrite existing files, even if tainted
+  -h, --help    help for upgrade
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli](cscli.md)	 - cscli allows you to manage crowdsec
+* [cscli upgrade collection](cscli_upgrade_collection.md)	 - Upgrade collection configuration(s)
+* [cscli upgrade parser](cscli_upgrade_parser.md)	 - Upgrade parser configuration(s)
+* [cscli upgrade postoverflow](cscli_upgrade_postoverflow.md)	 - Upgrade postoverflow parser configuration(s)
+* [cscli upgrade scenario](cscli_upgrade_scenario.md)	 - Upgrade scenario configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 44 - 0
cmd/crowdsec-cli/doc/cscli_upgrade_collection.md

@@ -0,0 +1,44 @@
+## cscli upgrade collection
+
+Upgrade collection configuration(s)
+
+### Synopsis
+
+Upgrade one or more collection configurations
+
+```
+cscli upgrade collection [config] [flags]
+```
+
+### Examples
+
+```
+ - cscli upgrade collection crowdsec/apache-lamp  
+ - cscli upgrade collection -all  
+ - cscli upgrade collection crowdsec/apache-lamp --force
+```
+
+### Options
+
+```
+  -h, --help   help for collection
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Upgrade all configuration in scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --force               Overwrite existing files, even if tainted
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli upgrade](cscli_upgrade.md)	 - Upgrade configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 44 - 0
cmd/crowdsec-cli/doc/cscli_upgrade_parser.md

@@ -0,0 +1,44 @@
+## cscli upgrade parser
+
+Upgrade parser configuration(s)
+
+### Synopsis
+
+Upgrade one or more parser configurations
+
+```
+cscli upgrade parser [config] [flags]
+```
+
+### Examples
+
+```
+ - cscli upgrade parser crowdsec/apache-logs  
+ - cscli upgrade parser -all  
+ - cscli upgrade parser crowdsec/apache-logs --force
+```
+
+### Options
+
+```
+  -h, --help   help for parser
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Upgrade all configuration in scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --force               Overwrite existing files, even if tainted
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli upgrade](cscli_upgrade.md)	 - Upgrade configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 44 - 0
cmd/crowdsec-cli/doc/cscli_upgrade_postoverflow.md

@@ -0,0 +1,44 @@
+## cscli upgrade postoverflow
+
+Upgrade postoverflow parser configuration(s)
+
+### Synopsis
+
+Upgrade one or more postoverflow parser configurations
+
+```
+cscli upgrade postoverflow [config] [flags]
+```
+
+### Examples
+
+```
+ - cscli upgrade postoverflow crowdsec/enrich-rdns  
+ - cscli upgrade postoverflow -all  
+ - cscli upgrade postoverflow crowdsec/enrich-rdns --force
+```
+
+### Options
+
+```
+  -h, --help   help for postoverflow
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Upgrade all configuration in scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --force               Overwrite existing files, even if tainted
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli upgrade](cscli_upgrade.md)	 - Upgrade configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020

+ 43 - 0
cmd/crowdsec-cli/doc/cscli_upgrade_scenario.md

@@ -0,0 +1,43 @@
+## cscli upgrade scenario
+
+Upgrade scenario configuration(s)
+
+### Synopsis
+
+Upgrade one or more scenario configurations
+
+```
+cscli upgrade scenario [config] [flags]
+```
+
+### Examples
+
+```
+ - cscli	upgrade scenario -all  
+ - cscli upgrade scenario crowdsec/http-404 --force  
+```
+
+### Options
+
+```
+  -h, --help   help for scenario
+```
+
+### Options inherited from parent commands
+
+```
+      --all                 Upgrade all configuration in scope
+  -c, --config-dir string   Configuration directory to use. (default "/etc/crowdsec/cscli/")
+      --debug               Set logging to debug.
+      --error               Set logging to error.
+      --force               Overwrite existing files, even if tainted
+      --info                Set logging to info.
+  -o, --output string       Output format : human, json, raw. (default "human")
+      --warning             Set logging to warning.
+```
+
+### SEE ALSO
+
+* [cscli upgrade](cscli_upgrade.md)	 - Upgrade configuration(s)
+
+###### Auto generated by spf13/cobra on 15-May-2020