Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions crowdsec-docs/docs/cscli/cscli_appsec-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Manage hub appsec-configs

```
cscli appsec-configs list -a
cscli appsec-configs install crowdsecurity/vpatch
cscli appsec-configs inspect crowdsecurity/vpatch
cscli appsec-configs upgrade crowdsecurity/vpatch
cscli appsec-configs remove crowdsecurity/vpatch
cscli appsec-configs install crowdsecurity/virtual-patching
cscli appsec-configs inspect crowdsecurity/virtual-patching
cscli appsec-configs upgrade crowdsecurity/virtual-patching
cscli appsec-configs remove crowdsecurity/virtual-patching

```

Expand Down
12 changes: 11 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_appsec-configs_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,17 @@ cscli appsec-configs inspect [item]... [flags]
### Examples

```
cscli appsec-configs inspect crowdsecurity/vpatch
# Display metadata, state, metrics and ancestor collections of appsec-configs (installed or not).
cscli appsec-configs inspect crowdsecurity/virtual-patching

# Don't collect metrics (avoid error if crowdsec is not running).
cscli appsec-configs inspect crowdsecurity/virtual-patching --no-metrics

# Display difference between a tainted item and the latest one.
cscli appsec-configs inspect crowdsecurity/virtual-patching --diff

# Reverse the above diff
cscli appsec-configs inspect crowdsecurity/virtual-patching --diff --rev
```

### Options
Expand Down
21 changes: 20 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_appsec-configs_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,35 @@ cscli appsec-configs install [item]... [flags]
### Examples

```
cscli appsec-configs install crowdsecurity/vpatch
# Install some appsec-configs.
cscli appsec-configs install crowdsecurity/virtual-patching

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli appsec-configs install crowdsecurity/virtual-patching --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli appsec-configs install crowdsecurity/virtual-patching --dry-run -o raw

# Download only, to be installed later.
cscli appsec-configs install crowdsecurity/virtual-patching --download-only

# Install over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
cscli appsec-configs install crowdsecurity/virtual-patching --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli appsec-configs install crowdsecurity/virtual-patching -i
cscli appsec-configs install crowdsecurity/virtual-patching --interactive
```

### Options

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

### Options inherited from parent commands
Expand Down
7 changes: 6 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_appsec-configs_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ cscli appsec-configs list [item... | -a] [flags]
### Examples

```
# List enabled (installed) appsec-configs.
cscli appsec-configs list

# List all available appsec-configs (installed or not).
cscli appsec-configs list -a
cscli appsec-configs list crowdsecurity/vpatch

# List specific appsec-configs (installed or not).
cscli appsec-configs list crowdsecurity/virtual-patching crowdsecurity/generic-rules
```

### Options
Expand Down
29 changes: 24 additions & 5 deletions crowdsec-docs/docs/cscli/cscli_appsec-configs_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,35 @@ cscli appsec-configs remove [item]... [flags]
### Examples

```
cscli appsec-configs remove crowdsecurity/vpatch
# Uninstall some appsec-configs.
cscli appsec-configs remove crowdsecurity/virtual-patching

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli appsec-configs remove crowdsecurity/virtual-patching --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli appsec-configs remove crowdsecurity/virtual-patching --dry-run -o raw

# Uninstall and also remove the downloaded files.
cscli appsec-configs remove crowdsecurity/virtual-patching --purge

# Remove tainted items.
cscli appsec-configs remove crowdsecurity/virtual-patching --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli appsec-configs remove crowdsecurity/virtual-patching -i
cscli appsec-configs remove crowdsecurity/virtual-patching --interactive
```

### Options

```
--all Remove all the appsec-configs
--force Force remove: remove tainted and outdated files
-h, --help help for remove
--purge Delete source file too
--all Remove all the appsec-configs
--dry-run Don't install or remove anything; print the execution plan
--force Force remove: remove tainted and outdated files
-h, --help help for remove
-i, --interactive Ask for confirmation before proceeding
--purge Delete source file too
```

### Options inherited from parent commands
Expand Down
24 changes: 20 additions & 4 deletions crowdsec-docs/docs/cscli/cscli_appsec-configs_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,31 @@ cscli appsec-configs upgrade [item]... [flags]
### Examples

```
cscli appsec-configs upgrade crowdsecurity/vpatch
# Upgrade some appsec-configs. If they are not currently installed, they are downloaded but not installed.
cscli appsec-configs upgrade crowdsecurity/virtual-patching

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli appsec-configs upgrade crowdsecurity/virtual-patching --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli appsec-configs upgrade crowdsecurity/virtual-patching --dry-run -o raw

# Upgrade over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
cscli appsec-configs upgrade crowdsecurity/virtual-patching --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli appsec-configs upgrade crowdsecurity/virtual-patching -i
cscli appsec-configs upgrade crowdsecurity/virtual-patching --interactive
```

### Options

```
-a, --all Upgrade all the appsec-configs
--force Force upgrade: overwrite tainted and outdated files
-h, --help help for upgrade
-a, --all Upgrade all the appsec-configs
--dry-run Don't install or remove anything; print the execution plan
--force Force upgrade: overwrite tainted and outdated files
-h, --help help for upgrade
-i, --interactive Ask for confirmation before proceeding
```

### Options inherited from parent commands
Expand Down
10 changes: 10 additions & 0 deletions crowdsec-docs/docs/cscli/cscli_appsec-rules_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,17 @@ cscli appsec-rules inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and ancestor collections of appsec-rules (installed or not).
cscli appsec-rules inspect crowdsecurity/crs

# Don't collect metrics (avoid error if crowdsec is not running).
cscli appsec-configs inspect crowdsecurity/crs --no-metrics

# Display difference between a tainted item and the latest one.
cscli appsec-rules inspect crowdsecurity/crs --diff

# Reverse the above diff
cscli appsec-rules inspect crowdsecurity/crs --diff --rev
```

### Options
Expand Down
19 changes: 19 additions & 0 deletions crowdsec-docs/docs/cscli/cscli_appsec-rules_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,35 @@ cscli appsec-rules install [item]... [flags]
### Examples

```
# Install some appsec-rules.
cscli appsec-rules install crowdsecurity/crs

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli appsec-rules install crowdsecurity/crs --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli appsec-rules install crowdsecurity/crs --dry-run -o raw

# Download only, to be installed later.
cscli appsec-rules install crowdsecurity/crs --download-only

# Install over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
cscli appsec-rules install crowdsecurity/crs --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli appsec-rules install crowdsecurity/crs -i
cscli appsec-rules install crowdsecurity/crs --interactive
```

### Options

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

### Options inherited from parent commands
Expand Down
7 changes: 6 additions & 1 deletion crowdsec-docs/docs/cscli/cscli_appsec-rules_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ cscli appsec-rules list [item... | -a] [flags]
### Examples

```
# List enabled (installed) appsec-rules.
cscli appsec-rules list

# List all available appsec-rules (installed or not).
cscli appsec-rules list -a
cscli appsec-rules list crowdsecurity/crs

# List specific appsec-rules (installed or not).
cscli appsec-rules list crowdsecurity/crs crowdsecurity/vpatch-git-config
```

### Options
Expand Down
27 changes: 23 additions & 4 deletions crowdsec-docs/docs/cscli/cscli_appsec-rules_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,35 @@ cscli appsec-rules remove [item]... [flags]
### Examples

```
# Uninstall some appsec-rules.
cscli appsec-rules remove crowdsecurity/crs

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli appsec-rules remove crowdsecurity/crs --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli appsec-rules remove crowdsecurity/crs --dry-run -o raw

# Uninstall and also remove the downloaded files.
cscli appsec-rules remove crowdsecurity/crs --purge

# Remove tainted items.
cscli appsec-rules remove crowdsecurity/crs --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli appsec-rules remove crowdsecurity/crs -i
cscli appsec-rules remove crowdsecurity/crs --interactive
```

### Options

```
--all Remove all the appsec-rules
--force Force remove: remove tainted and outdated files
-h, --help help for remove
--purge Delete source file too
--all Remove all the appsec-rules
--dry-run Don't install or remove anything; print the execution plan
--force Force remove: remove tainted and outdated files
-h, --help help for remove
-i, --interactive Ask for confirmation before proceeding
--purge Delete source file too
```

### Options inherited from parent commands
Expand Down
22 changes: 19 additions & 3 deletions crowdsec-docs/docs/cscli/cscli_appsec-rules_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,31 @@ cscli appsec-rules upgrade [item]... [flags]
### Examples

```
# Upgrade some appsec-rules. If they are not currently installed, they are downloaded but not installed.
cscli appsec-rules upgrade crowdsecurity/crs

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli appsec-rules upgrade crowdsecurity/crs --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli appsec-rules upgrade crowdsecurity/crs --dry-run -o raw

# Upgrade over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
cscli appsec-rules upgrade crowdsecurity/crs --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli appsec-rules upgrade crowdsecurity/crs -i
cscli appsec-rules upgrade crowdsecurity/crs --interactive
```

### Options

```
-a, --all Upgrade all the appsec-rules
--force Force upgrade: overwrite tainted and outdated files
-h, --help help for upgrade
-a, --all Upgrade all the appsec-rules
--dry-run Don't install or remove anything; print the execution plan
--force Force upgrade: overwrite tainted and outdated files
-h, --help help for upgrade
-i, --interactive Ask for confirmation before proceeding
```

### Options inherited from parent commands
Expand Down
10 changes: 10 additions & 0 deletions crowdsec-docs/docs/cscli/cscli_collections_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,17 @@ cscli collections inspect [item]... [flags]
### Examples

```
# Display metadata, state, metrics and dependencies of collections (installed or not).
cscli collections inspect crowdsecurity/http-cve crowdsecurity/iptables

# Don't collect metrics (avoid error if crowdsec is not running).
cscli collections inspect crowdsecurity/http-cve crowdsecurity/iptables --no-metrics

# Display difference between a tainted item and the latest one, or the reason for the taint if it's a dependency.
cscli collections inspect crowdsecurity/http-cve --diff

# Reverse the above diff
cscli collections inspect crowdsecurity/http-cve --diff --rev
```

### Options
Expand Down
19 changes: 19 additions & 0 deletions crowdsec-docs/docs/cscli/cscli_collections_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,35 @@ cscli collections install [item]... [flags]
### Examples

```
# Install some collections.
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables

# Show the execution plan without changing anything - compact output sorted by type and name.
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables --dry-run

# Show the execution plan without changing anything - verbose output sorted by execution order.
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables --dry-run -o raw

# Download only, to be installed later.
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables --download-only

# Install over tainted items. Can be used to restore or repair after local modifications or missing dependencies.
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables --force

# Prompt for confirmation if running in an interactive terminal; otherwise, the option is ignored.
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables -i
cscli collections install crowdsecurity/http-cve crowdsecurity/iptables --interactive
```

### Options

```
-d, --download-only Only download packages, don't enable
--dry-run Don't install or remove anything; print the execution plan
--force Force install: overwrite tainted and outdated files
-h, --help help for install
--ignore Ignore errors when installing multiple collections
-i, --interactive Ask for confirmation before proceeding
```

### Options inherited from parent commands
Expand Down
7 changes: 5 additions & 2 deletions crowdsec-docs/docs/cscli/cscli_collections_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@ cscli collections list [item... | -a] [flags]
### Examples

```
# List enabled (installed) collections.
cscli collections list

# List all available collections (installed or not).
cscli collections list -a
cscli collections list crowdsecurity/http-cve crowdsecurity/iptables

List only enabled collections unless "-a" or names are specified.
# List specific collections (installed or not).
cscli collections list crowdsecurity/http-cve crowdsecurity/iptables
```

### Options
Expand Down
Loading