---
schema_version: "1"
id: 3d78fc01800b97293a6d2c4525468e44abb434c7cebb2f9986d99ff100f95eb2
title: sf scanner rule describe (Retired)
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/code-analyzer/salesforce-code-analyzer/guides/v3x/command-reference/describe.md
canonical_url: https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/describe.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: 792b6f826c19b03bc523ddbe6480d8ceee8b64d20b1074a9793cdadde08a7e8e
products:
  - Salesforce Code Analyzer
---
# 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

```
  $ sf scanner rule describe --rulename {ExampleRule}
     name:        ExampleRule
     categories:  ExampleCategory
     rulesets:    Ruleset1
                  Ruleset2
                  Ruleset3
     languages:   apex
     description: Short description of rule
     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` <b>|</b> `--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