--- schema_version: "1" id: 8bb3dd0825c7dd73fa07b1fb8b72fbfb2a97aa25de17e5f881cccc62188adc2c title: Get Started with Salesforce Code Analyzer collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/code-analyzer/salesforce-code-analyzer/guides/get-started.md canonical_url: https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/get-started.html source_site: developer.salesforce.com content_type: documentation content_hash: 50b232e65b6440cf71985e74981e6eb30c8945576a8f3fb8416c741a2c90df9a products: - Salesforce Code Analyzer --- # Get Started with Salesforce Code Analyzer To get started scanning your code with Salesforce Code Analyzer, follow this developer workflow and choose resources that match your learning style. ## 1. Discover Salesforce Code Analyzer is a unified tool for source code analysis available in Salesforce CLI, VS Code, GitHub Actions, and DevOps Center Testing. Code Analyzer analyzes multiple languages. It provides a consistent experience to help you identify rule violations. - [Overview](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.md). Get a bird's-eye view of Code Analyzer. - [Engines](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/engines.md). Check out all the supported engines, such as ESLint, PMD, and more. - [Migrate from v4](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/migrate.md). If you previously used Code Analyzer v4, read the migration guide to help you easily move to v5. **important:** As of August 2025, Code Analyzer v4 is retired and we no longer support it. ## 2. Set Up Code Analyzer and Start Scanning To get started with Code Analyzer, follow these instructions for your tool of choice. - [Salesforce CLI](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/analyze.md). You must install Salesforce CLI to use the Code Analyzer CLI commands. Complete the prerequisties, install the Code Analyzer CLI plugin, and get started. - [Salesforce Code Analyzer VS Code Extension](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/analyze-vscode.md). If you use Visual Studio Code (VS Code), install the Code Analyzer VS Code extension to scan your code easily as you work. ## 3. Work with Code Analyzer After you understand how to view and run Code Analyzer rules on your code, play around with more advanced features: customize the Code Analyzer configuration, create new engine rules, and integrate Code Analyzer into your continuous integration/continuous delivery (CI/CD) process. - [Configuration](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/config-custom.md). Customize how Code Analyzer works by creating a configuration file. - [CI/CD Integration, including GitHub Actions](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/ci-cd.md). Learn how to integrate Code Analyzer into your CI/CD process. - Custom Rules. Extend your Code Analyzer implementation by creating custom rules for these engines: - [ESLint](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/engine-eslint.md#add-custom-eslint-configuration-and-rules) - [PMD](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/engine-pmd.md#add-custom-pmd-rules) - [Regex](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/engine-regex.md#add-custom-regex-rules) - [DevOps Center Testing](https://help.salesforce.com/s/articleView?id=platform.devops_testing_optional_setup_tasks_to_integrate_code_analyzer_v5_as_test_provider.htm&type=5). Integrate Code Analyzer with DevOps Center Testing, a feature that extends the capabilities of DevOps Center. - [AppExchange Security Review](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/appexchange.md). Produce the Code Analyzer reports required if you want to list a managed package on AppExchange. ## 4. Keep Up with the Latest News Code Analyzer launches a new release monthly. Read Code Analyzer [Release Notes](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/relnotes/release-notes.md) to stay on top of the latest developments. ## 5. Report Bugs, Feedback, and Request New Features - To report an issue with Code Analyzer, create a [bug on GitHub](https://github.com/forcedotcom/code-analyzer/issues/new/choose). - To suggest a feature enhancement, create a [request on GitHub](https://github.com/forcedotcom/code-analyzer/issues/new?template=5-feature_request.yml). - To provide general feedback, use [this form](http://sfdc.co/CodeAnalyzerFeedback). ## See Also - [Pass the AppExchange Security Review](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_guidelines.htm) - [Salesforce CLI Setup Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup) - [Salesforce Code Analyzer Github Repository](https://github.com/forcedotcom/sfdx-scanner) - [Salesforce DX Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev) - [Scan Your Solution with Salesforce Code Analyzer](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_code_analyzer_scan.htm) - [Trailhead: Build Apps Together with Package Development](https://trailhead.salesforce.com/trails/sfdx_get_started)