Skip to content

Commit 037da20

Browse files
authored
update cscli doc for 1.6.10 (#823)
1 parent f73217f commit 037da20

19 files changed

+125
-30
lines changed

crowdsec-docs/docs/cscli/cscli_alerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Manage alerts
2929

3030
* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
3131
* [cscli alerts delete](/cscli/cscli_alerts_delete.md) - Delete alerts
32-
/!\ This command can be use only on the same machine than the local API.
32+
/!\ This command can be used only on the same machine than the local API.
3333
* [cscli alerts flush](/cscli/cscli_alerts_flush.md) - Flush alerts
3434
/!\ This command can be used only on the same machine than the local API
3535
* [cscli alerts inspect](/cscli/cscli_alerts_inspect.md) - Show info about an alert

crowdsec-docs/docs/cscli/cscli_alerts_delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: cscli alerts delete
55
## cscli alerts delete
66

77
Delete alerts
8-
/!\ This command can be use only on the same machine than the local API.
8+
/!\ This command can be used only on the same machine than the local API.
99

1010
```
1111
cscli alerts delete [filters] [--all] [flags]

crowdsec-docs/docs/cscli/cscli_alerts_flush.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ cscli alerts flush --max-items 1000 --max-age 7d
2020
### Options
2121

2222
```
23-
--max-items int Maximum number of alert items to keep in the database (default 5000)
24-
--max-age string Maximum age of alert items to keep in the database (default "7d")
25-
-h, --help help for flush
23+
--max-items int Maximum number of alert items to keep in the database (default 5000)
24+
--max-age duration Maximum age of alert items to keep in the database (default 168h0m0s)
25+
-h, --help help for flush
2626
```
2727

2828
### Options inherited from parent commands

crowdsec-docs/docs/cscli/cscli_alerts_list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ cscli alerts list --type ban
2929

3030
```
3131
-a, --all Include decisions from Central API
32-
--until string restrict to alerts older than until (ie. 4h, 30d)
33-
--since string restrict to alerts newer than since (ie. 4h, 30d)
32+
--until duration restrict to alerts older than until (ie. 4h, 30d) (default 0s)
33+
--since duration restrict to alerts newer than since (ie. 4h, 30d) (default 0s)
3434
-i, --ip string restrict to alerts from this source ip (shorthand for --scope ip --value <IP>)
3535
-s, --scenario string the scenario (ie. crowdsecurity/ssh-bf)
3636
-r, --range string restrict to alerts from this range (shorthand for --scope range --value <RANGE/X>)

crowdsec-docs/docs/cscli/cscli_allowlists.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Manage centralized allowlists
2929

3030
* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
3131
* [cscli allowlists add](/cscli/cscli_allowlists_add.md) - Add content to an allowlist
32+
* [cscli allowlists check](/cscli/cscli_allowlists_check.md) - Check if a value is in an allowlist
3233
* [cscli allowlists create](/cscli/cscli_allowlists_create.md) - Create a new allowlist
3334
* [cscli allowlists delete](/cscli/cscli_allowlists_delete.md) - Delete an allowlist
3435
* [cscli allowlists inspect](/cscli/cscli_allowlists_inspect.md) - Inspect an allowlist

crowdsec-docs/docs/cscli/cscli_allowlists_add.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ cscli allowlists add my_allowlist 1.2.3.4 2.3.4.5 -e 1h -d "my comment"
1919
### Options
2020

2121
```
22-
-d, --comment string comment for the value
23-
-e, --expiration string expiration duration
24-
-h, --help help for add
22+
-d, --comment string comment for the value
23+
-e, --expiration duration expiration duration (default 0s)
24+
-h, --help help for add
2525
```
2626

2727
### Options inherited from parent commands
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: cscli_allowlists_check
3+
title: cscli allowlists check
4+
---
5+
## cscli allowlists check
6+
7+
Check if a value is in an allowlist
8+
9+
```
10+
cscli allowlists check [value...] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
cscli allowlists check 1.2.3.4
17+
```
18+
19+
### Options
20+
21+
```
22+
-h, --help help for check
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--color string Output color: yes, no, auto (default "auto")
29+
-c, --config string path to crowdsec config file (default "/etc/crowdsec/config.yaml")
30+
--debug Set logging to debug
31+
--error Set logging to error
32+
--info Set logging to info
33+
-o, --output string Output format: human, json, raw
34+
--trace Set logging to trace
35+
--warning Set logging to warning
36+
```
37+
38+
### SEE ALSO
39+
40+
* [cscli allowlists](/cscli/cscli_allowlists.md) - Manage centralized allowlists
41+

crowdsec-docs/docs/cscli/cscli_appsec-configs_inspect.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ cscli appsec-configs inspect [item]... [flags]
1717
### Examples
1818

1919
```
20-
# Display metadata, state, metrics and ancestor collections of appsec-configs (installed or not).
20+
# Display metadata, state, ancestor collections of appsec-configs (installed or not).
2121
cscli appsec-configs inspect crowdsecurity/virtual-patching
2222
23-
# Don't collect metrics (avoid error if crowdsec is not running).
23+
# If the config is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
24+
# To avoid this, use --no-metrics.
2425
cscli appsec-configs inspect crowdsecurity/virtual-patching --no-metrics
2526
2627
# Display difference between a tainted item and the latest one.

crowdsec-docs/docs/cscli/cscli_appsec-rules_inspect.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ cscli appsec-rules inspect [item]... [flags]
1717
### Examples
1818

1919
```
20-
# Display metadata, state, metrics and ancestor collections of appsec-rules (installed or not).
20+
# Display metadata, state, ancestor collections of appsec-rules (installed or not).
2121
cscli appsec-rules inspect crowdsecurity/crs
2222
23-
# Don't collect metrics (avoid error if crowdsec is not running).
23+
# If the rule is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
24+
# To avoid this, use --no-metrics.
2425
cscli appsec-configs inspect crowdsecurity/crs --no-metrics
2526
2627
# Display difference between a tainted item and the latest one.

crowdsec-docs/docs/cscli/cscli_collections_inspect.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ cscli collections inspect [item]... [flags]
1717
### Examples
1818

1919
```
20-
# Display metadata, state, metrics and dependencies of collections (installed or not).
20+
# Display metadata, state, and dependencies of collections (installed or not).
2121
cscli collections inspect crowdsecurity/http-cve crowdsecurity/iptables
2222
23-
# Don't collect metrics (avoid error if crowdsec is not running).
23+
# If the collection is installed, its metrics are collected and shown as well (with an error if crowdsec is not running).
24+
# To avoid this, use --no-metrics.
2425
cscli collections inspect crowdsecurity/http-cve crowdsecurity/iptables --no-metrics
2526
2627
# Display difference between a tainted item and the latest one, or the reason for the taint if it's a dependency.

0 commit comments

Comments
 (0)