---
schema_version: "1"
id: 474552051b44b9ea73d9472359995e685167cbd9e42134bb3e13f4d953d537ce
title: Use CLI Commands to Analyze Your Code (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/setup.md
canonical_url: https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/setup.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: a062254c2e888364cf06bb4c4c01cb74e0ed424591cb88be695d134653faf270
products:
  - Salesforce Code Analyzer
---
# Use CLI Commands to Analyze Your Code (Retired)

To get started using the Salesforce Code Analyzer CLI commands, complete the prerequisites and follow the installation instructions.

## Prerequisites

To set up Salesforce Code Analyzer, complete these prerequisites.

### Java Platform, Standard Edition Development Kit

Some Code Analyzer features depend on the Java Platform, Standard Edition Java Development Kit (JDK). Install [JDK](https://www.oracle.com/java/technologies/downloads/) version 11 or later.

### Salesforce CLI

Code Analyzer is a Salesforce CLI plugin, so you must install Salesforce CLI on your machine. Then use Salesforce CLI to execute commands against Salesforce orgs and work with source files on your local computer.

For information about installing Salesforce CLI, read [Install Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).

## Install Salesforce Code Analyzer

**note:** Complete the prerequisites before you install Salesforce Code Analyzer.

### Install Code Analyzer

To install the Salesforce Code Analyzer plugin, run this command.

```bash
sf plugins install @salesforce/sfdx-scanner
```

### Check Code Analyzer Installation

To check that Code Analyzer is installed, run this command.

```bash
sf plugins --core
```

The output shows all the core and use plugins currently installed in Salesforce CLI. If Code Analyzer is installed, it's listed like this.

```bash
@salesforce/sfdx-scanner 4.3.0
```

### Install a Specific Code Analyzer Version

To install a specific Code Analyzer version, run this command.

```bash
sf plugins install @salesforce/sfdx-scanner@v4.2.0
```

### Display Code Analyzer Usage and Help

To display a list of the top-level Code Analyzer commands and topics, run this command.

```bash
sf scanner --help
```

To view the complete help about a specific command, including the full descriptions and examples, use the `--help` flag.

```bash
sf scanner run --help
```

To view the short form of the help, use `-h`.

```bash
sf scanner run -h
```

### Update Code Analyzer

To update Code Analyzer, rerun the installation command.

```bash
sf plugins install @salesforce/sfdx-scanner
```

### Uninstall Code Analyzer

To uninstall Code Analyzer, run this command.

```bash
sf plugins uninstall @salesforce/sfdx-scanner
```

## Run the CLI Commands

The Code Analyzer CLI commands fall into two groups:

- Commands to scan your codebase, such as `scanner run` and `scanner run dfa`.
- Commands to manage rules, such as `scanner rule list` and `scanner rule add`.

See the [scanner Command Reference](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/command-reference/code-analyzer-command-reference.md) for a full list of CLI commands; each command page includes examples of how to run the commands.

## See Also

- [Salesforce CLI Setup Guide: Update Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_update_cli.htm#sfdx_setup_update_cli)
- [Salesforce CLI Setup Guide: Troubleshoot Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_troubleshoot.htm)