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.

$ sf scanner rule describe --rulename {ExampleRule}
     name:        ExampleRule
     categories:  ExampleCategory
     rulesets:    Ruleset1
                  Ruleset2
                  Ruleset3
     languages:   apex
     description: Short description of rule
     message:     ExampleRule Violated.

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

sf scanner rule describe

   -n RULENAME

   [--json]

   [--verbose]

-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

j

No Results

Search Tips:

• Please consider misspellings
• Try different search keywords

Get Started

Overview of Salesforce Code Analyzer

Engines

Use CLI Commands to Analyze Your Code

Use the VS Code Extension to Analyze Your Code

Customize the Configuration

CLI Command Reference

Output Schema Reference

CI/CD Integration

Migrate from v4 to v5

Produce Code Analyzer Reports for AppExchange Security Review

Release Notes

Salesforce Code Analyzer v4 (End of Life)

Architecture (End of Life)

Engines (End of Life)

Use CLI Commands to Analyze Your Code (End of Life)

Use the VS Code Extension to Analyze Your Code (End of Life)

CI/CD Integration (End of Life)

Command Reference (End of Life)

scanner run (End of Life)

scanner run dfa (End of Life)

scanner rule list (End of Life)

scanner rule describe (End of Life)

scanner rule add (End of Life)

scanner rule remove (End of Life)

Customization (End of Life)

Code Analyzer FAQ (End of Life)

Troubleshooting (End of Life)