Skip to content

Commit e657527

Browse files
update cscli docs for 1.6.5 (#733)
* update cscli docs for 1.6.5 * Remove backup/restore from sidebar --------- Co-authored-by: Laurence Jones <[email protected]>
1 parent 7d21638 commit e657527

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+583
-189
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Manage hub appsec-configs
1010

1111
```
1212
cscli appsec-configs list -a
13-
cscli appsec-configs install crowdsecurity/vpatch
14-
cscli appsec-configs inspect crowdsecurity/vpatch
15-
cscli appsec-configs upgrade crowdsecurity/vpatch
16-
cscli appsec-configs remove crowdsecurity/vpatch
13+
cscli appsec-configs install crowdsecurity/virtual-patching
14+
cscli appsec-configs inspect crowdsecurity/virtual-patching
15+
cscli appsec-configs upgrade crowdsecurity/virtual-patching
16+
cscli appsec-configs remove crowdsecurity/virtual-patching
1717
1818
```
1919

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

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

1919
```
20-
cscli appsec-configs inspect crowdsecurity/vpatch
20+
# Display metadata, state, metrics and ancestor collections of appsec-configs (installed or not).
21+
cscli appsec-configs inspect crowdsecurity/virtual-patching
22+
23+
# Don't collect metrics (avoid error if crowdsec is not running).
24+
cscli appsec-configs inspect crowdsecurity/virtual-patching --no-metrics
25+
26+
# Display difference between a tainted item and the latest one.
27+
cscli appsec-configs inspect crowdsecurity/virtual-patching --diff
28+
29+
# Reverse the above diff
30+
cscli appsec-configs inspect crowdsecurity/virtual-patching --diff --rev
2131
```
2232

2333
### Options

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,35 @@ cscli appsec-configs install [item]... [flags]
1717
### Examples
1818

1919
```
20-
cscli appsec-configs install crowdsecurity/vpatch
20+
# Install some appsec-configs.
21+
cscli appsec-configs install crowdsecurity/virtual-patching
22+
23+
# Show the execution plan without changing anything - compact output sorted by type and name.
24+
cscli appsec-configs install crowdsecurity/virtual-patching --dry-run
25+
26+
# Show the execution plan without changing anything - verbose output sorted by execution order.
27+
cscli appsec-configs install crowdsecurity/virtual-patching --dry-run -o raw
28+
29+
# Download only, to be installed later.
30+
cscli appsec-configs install crowdsecurity/virtual-patching --download-only
31+
32+
# Install over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
33+
cscli appsec-configs install crowdsecurity/virtual-patching --force
34+
35+
# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
36+
cscli appsec-configs install crowdsecurity/virtual-patching -i
37+
cscli appsec-configs install crowdsecurity/virtual-patching --interactive
2138
```
2239

2340
### Options
2441

2542
```
2643
-d, --download-only Only download packages, don't enable
44+
--dry-run Don't install or remove anything; print the execution plan
2745
--force Force install: overwrite tainted and outdated files
2846
-h, --help help for install
2947
--ignore Ignore errors when installing multiple appsec-configs
48+
-i, --interactive Ask for confirmation before proceeding
3049
```
3150

3251
### Options inherited from parent commands

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@ cscli appsec-configs list [item... | -a] [flags]
1717
### Examples
1818

1919
```
20+
# List enabled (installed) appsec-configs.
2021
cscli appsec-configs list
22+
23+
# List all available appsec-configs (installed or not).
2124
cscli appsec-configs list -a
22-
cscli appsec-configs list crowdsecurity/vpatch
25+
26+
# List specific appsec-configs (installed or not).
27+
cscli appsec-configs list crowdsecurity/virtual-patching crowdsecurity/generic-rules
2328
```
2429

2530
### Options

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

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,35 @@ cscli appsec-configs remove [item]... [flags]
1717
### Examples
1818

1919
```
20-
cscli appsec-configs remove crowdsecurity/vpatch
20+
# Uninstall some appsec-configs.
21+
cscli appsec-configs remove crowdsecurity/virtual-patching
22+
23+
# Show the execution plan without changing anything - compact output sorted by type and name.
24+
cscli appsec-configs remove crowdsecurity/virtual-patching --dry-run
25+
26+
# Show the execution plan without changing anything - verbose output sorted by execution order.
27+
cscli appsec-configs remove crowdsecurity/virtual-patching --dry-run -o raw
28+
29+
# Uninstall and also remove the downloaded files.
30+
cscli appsec-configs remove crowdsecurity/virtual-patching --purge
31+
32+
# Remove tainted items.
33+
cscli appsec-configs remove crowdsecurity/virtual-patching --force
34+
35+
# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
36+
cscli appsec-configs remove crowdsecurity/virtual-patching -i
37+
cscli appsec-configs remove crowdsecurity/virtual-patching --interactive
2138
```
2239

2340
### Options
2441

2542
```
26-
--all Remove all the appsec-configs
27-
--force Force remove: remove tainted and outdated files
28-
-h, --help help for remove
29-
--purge Delete source file too
43+
--all Remove all the appsec-configs
44+
--dry-run Don't install or remove anything; print the execution plan
45+
--force Force remove: remove tainted and outdated files
46+
-h, --help help for remove
47+
-i, --interactive Ask for confirmation before proceeding
48+
--purge Delete source file too
3049
```
3150

3251
### Options inherited from parent commands

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,31 @@ cscli appsec-configs upgrade [item]... [flags]
1717
### Examples
1818

1919
```
20-
cscli appsec-configs upgrade crowdsecurity/vpatch
20+
# Upgrade some appsec-configs. If they are not currently installed, they are downloaded but not installed.
21+
cscli appsec-configs upgrade crowdsecurity/virtual-patching
22+
23+
# Show the execution plan without changing anything - compact output sorted by type and name.
24+
cscli appsec-configs upgrade crowdsecurity/virtual-patching --dry-run
25+
26+
# Show the execution plan without changing anything - verbose output sorted by execution order.
27+
cscli appsec-configs upgrade crowdsecurity/virtual-patching --dry-run -o raw
28+
29+
# Upgrade over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
30+
cscli appsec-configs upgrade crowdsecurity/virtual-patching --force
31+
32+
# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
33+
cscli appsec-configs upgrade crowdsecurity/virtual-patching -i
34+
cscli appsec-configs upgrade crowdsecurity/virtual-patching --interactive
2135
```
2236

2337
### Options
2438

2539
```
26-
-a, --all Upgrade all the appsec-configs
27-
--force Force upgrade: overwrite tainted and outdated files
28-
-h, --help help for upgrade
40+
-a, --all Upgrade all the appsec-configs
41+
--dry-run Don't install or remove anything; print the execution plan
42+
--force Force upgrade: overwrite tainted and outdated files
43+
-h, --help help for upgrade
44+
-i, --interactive Ask for confirmation before proceeding
2945
```
3046

3147
### Options inherited from parent commands

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

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

1919
```
20+
# Display metadata, state, metrics and ancestor collections of appsec-rules (installed or not).
2021
cscli appsec-rules inspect crowdsecurity/crs
22+
23+
# Don't collect metrics (avoid error if crowdsec is not running).
24+
cscli appsec-configs inspect crowdsecurity/crs --no-metrics
25+
26+
# Display difference between a tainted item and the latest one.
27+
cscli appsec-rules inspect crowdsecurity/crs --diff
28+
29+
# Reverse the above diff
30+
cscli appsec-rules inspect crowdsecurity/crs --diff --rev
2131
```
2232

2333
### Options

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,35 @@ cscli appsec-rules install [item]... [flags]
1717
### Examples
1818

1919
```
20+
# Install some appsec-rules.
2021
cscli appsec-rules install crowdsecurity/crs
22+
23+
# Show the execution plan without changing anything - compact output sorted by type and name.
24+
cscli appsec-rules install crowdsecurity/crs --dry-run
25+
26+
# Show the execution plan without changing anything - verbose output sorted by execution order.
27+
cscli appsec-rules install crowdsecurity/crs --dry-run -o raw
28+
29+
# Download only, to be installed later.
30+
cscli appsec-rules install crowdsecurity/crs --download-only
31+
32+
# Install over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
33+
cscli appsec-rules install crowdsecurity/crs --force
34+
35+
# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
36+
cscli appsec-rules install crowdsecurity/crs -i
37+
cscli appsec-rules install crowdsecurity/crs --interactive
2138
```
2239

2340
### Options
2441

2542
```
2643
-d, --download-only Only download packages, don't enable
44+
--dry-run Don't install or remove anything; print the execution plan
2745
--force Force install: overwrite tainted and outdated files
2846
-h, --help help for install
2947
--ignore Ignore errors when installing multiple appsec-rules
48+
-i, --interactive Ask for confirmation before proceeding
3049
```
3150

3251
### Options inherited from parent commands

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@ cscli appsec-rules list [item... | -a] [flags]
1717
### Examples
1818

1919
```
20+
# List enabled (installed) appsec-rules.
2021
cscli appsec-rules list
22+
23+
# List all available appsec-rules (installed or not).
2124
cscli appsec-rules list -a
22-
cscli appsec-rules list crowdsecurity/crs
25+
26+
# List specific appsec-rules (installed or not).
27+
cscli appsec-rules list crowdsecurity/crs crowdsecurity/vpatch-git-config
2328
```
2429

2530
### Options

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

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,35 @@ cscli appsec-rules remove [item]... [flags]
1717
### Examples
1818

1919
```
20+
# Uninstall some appsec-rules.
2021
cscli appsec-rules remove crowdsecurity/crs
22+
23+
# Show the execution plan without changing anything - compact output sorted by type and name.
24+
cscli appsec-rules remove crowdsecurity/crs --dry-run
25+
26+
# Show the execution plan without changing anything - verbose output sorted by execution order.
27+
cscli appsec-rules remove crowdsecurity/crs --dry-run -o raw
28+
29+
# Uninstall and also remove the downloaded files.
30+
cscli appsec-rules remove crowdsecurity/crs --purge
31+
32+
# Remove tainted items.
33+
cscli appsec-rules remove crowdsecurity/crs --force
34+
35+
# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
36+
cscli appsec-rules remove crowdsecurity/crs -i
37+
cscli appsec-rules remove crowdsecurity/crs --interactive
2138
```
2239

2340
### Options
2441

2542
```
26-
--all Remove all the appsec-rules
27-
--force Force remove: remove tainted and outdated files
28-
-h, --help help for remove
29-
--purge Delete source file too
43+
--all Remove all the appsec-rules
44+
--dry-run Don't install or remove anything; print the execution plan
45+
--force Force remove: remove tainted and outdated files
46+
-h, --help help for remove
47+
-i, --interactive Ask for confirmation before proceeding
48+
--purge Delete source file too
3049
```
3150

3251
### Options inherited from parent commands

0 commit comments

Comments
 (0)