Custom misconfiguration rules uses --policy flag instead of --config-policy

[jrarmstro]

Description

The custom policy docs for misconfiguration reference the --policy flag, when in reality the --config-policy flag should be used.

The --namespaces flag is also used, whereas trivy config --help mentions --policy-namespaces.

Link

https://aquasecurity.github.io/trivy/v0.48/docs/scanner/misconfiguration/custom/

Suggestions

Use the correct flags in the documentation

[nikpivkin]

Hi @jrarmstro !

policy is an alias for config-policy . namespaces is an alias for policy-namespaces .

@simar7 Should the help command print aliases?

[jrarmstro]

The documentation at https://aquasecurity.github.io/trivy/v0.48/docs/scanner/misconfiguration/custom/selectors/ talks about the service: subtype field, but doesn't seem to link to the available services - I know I had found a list somewhere earlier, though.

[jrarmstro]

I'll move forward without defining a subtype. Improving the documentation (or support?) for subtypes would probably help folks in the future. Thanks for the quick response.

[simar7]

The documentation at https://aquasecurity.github.io/trivy/v0.48/docs/scanner/misconfiguration/custom/selectors/ talks about the service: subtype field, but doesn't seem to link to the available services - I know I had found a list somewhere earlier, though.

The services are listed here but you're right we can probably link this page in the docs for visibility.

[simar7]

Hi @jrarmstro !

policy is an alias for config-policy . namespaces is an alias for policy-namespaces .

@simar7 Should the help command print aliases?

I think printing aliases is a general question we can ask at the Trivy level.

Personally I'm fine with showing aliases but it might be too verbose.

@knqyf263 what do you think?

[knqyf263]

AFAIK, cobra (technically pflag) doesn't have the functionality to show aliases.
https://github.com/spf13/pflag?tab=readme-ov-file#mutating-or-normalizing-flag-names