sf scanner rule describe (Retired)

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.

Example

1$ sf scanner rule describe --rulename {ExampleRule}
2     name:        ExampleRule
3     categories:  ExampleCategory
4     rulesets:    Ruleset1
5                  Ruleset2
6                  Ruleset3
7     languages:   apex
8     description: Short description of rule
9     message:     ExampleRule Violated.

Replace this value:

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

Usage

sf scanner rule describe

-n RULENAME

[--json]

[--verbose]

Flags

-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

Retired

As of August 2025, Salesforce Code Analyzer v4 is retired and no longer supported. Use Code Analyzer v5 instead.