crowdsec/docs/guide/cscli.md

{{cli.bin}} is the utility that will help you to manage {{crowdsec.name}}. This tools has the following functionalities:

• manage bans : list, add, remove ...
• backup and restore configuration
• display metrics
• install parsers/scenarios/collections
• remove parsers/scenarios/collections
• update the hub cache
• upgrade parsers/scenarios/collections
• list parsers/scenarios/collections
• interact with CrowdSec API

Overview

{{cli.name}} configuration location is /etc/crowdsec/cscli/.

In this folder, we store the {{cli.name}} configuration and the hub cache files.

Config

The {{cli.name}} configuration is light for now, stored in /etc/crowdsec/cscli/config.

installdir: /etc/crowdsec/config   # {{crowdsec.name}} configuration location
backend: /etc/crowdsec/plugins/backend # path to the backend plugin used

For {{cli.name}} to be able to pull the {{api.topX.htmlname}}, you need a valid API configuration in api.yaml.

Hub cache

• .index.json: The file containing the metadata of all the existing {{collections.htmlname}}, {{parsers.htmlname}} and {{scenarios.htmlname}} stored in the {{hub.htmlname}}.
• hub/*: Folder containing all the {{collections.htmlname}}, {{parsers.htmlname}} and {{scenarios.htmlname}} stored in the {{hub.htmlname}}.

This is used to manage configurations from the {{cli.name}}