sf scanner rule describe

Provides detailed information about a rule. Information includes the rule's language (such as Apex or Java), the violation it detects, and example code of the violation. The command output also includes the rule's categories and rulesets.

• {ExampleRule}: The name of the rule to describe.

sf scanner rule describe

   -n RULENAME

   [--json]

   [--verbose]

This flag is available in Code Analyzer v 3.x (generally available).

   [--preview-pmd7]

-n | --rulename RULENAME

Required

The name of the rule.

Type: option

--json

Optional

Format output as JSON.

Type: boolean

--verbose

Optional

Emit additional command output to stdout.

Type: boolean

This flag is available in Code Analyzer 3.x (generally available).

--preview-pmd7

Optional

Uses PMD version 7.0.0-rc4 instead of 6.55.0 when running PMD and CPD engines.

Type: boolean