7363 lines
243 KiB
JSON
7363 lines
243 KiB
JSON
{
|
|
"version": "version: v1.7.8-debian-pragmatic-amd64-63227459",
|
|
"generated": "2026-05-18T18:48:55Z",
|
|
"root": {
|
|
"command": "cscli",
|
|
"description": "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 your crowdsec setup.",
|
|
"usage": "cscli [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for cscli"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli alerts",
|
|
"description": "Manage alerts",
|
|
"usage": "cscli alerts [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for alerts"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli alerts delete",
|
|
"description": "Delete alerts /!\\ This command can be used only on the same machine than the local API.",
|
|
"usage": "cscli alerts delete [filters] [--all] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--scope string",
|
|
"description": "the scope (ie. ip,range)"
|
|
},
|
|
{
|
|
"flag": "-v, --value string",
|
|
"description": "the value to match for in the specified scope"
|
|
},
|
|
{
|
|
"flag": "-s, --scenario string",
|
|
"description": "the scenario (ie. crowdsecurity/ssh-bf)"
|
|
},
|
|
{
|
|
"flag": "-i, --ip string",
|
|
"description": "Source ip (shorthand for --scope ip --value <IP>)"
|
|
},
|
|
{
|
|
"flag": "-r, --range string",
|
|
"description": "Range source ip (shorthand for --scope range --value <RANGE>)"
|
|
},
|
|
{
|
|
"flag": "--id string",
|
|
"description": "alert ID"
|
|
},
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "delete all alerts"
|
|
},
|
|
{
|
|
"flag": "--contained",
|
|
"description": "query decisions contained by range"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for delete"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli allowlists",
|
|
"description": "Manage centralized allowlists",
|
|
"usage": "cscli allowlists [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for allowlists"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli allowlists add",
|
|
"description": "Add content to an allowlist",
|
|
"usage": "cscli allowlists add [allowlist_name] [value...] [-e expiration] [-d comment] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --comment string",
|
|
"description": "comment for the value"
|
|
},
|
|
{
|
|
"flag": "-e, --expiration duration",
|
|
"description": "expiration duration (default 0s)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for add"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists check",
|
|
"description": "Check if a value is in an allowlist",
|
|
"usage": "cscli allowlists check [value...] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for check"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists create",
|
|
"description": "Create a new allowlist",
|
|
"usage": "cscli allowlists create [allowlist_name] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --description string",
|
|
"description": "description of the allowlist"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for create"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists delete",
|
|
"description": "Delete an allowlist",
|
|
"usage": "cscli allowlists delete [allowlist_name] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for delete"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists import",
|
|
"description": "Import values to an allowlist from a CSV file.",
|
|
"usage": "cscli allowlists import [allowlist_name] -i <file> [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for import"
|
|
},
|
|
{
|
|
"flag": "-i, --input string",
|
|
"description": "Input file (use - for stdin)"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists inspect",
|
|
"description": "Inspect an allowlist",
|
|
"usage": "cscli allowlists inspect [allowlist_name] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists list",
|
|
"description": "List all allowlists",
|
|
"usage": "cscli allowlists list [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli allowlists remove",
|
|
"description": "Remove content from an allowlist",
|
|
"usage": "cscli allowlists remove [allowlist_name] [value] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli appsec-configs",
|
|
"description": "Manage hub appsec-configs",
|
|
"usage": "cscli appsec-configs <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for appsec-configs"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli appsec-configs inspect",
|
|
"description": "Inspect the state of one or more appsec-configs",
|
|
"usage": "cscli appsec-configs inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-configs install",
|
|
"description": "Fetch and install one or more appsec-configs from the hub",
|
|
"usage": "cscli appsec-configs install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple appsec-configs"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-configs list",
|
|
"description": "List of installed/available/specified appsec-configs",
|
|
"usage": "cscli appsec-configs list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-configs remove",
|
|
"description": "Remove one or more appsec-configs",
|
|
"usage": "cscli appsec-configs remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the appsec-configs"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-configs upgrade",
|
|
"description": "Fetch and upgrade one or more appsec-configs from the hub",
|
|
"usage": "cscli appsec-configs upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the appsec-configs"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli appsec-rules",
|
|
"description": "Manage hub appsec-rules",
|
|
"usage": "cscli appsec-rules <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for appsec-rules"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli appsec-rules inspect",
|
|
"description": "Inspect the state of one or more appsec-rules",
|
|
"usage": "cscli appsec-rules inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-rules install",
|
|
"description": "Fetch and install one or more appsec-rules from the hub",
|
|
"usage": "cscli appsec-rules install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple appsec-rules"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-rules list",
|
|
"description": "List of installed/available/specified appsec-rules",
|
|
"usage": "cscli appsec-rules list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-rules remove",
|
|
"description": "Remove one or more appsec-rules",
|
|
"usage": "cscli appsec-rules remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the appsec-rules"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli appsec-rules upgrade",
|
|
"description": "Fetch and upgrade one or more appsec-rules from the hub",
|
|
"usage": "cscli appsec-rules upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the appsec-rules"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli bouncers",
|
|
"description": "To list/add/delete/prune bouncers. Note: This command requires database direct access, so is intended to be run on Local API/master.",
|
|
"usage": "cscli bouncers [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for bouncers"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli bouncers add",
|
|
"description": "add a single bouncer to the database",
|
|
"usage": "cscli bouncers add MyBouncerName [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for add"
|
|
},
|
|
{
|
|
"flag": "-k, --key string",
|
|
"description": "api key for the bouncer"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli bouncers delete",
|
|
"description": "delete bouncer(s) from the database",
|
|
"usage": "cscli bouncers delete MyBouncerName [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for delete"
|
|
},
|
|
{
|
|
"flag": "--ignore-missing",
|
|
"description": "don't print errors if one or more bouncers don't exist"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli bouncers inspect",
|
|
"description": "inspect a bouncer by name",
|
|
"usage": "cscli bouncers inspect [bouncer_name] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli bouncers list",
|
|
"description": "list all bouncers within the database",
|
|
"usage": "cscli bouncers list [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli bouncers prune",
|
|
"description": "prune multiple bouncers from the database",
|
|
"usage": "cscli bouncers prune [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --duration duration",
|
|
"description": "duration of time since last pull (default 1h0m0s)"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "force prune without asking for confirmation"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for prune"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli capi",
|
|
"description": "Manage interaction with Central API (CAPI)",
|
|
"usage": "cscli capi [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for capi"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli capi register",
|
|
"description": "Register to Central API (CAPI)",
|
|
"usage": "cscli capi register [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-f, --file string",
|
|
"description": "output file destination"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for register"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli capi status",
|
|
"description": "Check status with the Central API (CAPI)",
|
|
"usage": "cscli capi status [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for status"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli collections",
|
|
"description": "Manage hub collections",
|
|
"usage": "cscli collections <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for collections"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli collections inspect",
|
|
"description": "Inspect the state of one or more collections",
|
|
"usage": "cscli collections inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli collections install",
|
|
"description": "Fetch and install one or more collections from the hub",
|
|
"usage": "cscli collections install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple collections"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli collections list",
|
|
"description": "List of installed/available/specified collections",
|
|
"usage": "cscli collections list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli collections remove",
|
|
"description": "Remove one or more collections",
|
|
"usage": "cscli collections remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the collections"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli collections upgrade",
|
|
"description": "Fetch and upgrade one or more collections from the hub",
|
|
"usage": "cscli collections upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the collections"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli completion",
|
|
"description": "To load completions:",
|
|
"usage": "cscli completion [bash|zsh|powershell|fish]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for completion"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli config",
|
|
"description": "Allows to view current config",
|
|
"usage": "cscli config [command] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for config"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli config feature-flags",
|
|
"description": "Displays the supported feature flags and their current status.",
|
|
"usage": "cscli config feature-flags [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for feature-flags"
|
|
},
|
|
{
|
|
"flag": "--retired",
|
|
"description": "Show retired features"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli config show",
|
|
"description": "Displays the current cli configuration.",
|
|
"usage": "cscli config show [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for show"
|
|
},
|
|
{
|
|
"flag": "--key string",
|
|
"description": "Display only this value (Config.API.Server.ListenURI)"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli config show-yaml",
|
|
"description": "Displays merged config.yaml + config.yaml.local",
|
|
"usage": "cscli config show-yaml [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for show-yaml"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli console",
|
|
"description": "Manage interaction with Crowdsec console (https://app.crowdsec.net)",
|
|
"usage": "cscli console [command]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for console"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli console disable",
|
|
"description": "Disable given information push to the central API.",
|
|
"usage": "cscli console disable [option] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Disable all console options"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for disable"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli console enable",
|
|
"description": "Enable given information push to the central API. Allows to empower the console",
|
|
"usage": "cscli console enable [option]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Enable all console options"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for enable"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli console enroll",
|
|
"description": "Enroll this instance to https://app.crowdsec.net",
|
|
"usage": "cscli console enroll [enroll-key] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --disable strings",
|
|
"description": "Disable console options"
|
|
},
|
|
{
|
|
"flag": "-e, --enable strings",
|
|
"description": "Enable console options"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for enroll"
|
|
},
|
|
{
|
|
"flag": "-n, --name string",
|
|
"description": "Name to display in the console (default \"mywebserver\")"
|
|
},
|
|
{
|
|
"flag": "--overwrite",
|
|
"description": "Force enroll the instance"
|
|
},
|
|
{
|
|
"flag": "-q, --quick",
|
|
"description": "Enrolls the instance without an enroll key by visiting a link to the CrowdSec console."
|
|
},
|
|
{
|
|
"flag": "-t, --tags strings",
|
|
"description": "Tags to display in the console"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli console status",
|
|
"description": "Shows status of the console options",
|
|
"usage": "cscli console status [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for status"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli contexts",
|
|
"description": "Manage hub contexts",
|
|
"usage": "cscli contexts <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for contexts"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli contexts inspect",
|
|
"description": "Inspect the state of one or more contexts",
|
|
"usage": "cscli contexts inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli contexts install",
|
|
"description": "Fetch and install one or more contexts from the hub",
|
|
"usage": "cscli contexts install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple contexts"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli contexts list",
|
|
"description": "List of installed/available/specified contexts",
|
|
"usage": "cscli contexts list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli contexts remove",
|
|
"description": "Remove one or more contexts",
|
|
"usage": "cscli contexts remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the contexts"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli contexts upgrade",
|
|
"description": "Fetch and upgrade one or more contexts from the hub",
|
|
"usage": "cscli contexts upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the contexts"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli decisions",
|
|
"description": "Add/List/Delete/Import decisions from LAPI",
|
|
"usage": "cscli decisions [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for decisions"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli decisions add",
|
|
"description": "Add decision to LAPI",
|
|
"usage": "cscli decisions add [options] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-i, --ip string",
|
|
"description": "Source ip (shorthand for --scope ip --value <IP>)"
|
|
},
|
|
{
|
|
"flag": "-r, --range string",
|
|
"description": "Range source ip (shorthand for --scope range --value <RANGE>)"
|
|
},
|
|
{
|
|
"flag": "-d, --duration string",
|
|
"description": "Decision duration (ie. 1h,4h,30m) (default \"4h\")"
|
|
},
|
|
{
|
|
"flag": "-v, --value string",
|
|
"description": "The value (ie. --scope username --value foobar)"
|
|
},
|
|
{
|
|
"flag": "--scope string",
|
|
"description": "Decision scope (ie. ip,range,username) (default \"Ip\")"
|
|
},
|
|
{
|
|
"flag": "-R, --reason string",
|
|
"description": "Decision reason (ie. scenario-name)"
|
|
},
|
|
{
|
|
"flag": "-t, --type string",
|
|
"description": "Decision type (ie. ban,captcha,throttle) (default \"ban\")"
|
|
},
|
|
{
|
|
"flag": "-B, --bypass-allowlist",
|
|
"description": "Add decision even if value is in allowlist"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for add"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli decisions delete",
|
|
"description": "Delete decisions",
|
|
"usage": "cscli decisions delete [options] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-i, --ip string",
|
|
"description": "Source ip (shorthand for --scope ip --value <IP>)"
|
|
},
|
|
{
|
|
"flag": "-r, --range string",
|
|
"description": "Range source ip (shorthand for --scope range --value <RANGE>)"
|
|
},
|
|
{
|
|
"flag": "-t, --type string",
|
|
"description": "the decision type (ie. ban,captcha)"
|
|
},
|
|
{
|
|
"flag": "-v, --value string",
|
|
"description": "the value to match for in the specified scope"
|
|
},
|
|
{
|
|
"flag": "-s, --scenario string",
|
|
"description": "the scenario name (ie. crowdsecurity/ssh-bf)"
|
|
},
|
|
{
|
|
"flag": "--origin string",
|
|
"description": "the value to match for the specified origin (cscli,crowdsec,console,cscli-import,lists,CAPI,remediation_sync ...)"
|
|
},
|
|
{
|
|
"flag": "--id string",
|
|
"description": "decision id"
|
|
},
|
|
{
|
|
"flag": "--all",
|
|
"description": "delete all decisions"
|
|
},
|
|
{
|
|
"flag": "--contained",
|
|
"description": "query decisions contained by range"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for delete"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli decisions import",
|
|
"description": "expected format: csv : any of duration,reason,scope,type,value, with a header line json :`{\"duration\": \"24h\", \"reason\": \"my_scenario\", \"scope\": \"ip\", \"type\": \"ban\", \"value\": \"x.y.z.z\"}`",
|
|
"usage": "cscli decisions import [options] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-i, --input string",
|
|
"description": "Input file"
|
|
},
|
|
{
|
|
"flag": "-d, --duration string",
|
|
"description": "Decision duration: 1h,4h,30m (default \"4h\")"
|
|
},
|
|
{
|
|
"flag": "--scope string",
|
|
"description": "Decision scope: ip,range,username (default \"Ip\")"
|
|
},
|
|
{
|
|
"flag": "-R, --reason string",
|
|
"description": "Decision reason: <scenario-name> (default \"manual\")"
|
|
},
|
|
{
|
|
"flag": "-t, --type string",
|
|
"description": "Decision type: ban,captcha,throttle (default \"ban\")"
|
|
},
|
|
{
|
|
"flag": "--batch int",
|
|
"description": "Split import in batches of N decisions"
|
|
},
|
|
{
|
|
"flag": "--format string",
|
|
"description": "Input format: 'json', 'csv' or 'values' (each line is a value, no headers)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for import"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli decisions list",
|
|
"description": "List decisions from LAPI",
|
|
"usage": "cscli decisions list [options] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Include decisions from Central API"
|
|
},
|
|
{
|
|
"flag": "--since duration",
|
|
"description": "restrict to alerts newer than since (ie. 4h, 30d) (default 0s)"
|
|
},
|
|
{
|
|
"flag": "--until duration",
|
|
"description": "restrict to alerts older than until (ie. 4h, 30d) (default 0s)"
|
|
},
|
|
{
|
|
"flag": "-t, --type string",
|
|
"description": "restrict to this decision type (ie. ban,captcha)"
|
|
},
|
|
{
|
|
"flag": "--scope string",
|
|
"description": "restrict to this scope (ie. ip,range,session)"
|
|
},
|
|
{
|
|
"flag": "--origin string",
|
|
"description": "the value to match for the specified origin (cscli,crowdsec,console,cscli-import,lists,CAPI,remediation_sync ...)"
|
|
},
|
|
{
|
|
"flag": "-v, --value string",
|
|
"description": "restrict to this value (ie. 1.2.3.4,userName)"
|
|
},
|
|
{
|
|
"flag": "-s, --scenario string",
|
|
"description": "restrict to this scenario (ie. crowdsecurity/ssh-bf)"
|
|
},
|
|
{
|
|
"flag": "-i, --ip string",
|
|
"description": "restrict to alerts from this source ip (shorthand for --scope ip --value <IP>)"
|
|
},
|
|
{
|
|
"flag": "-r, --range string",
|
|
"description": "restrict to alerts from this source range (shorthand for --scope range --value <RANGE>)"
|
|
},
|
|
{
|
|
"flag": "-l, --limit int",
|
|
"description": "number of alerts to get (use 0 to remove the limit) (default 100)"
|
|
},
|
|
{
|
|
"flag": "--no-simu",
|
|
"description": "exclude decisions in simulation mode"
|
|
},
|
|
{
|
|
"flag": "-m, --machine",
|
|
"description": "print machines that triggered decisions"
|
|
},
|
|
{
|
|
"flag": "--contained",
|
|
"description": "query decisions contained by range"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli explain",
|
|
"description": "Explain log pipeline",
|
|
"usage": "cscli explain [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "-d, --dsn string",
|
|
"description": "DSN to test"
|
|
},
|
|
{
|
|
"flag": "--failures",
|
|
"description": "Only show failed lines"
|
|
},
|
|
{
|
|
"flag": "-f, --file string",
|
|
"description": "Log file to test"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for explain"
|
|
},
|
|
{
|
|
"flag": "--labels string",
|
|
"description": "Additional labels to add to the acquisition format (key:value,key2:value2)"
|
|
},
|
|
{
|
|
"flag": "-l, --log string",
|
|
"description": "Log line to test"
|
|
},
|
|
{
|
|
"flag": "--no-clean",
|
|
"description": "Don't clean runtime environment after tests"
|
|
},
|
|
{
|
|
"flag": "--only-successful-parsers",
|
|
"description": "Only show successful parsers"
|
|
},
|
|
{
|
|
"flag": "-t, --type string",
|
|
"description": "Type of the acquisition to test"
|
|
},
|
|
{
|
|
"flag": "-v, --verbose",
|
|
"description": "Display individual changes"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hub",
|
|
"description": "Hub management",
|
|
"usage": "cscli hub [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for hub"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli hub branch",
|
|
"description": "Display the hub branch to be used, depending on configuration and crowdsec version",
|
|
"usage": "cscli hub branch [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List all available items, including those not installed"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for branch"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hub list",
|
|
"description": "List all installed configurations",
|
|
"usage": "cscli hub list [-a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List all available items, including those not installed"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hub types",
|
|
"description": "List the types of supported hub items.",
|
|
"usage": "cscli hub types [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for types"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hub update",
|
|
"description": "Fetches the .index.json file from the hub, containing the list of available configs.",
|
|
"usage": "cscli hub update [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for update"
|
|
},
|
|
{
|
|
"flag": "--with-content",
|
|
"description": "Download index with embedded item content"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hub upgrade",
|
|
"description": "Upgrade all configs installed from Crowdsec Hub. Run 'sudo cscli hub update' if you want the latest versions available.",
|
|
"usage": "cscli hub upgrade [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated items; always update data files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli hubtest",
|
|
"description": "Run functional tests on hub configurations (parsers, scenarios, collections...)",
|
|
"usage": "cscli hubtest [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for hubtest"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli hubtest clean",
|
|
"description": "clean [test_name]",
|
|
"usage": "cscli hubtest clean [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Run all tests"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for clean"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest coverage",
|
|
"description": "coverage",
|
|
"usage": "cscli hubtest coverage [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Show only appsec coverage"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for coverage"
|
|
},
|
|
{
|
|
"flag": "--parsers",
|
|
"description": "Show only parsers coverage"
|
|
},
|
|
{
|
|
"flag": "--percent",
|
|
"description": "Show only percentages of coverage"
|
|
},
|
|
{
|
|
"flag": "--scenarios",
|
|
"description": "Show only scenarios coverage"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest create",
|
|
"description": "create [test_name]",
|
|
"usage": "cscli hubtest create [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for create"
|
|
},
|
|
{
|
|
"flag": "--ignore-parsers",
|
|
"description": "Don't run test on parsers"
|
|
},
|
|
{
|
|
"flag": "-p, --parsers strings",
|
|
"description": "Parsers to add to test"
|
|
},
|
|
{
|
|
"flag": "--postoverflows strings",
|
|
"description": "Postoverflows to add to test"
|
|
},
|
|
{
|
|
"flag": "-s, --scenarios strings",
|
|
"description": "Scenarios to add to test"
|
|
},
|
|
{
|
|
"flag": "-t, --type string",
|
|
"description": "Log type of the test"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest eval",
|
|
"description": "eval [test_name]...",
|
|
"usage": "cscli hubtest eval [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-e, --expr string",
|
|
"description": "Expression to eval"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for eval"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest explain",
|
|
"description": "explain [test_name]",
|
|
"usage": "cscli hubtest explain [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--failures",
|
|
"description": "Only show failed lines"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for explain"
|
|
},
|
|
{
|
|
"flag": "-v, --verbose",
|
|
"description": "Display individual changes"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest info",
|
|
"description": "info [test_name]",
|
|
"usage": "cscli hubtest info [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for info"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest list",
|
|
"description": "list",
|
|
"usage": "cscli hubtest list [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli hubtest run",
|
|
"description": "run [test_name]",
|
|
"usage": "cscli hubtest run [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Run all tests"
|
|
},
|
|
{
|
|
"flag": "--clean",
|
|
"description": "Clean runtime environment if test fail"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for run"
|
|
},
|
|
{
|
|
"flag": "--host string",
|
|
"description": "Address to expose AppSec for hubtest (default \"127.0.0.1:4241\")"
|
|
},
|
|
{
|
|
"flag": "--max-jobs uint",
|
|
"description": "Max number of concurrent tests (does not apply to appsec) (default 2)"
|
|
},
|
|
{
|
|
"flag": "--no-clean",
|
|
"description": "Don't clean runtime environment if test succeed"
|
|
},
|
|
{
|
|
"flag": "--report-success",
|
|
"description": "Report successful tests too (implied with json output)"
|
|
},
|
|
{
|
|
"flag": "--target string",
|
|
"description": "Target for AppSec Test (default \"http://127.0.0.1:7822/\")"
|
|
},
|
|
{
|
|
"flag": "--appsec",
|
|
"description": "Command relates to appsec tests"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--crowdsec string",
|
|
"description": "Path to crowdsec (default \"crowdsec\")"
|
|
},
|
|
{
|
|
"flag": "--cscli string",
|
|
"description": "Path to cscli (default \"cscli\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--hub string",
|
|
"description": "Path to hub folder (default \".\")"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli lapi",
|
|
"description": "Manage interaction with Local API (LAPI)",
|
|
"usage": "cscli lapi [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for lapi"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli lapi context",
|
|
"description": "Manage context to send with alerts",
|
|
"usage": "cscli lapi context [command]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for context"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli lapi context add",
|
|
"description": "Add context to send with alerts. You must specify the output key with the expr value you want",
|
|
"usage": "cscli lapi context add [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for add"
|
|
},
|
|
{
|
|
"flag": "-k, --key string",
|
|
"description": "The key of the different values to send"
|
|
},
|
|
{
|
|
"flag": "--value strings",
|
|
"description": "The expr fields to associate with the key"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli lapi context delete",
|
|
"description": "Usage: cscli lapi context delete [flags]",
|
|
"usage": "cscli lapi context delete [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for delete"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli lapi context detect",
|
|
"description": "Detect available fields from the installed parsers",
|
|
"usage": "cscli lapi context detect [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Detect evt field for all installed parser"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for detect"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli lapi context status",
|
|
"description": "List context to send with alerts",
|
|
"usage": "cscli lapi context status [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for status"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli lapi register",
|
|
"description": "Register your machine to the Local API (LAPI). Keep in mind the machine needs to be validated by an administrator on LAPI side to be effective.",
|
|
"usage": "cscli lapi register [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-f, --file string",
|
|
"description": "output file destination"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for register"
|
|
},
|
|
{
|
|
"flag": "--machine string",
|
|
"description": "Name of the machine to register with"
|
|
},
|
|
{
|
|
"flag": "--token string",
|
|
"description": "Auto registration token to use"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "URL of the API (ie. http://127.0.0.1)"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli lapi status",
|
|
"description": "Check authentication to Local API (LAPI)",
|
|
"usage": "cscli lapi status [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for status"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli machines",
|
|
"description": "To list/add/delete/validate/prune machines. Note: This command requires database direct access, so is intended to be run on the local API machine.",
|
|
"usage": "cscli machines [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for machines"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli machines add",
|
|
"description": "Register a new machine in the database. cscli should be on the same machine as LAPI.",
|
|
"usage": "cscli machines add [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --auto",
|
|
"description": "automatically generate password (and username if not provided)"
|
|
},
|
|
{
|
|
"flag": "-f, --file string",
|
|
"description": "output file destination (defaults to /etc/crowdsec/local_api_credentials.yaml)"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "will force add the machine if it already exists"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for add"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "interactive mode to enter the password"
|
|
},
|
|
{
|
|
"flag": "-p, --password string",
|
|
"description": "machine password to login to the API"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "URL of the local API"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli machines delete",
|
|
"description": "delete machine(s) by name",
|
|
"usage": "cscli machines delete [machine_name]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for delete"
|
|
},
|
|
{
|
|
"flag": "--ignore-missing",
|
|
"description": "don't print errors if one or more machines don't exist"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli machines inspect",
|
|
"description": "inspect a machine by name",
|
|
"usage": "cscli machines inspect [machine_name] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "-H, --hub",
|
|
"description": "show hub state"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli machines list",
|
|
"description": "list all machines in the database with their status and last heartbeat",
|
|
"usage": "cscli machines list [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli machines prune",
|
|
"description": "prune multiple machines that are not validated or have not connected to the local API in a given duration.",
|
|
"usage": "cscli machines prune [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --duration duration",
|
|
"description": "duration of time since validated machine last heartbeat (default 10m0s)"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "force prune without asking for confirmation"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for prune"
|
|
},
|
|
{
|
|
"flag": "--not-validated-only",
|
|
"description": "only prune machines that are not validated"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli machines validate",
|
|
"description": "validate a machine to access the local API.",
|
|
"usage": "cscli machines validate [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for validate"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli metrics",
|
|
"description": "Fetch metrics from a Local API server and display them",
|
|
"usage": "cscli metrics [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for metrics"
|
|
},
|
|
{
|
|
"flag": "--no-unit",
|
|
"description": "Show the real number instead of formatted with units"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url (http://<ip>:<port>/metrics)"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli metrics list",
|
|
"description": "List available types of metrics.",
|
|
"usage": "cscli metrics list [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli metrics show",
|
|
"description": "Fetch metrics from a Local API server and display them, optionally filtering on specific types.",
|
|
"usage": "cscli metrics show [type]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for show"
|
|
},
|
|
{
|
|
"flag": "--no-unit",
|
|
"description": "Show the real number instead of formatted with units"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Metrics url (http://<ip>:<port>/metrics)"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli notifications",
|
|
"description": "To list/inspect/test notification template",
|
|
"usage": "cscli notifications [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for notifications"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli notifications inspect",
|
|
"description": "Inspect notifications plugin and show configuration",
|
|
"usage": "cscli notifications inspect [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli notifications list",
|
|
"description": "list notifications plugins and their status (active or not)",
|
|
"usage": "cscli notifications list [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli notifications reinject",
|
|
"description": "reinject an alert into profiles to be evaluated by the filter and sent to matched notifications plugins",
|
|
"usage": "cscli notifications reinject [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --alert string",
|
|
"description": "JSON string used to override alert fields in the reinjected alert (see crowdsec/pkg/models/alert.go in the source tree for the full definition of the object)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for reinject"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli notifications test",
|
|
"description": "send a generic test alert to a notification plugin even if it is not active in profiles",
|
|
"usage": "cscli notifications test [plugin name] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --alert string",
|
|
"description": "JSON string used to override alert fields in the generic alert (see crowdsec/pkg/models/alert.go in the source tree for the full definition of the object)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for test"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli papi",
|
|
"description": "Manage interaction with Polling API (PAPI)",
|
|
"usage": "cscli papi [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for papi"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli papi status",
|
|
"description": "Get status of the Polling API",
|
|
"usage": "cscli papi status [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for status"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli papi sync",
|
|
"description": "Sync with the Polling API, pulling all non-expired orders for the instance",
|
|
"usage": "cscli papi sync [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for sync"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli parsers",
|
|
"description": "Manage hub parsers",
|
|
"usage": "cscli parsers <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for parsers"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli parsers inspect",
|
|
"description": "Inspect the state of one or more parsers",
|
|
"usage": "cscli parsers inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli parsers install",
|
|
"description": "Fetch and install one or more parsers from the hub",
|
|
"usage": "cscli parsers install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple parsers"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli parsers list",
|
|
"description": "List of installed/available/specified parsers",
|
|
"usage": "cscli parsers list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli parsers remove",
|
|
"description": "Remove one or more parsers",
|
|
"usage": "cscli parsers remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the parsers"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli parsers upgrade",
|
|
"description": "Fetch and upgrade one or more parsers from the hub",
|
|
"usage": "cscli parsers upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the parsers"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli postoverflows",
|
|
"description": "Manage hub postoverflows",
|
|
"usage": "cscli postoverflows <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for postoverflows"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli postoverflows inspect",
|
|
"description": "Inspect the state of one or more postoverflows",
|
|
"usage": "cscli postoverflows inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli postoverflows install",
|
|
"description": "Fetch and install one or more postoverflows from the hub",
|
|
"usage": "cscli postoverflows install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple postoverflows"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli postoverflows list",
|
|
"description": "List of installed/available/specified postoverflows",
|
|
"usage": "cscli postoverflows list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli postoverflows remove",
|
|
"description": "Remove one or more postoverflows",
|
|
"usage": "cscli postoverflows remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the postoverflows"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli postoverflows upgrade",
|
|
"description": "Fetch and upgrade one or more postoverflows from the hub",
|
|
"usage": "cscli postoverflows upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the postoverflows"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli scenarios",
|
|
"description": "Manage hub scenarios",
|
|
"usage": "cscli scenarios <action> [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for scenarios"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli scenarios inspect",
|
|
"description": "Inspect the state of one or more scenarios",
|
|
"usage": "cscli scenarios inspect [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--diff",
|
|
"description": "Show diff with latest version (for tainted items)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for inspect"
|
|
},
|
|
{
|
|
"flag": "--no-metrics",
|
|
"description": "Don't show metrics (when cscli.output=human)"
|
|
},
|
|
{
|
|
"flag": "--rev",
|
|
"description": "Reverse diff output"
|
|
},
|
|
{
|
|
"flag": "-u, --url string",
|
|
"description": "Prometheus url"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli scenarios install",
|
|
"description": "Fetch and install one or more scenarios from the hub",
|
|
"usage": "cscli scenarios install [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-d, --download-only",
|
|
"description": "Only download packages, don't enable"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force install: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install"
|
|
},
|
|
{
|
|
"flag": "--ignore",
|
|
"description": "Ignore errors when installing multiple scenarios"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli scenarios list",
|
|
"description": "List of installed/available/specified scenarios",
|
|
"usage": "cscli scenarios list [item... | -a] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "List disabled items as well"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for list"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli scenarios remove",
|
|
"description": "Remove one or more scenarios",
|
|
"usage": "cscli scenarios remove [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--all",
|
|
"description": "Remove all the scenarios"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force remove: remove tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for remove"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--purge",
|
|
"description": "Delete source file too"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli scenarios upgrade",
|
|
"description": "Fetch and upgrade one or more scenarios from the hub",
|
|
"usage": "cscli scenarios upgrade [item]... [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-a, --all",
|
|
"description": "Upgrade all the scenarios"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "Don't install or remove anything; print the execution plan"
|
|
},
|
|
{
|
|
"flag": "--force",
|
|
"description": "Force upgrade: overwrite tainted and outdated files"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for upgrade"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli setup",
|
|
"description": "Manage service detection and hub/acquisition configuration",
|
|
"usage": "cscli setup [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--detect-config string",
|
|
"description": "path to service detection configuration, will use $CROWDSEC_SETUP_DETECT_CONFIG if defined (default \"/var/lib/crowdsec/data/detect.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--ignore strings",
|
|
"description": "ignore a detected service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--force strings",
|
|
"description": "force the detection of a service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--skip-systemd",
|
|
"description": "don't use systemd, even if available"
|
|
},
|
|
{
|
|
"flag": "--acquis-dir string",
|
|
"description": "Directory for the acquisition configuration"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "simulate the installation without making any changes"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for setup"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli setup detect",
|
|
"description": "Detects the services installed on the machine and builds a specification to be used with the \"setup install-*\" commands.",
|
|
"usage": "cscli setup detect [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--detect-config string",
|
|
"description": "path to service detection configuration, will use $CROWDSEC_SETUP_DETECT_CONFIG if defined (default \"/var/lib/crowdsec/data/detect.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--ignore strings",
|
|
"description": "ignore a detected service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--force strings",
|
|
"description": "force the detection of a service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--skip-systemd",
|
|
"description": "don't use systemd, even if available"
|
|
},
|
|
{
|
|
"flag": "--yaml",
|
|
"description": "output yaml, not json"
|
|
},
|
|
{
|
|
"flag": "--list-supported-services",
|
|
"description": "do not detect; only print supported services"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for detect"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli setup install-acquisition",
|
|
"description": "Generate acquisition configuration from a setup file.",
|
|
"usage": "cscli setup install-acquisition [setup_file] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--acquis-dir string",
|
|
"description": "Directory for the acquisition configuration"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "simulate the installation without making any changes"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install-acquisition"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli setup install-hub",
|
|
"description": "Install the CrowdSec hub items (collections, scenarios, etc.) recommended for each detected service, based on a setup file.",
|
|
"usage": "cscli setup install-hub [setup_file] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "simulate the installation without making any changes"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for install-hub"
|
|
},
|
|
{
|
|
"flag": "-i, --interactive",
|
|
"description": "Ask for confirmation before proceeding"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli setup interactive",
|
|
"description": "Detect services and generate configuration, with user prompts",
|
|
"usage": "cscli setup interactive [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--detect-config string",
|
|
"description": "path to service detection configuration, will use $CROWDSEC_SETUP_DETECT_CONFIG if defined (default \"/var/lib/crowdsec/data/detect.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--ignore strings",
|
|
"description": "ignore a detected service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--force strings",
|
|
"description": "force the detection of a service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--skip-systemd",
|
|
"description": "don't use systemd, even if available"
|
|
},
|
|
{
|
|
"flag": "--acquis-dir string",
|
|
"description": "Directory for the acquisition configuration"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "simulate the installation without making any changes"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for interactive"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli setup unattended",
|
|
"description": "Automatically detect services and generate configuration",
|
|
"usage": "cscli setup unattended [flags]",
|
|
"examples": [
|
|
"If this variable is set to a non-empty value, unattended setup will be skipped.",
|
|
"This can be useful with ansible or other automation tools."
|
|
],
|
|
"flags": [
|
|
{
|
|
"flag": "--detect-config string",
|
|
"description": "path to service detection configuration, will use $CROWDSEC_SETUP_DETECT_CONFIG if defined (default \"/var/lib/crowdsec/data/detect.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--ignore strings",
|
|
"description": "ignore a detected service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--force strings",
|
|
"description": "force the detection of a service (can be repeated)"
|
|
},
|
|
{
|
|
"flag": "--skip-systemd",
|
|
"description": "don't use systemd, even if available"
|
|
},
|
|
{
|
|
"flag": "--acquis-dir string",
|
|
"description": "Directory for the acquisition configuration"
|
|
},
|
|
{
|
|
"flag": "--dry-run",
|
|
"description": "simulate the installation without making any changes"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for unattended"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli setup validate",
|
|
"description": "Validate a setup file generated by 'cscli setup detect' or manually edited.",
|
|
"usage": "cscli setup validate [setup_file] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for validate"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli simulation",
|
|
"description": "Manage simulation status of scenarios",
|
|
"usage": "cscli simulation [command] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for simulation"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli simulation disable",
|
|
"description": "Disable the simulation mode. Disable only specified scenarios",
|
|
"usage": "cscli simulation disable [scenario] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-g, --global",
|
|
"description": "Disable global simulation (reverse mode)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for disable"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli simulation enable",
|
|
"description": "Enable the simulation, globally or on specified scenarios",
|
|
"usage": "cscli simulation enable [scenario] [-global] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-g, --global",
|
|
"description": "Enable global simulation (reverse mode)"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for enable"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
},
|
|
{
|
|
"command": "cscli simulation status",
|
|
"description": "Show simulation mode status",
|
|
"usage": "cscli simulation status [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for status"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli support",
|
|
"description": "Provide commands to help during support",
|
|
"usage": "cscli support [action] [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for support"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": [
|
|
{
|
|
"command": "cscli support dump",
|
|
"description": "Dump the following information: - Crowdsec version - OS version and runtime system information - Enabled feature flags - Latest Crowdsec logs (log processor, LAPI, remediation components) - Installed collections, parsers, scenarios... - Bouncers and machines list - CAPI/LAPI status - Crowdsec config (sensitive information like username and password are redacted) - Crowdsec metrics - Stack trace in case of process crash",
|
|
"usage": "cscli support dump [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "--fast",
|
|
"description": "Skip slow operations, like cpu profiling"
|
|
},
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for dump"
|
|
},
|
|
{
|
|
"flag": "-f, --outFile string",
|
|
"description": "File to dump the information to"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"command": "cscli version",
|
|
"description": "Display version",
|
|
"usage": "cscli version [flags]",
|
|
"examples": [],
|
|
"flags": [
|
|
{
|
|
"flag": "-h, --help",
|
|
"description": "help for version"
|
|
},
|
|
{
|
|
"flag": "--color string",
|
|
"description": "Output color: yes, no, auto (default \"auto\")"
|
|
},
|
|
{
|
|
"flag": "-c, --config string",
|
|
"description": "path to crowdsec config file (default \"/etc/crowdsec/config.yaml\")"
|
|
},
|
|
{
|
|
"flag": "--debug",
|
|
"description": "Set logging to debug"
|
|
},
|
|
{
|
|
"flag": "--error",
|
|
"description": "Set logging to error"
|
|
},
|
|
{
|
|
"flag": "--info",
|
|
"description": "Set logging to info"
|
|
},
|
|
{
|
|
"flag": "-o, --output string",
|
|
"description": "Output format: human, json, raw"
|
|
},
|
|
{
|
|
"flag": "--trace",
|
|
"description": "Set logging to trace"
|
|
},
|
|
{
|
|
"flag": "--warning",
|
|
"description": "Set logging to warning"
|
|
}
|
|
],
|
|
"subcommands": []
|
|
}
|
|
]
|
|
}
|
|
} |