Cscli

`` is the utility that will help you to manage Crowdsec. This tools has the following functionalities:

• manage bans
• backup and restore configuration
• display metrics
• install configurations
• remove configurations
• update configurations
• upgrade configurations
• list configurations
• interact with CrowdSec API
• manage simulation

Take a look at the dedicated documentation

Overview

cscli configuration location is /etc/crowdsec/cscli/.

In this folder, we store the cscli configuration and the hub cache files.

Config

The cscli configuration is light for now, stored in /etc/crowdsec/cscli/config.

installdir: /etc/crowdsec/config   # Crowdsec configuration location
backend: /etc/crowdsec/plugins/backend # path to the backend plugin used

For cscli to be able to pull the topX, you need a valid API configuration in api.yaml.

Hub cache

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

This is used to manage configurations from the cscli