LogoLogo
CtrlK
  • Home
  • SonarQube Cloud
  • SonarQube Server
  • SonarQube Community Build
  • Homepage
  • Try out SonarQube Server
  • AI capabilities
    • Overview
    • AI Code Assurance
    • Autodetect AI code
    • AI CodeFix
    • SonarQube MCP Server
  • Advanced security
    • Introduction
    • Analyzing projects for dependencies (SCA)
    • Viewing dependencies
    • Reviewing and fixing dependency risks
    • Managing license profiles and policies
    • Troubleshooting the dependency analysis
    • Best practices for managing dependency risks
  • Server installation and setup
    • Introduction
    • Server components
    • Installing database
    • Server host requirements
    • Pre-installation steps
      • On Linux systems
      • On Unix-based systems
      • On macOS systems
      • Defining a JWT token
    • From ZIP file
      • Installation overview
      • Basic installation
      • Advanced setup
      • Starting / stopping server
        • From the ZIP file
        • Running as a service
    • From Docker image
      • Installation overview
      • Basic installation
      • Advanced setup
      • Starting SonarQube container
    • Installing on Kubernetes or Openshift
      • Installation overview
      • Before you start
      • Customizing Helm chart
      • Installing Helm chart
      • Setting up monitoring
        • Introduction
        • Setting up with Prometheus server
        • Setting up with Datadog
        • List of Prometheus metrics
      • Encrypting sensitive data
    • Network security
      • Securing behind a proxy
      • Network rules
    • Data Center Edition
      • Introduction
      • DCE topology
      • Installation requirements
      • Pre-installation steps
      • Installing from ZIP file
      • Installing on Kubernetes or Openshift
        • Installation overview
        • Before you start
        • Customizing the DCE Helm chart
        • Setting up autoscaling
        • Setting up disaster recovery
          • Disaster recovery architecture example with Azure resources
          • Step 1: Deploy the primary and replica databases
          • Step 2: Set up the primary and replica clusters on AKS
          • Step 3: Configure the Azure Front Door
          • Step 4: Test failover scenarios
        • Installing the DCE Helm chart
        • Installing from Google Cloud Platform
      • Network security
        • Securing behind a proxy
        • Elasticsearch security features
        • Network rules
      • Starting and stopping cluster
    • Setting system properties
      • Configuration methods
      • List of properties common to all editions
      • List of DCE-specific properties
    • Installing plugins
      • Plugin version matrix
      • Installing a plugin
    • Reference architectures
      • Up to 10 M LOC
      • Up to 50 M LOC
  • Server update and maintenance
    • Update
      • Overview
      • Release cycle model
      • Determining the update path
      • Pre-update steps
      • Performing the update
      • Post-update steps
      • Updating from SonarQube Community Build
      • Moving to another SonarQube Server edition
      • Using Marketplace
      • Other migration-related tasks
    • Maintenance
      • Improving performance
      • Migrating database
      • Backup and restore
      • Reindexing
      • Deprecations
        • Deprecation policy
        • Monitoring API deprecation
    • Monitoring
      • SonarQube Server instance
      • Lines of Code
      • Audit logs
    • Troubleshooting
      • Server logs
      • Performance issues
      • Database-related issues
      • Elasticsearch-related issues
      • Other issues
      • Creating support ticket
    • Data Center Edition
      • Monitoring
      • Improving performance
      • Scaling
      • Updating
    • Release notes
    • Product release lifecycle
  • Analyzing source code
    • SonarQube Server analysis overview
    • Project analysis setup
    • Scanners
      • Scanner environment
        • General requirements
        • TLS certificates on client side
        • Checked-out code
      • SonarScanner CLI
      • Azure DevOps Extension
      • Jenkins extension
      • SonarScanner for Maven
      • SonarScanner for Gradle
      • SonarScanner for .NET
        • Introduction
        • Installing the scanner
        • Using the scanner
        • Configuring the scanner
      • SonarScanner for NPM
        • Introduction
        • Installing the scanner
        • Using the scanner
        • Configuring the scanner
      • SonarScanner for Python
    • Analysis parameters
    • Languages
      • Supported languages
      • ABAP
      • Ansible
      • Apex
      • Azure Resource Manager
      • C/C++/Objective-C
        • C/C++/Objective-C analysis overview
        • Analysis modes
        • Prerequisites
        • Running the analysis
        • Customizing the analysis
        • Understanding the analysis
        • Related pages
      • CloudFormation
      • COBOL
      • C#
      • Dart
      • Docker
      • Flex
      • Go
      • HTML
      • Java
      • JavaScript/TypeScript/CSS
      • JCL
      • JSON
      • Kotlin
      • Kubernetes/Helm
      • PHP
      • PLI
      • PL/SQL
      • Python
      • RPG
      • Ruby
      • Rust
      • Scala
      • Swift
      • Secrets
      • Terraform
      • T-SQL
      • VB.NET
      • VB6
      • XML
      • YAML
    • .NET environments
      • Overview
      • Getting started with .NET
      • SonarScanner for .NET
      • .NET test coverage
      • Specifying test projects
      • VB.NET
      • Troubleshooting
    • Test coverage
      • Overview
      • C / C++ / Objective-C test coverage
      • Dart test coverage
      • Go test coverage
      • Java test coverage
      • JavaScript / TypeScript test coverage
      • .NET test coverage
      • PHP test coverage
      • Python test coverage
      • Generic test data
      • Test coverage parameters
      • Test execution parameters
    • Importing external issues
      • External analyzer reports
      • Generic formatted reports
      • SARIF reports
    • Background tasks
    • Pull request analysis
      • Introduction
      • Setting up the pull request analysis
    • Branch analysis
      • Introduction
      • Setting up the branch analysis
    • CI integration
      • Overview
      • Jenkins integration
        • Key features
        • Setting up Jenkins
        • Adding analysis to a Jenkins job
        • Setting up a pipeline pause
      • Codemagic integration
    • SCM integration
    • Security engine custom configuration
    • Troubleshooting the analysis
    • Incremental analysis
      • Introduction
      • Disabling or changing the mechanisms
  • DevOps platform integration
    • GitHub integration
      • Introduction
      • Setting up integration at global level
        • Introduction
        • Setting up a GitHub App
        • Setting up the report of security alerts
        • Setting parameters for GitHub Actions
      • Importing GitHub repositories
      • Setting up project integration
      • Adding analysis to GitHub Actions workflow
    • Bitbucket integration
      • Bitbucket Server & Data Center
      • Bitbucket Cloud integration
    • GitLab integration
      • Introduction
      • Setting up integration at global level
      • Importing your GitLab repositories
      • Setting up GitLab integration at project level
      • Adding analysis to GitLab CI/CD pipeline
    • Azure DevOps integration
      • Introduction
      • Azure Pipelines integration overview
      • Setting up integration at global level
      • Creating and configuring your project
      • Setting up project integration
      • Adding analysis to Azure pipeline
        • Introduction
        • Gradle or Maven project
        • .NET project
        • C family project
        • JS, TS, Go, Python, PHP, etc. project
        • Monorepo projects
        • Using various features
        • Quality gate status in release pipeline
        • SonarQube tasks for Azure Pipelines
      • Troubleshooting analysis
  • User guide
    • Connected mode
    • Viewing projects
      • Retrieving projects
      • Viewing analysis summary
      • Viewing project activity
      • Viewing project structure
      • Viewing project information
    • Viewing reports
      • PDF reports
      • Security reports
      • Regulatory reports
      • Portfolios
    • Monitoring code metrics
      • Introduction
      • Understanding measures and metrics
      • Monitoring project metrics
      • Monitoring portfolio metrics
      • Changing instance modes
    • Understanding rules
      • Overview
      • Software qualities
      • Security-related rules
      • Built-in rule tags
      • Rules for AI CodeFix
    • Quality standards and new code
    • Managing issues
      • Introduction
      • Issue management solution
      • Retrieving issues
      • Reviewing issues
      • Editing issues
      • Fixing issues
      • Issues reported in DevOps platform
    • Managing Security Hotspots
    • Managing your account
      • Introduction
      • Viewing your user profile
      • Subscribing to notifications
      • Changing password
    • Managing your tokens
    • Using a project badge
    • Using applications
    • Keyboard shortcuts
  • Project administration
    • Creating and importing projects
    • Setting project permissions
    • Setting analysis scope
      • Setting the analysis scope of your project
      • Setting initial scope
      • Excluding based on path-matching patterns
      • Excluding based on file extension
      • Excluding from coverage or duplication
      • Applying advanced exclusions
      • Other adjustments
      • Verifying analysis scope
      • Defining matching patterns
    • Changing quality gate
    • Changing quality profiles
    • Configuring new code calculation
    • AI features
      • Overview
      • Set up AI Code Assurance
      • AI CodeFix
    • Managing monorepo projects
    • Setting various features at project level
    • Maintaining project branches
    • Managing project history
    • Customizing Project Information page
    • Managing project tags
    • Changing the project key
    • Webhooks
    • Project move
    • Deleting your project
    • Managing portfolios
    • Managing applications
  • Instance administration
    • Introduction to instance administration
    • Server base URL
    • Global analysis setup
      • Choosing a mode for your instance
        • Overview
        • MQR mode
        • Standard Experience
      • New code definition
      • Quality standards
      • Analysis scope
        • Introduction
        • Excluding files based on file paths
        • Excluding from coverage or duplication
        • Using advanced exclusion features
      • Code metrics
    • System functions setup
      • Notifications
      • Security features
      • Housekeeping
      • Telemetry
      • PDF reports
    • AI features
      • Overview
      • Autodetect AI code
      • Permissions for AI autodetect
      • Enabling AI CodeFix
    • Security
      • User accounts
      • User sessions
      • Tokens
      • Sensitive settings
    • User management
      • Introduction to user management
      • Viewing user accounts
      • Managing groups
      • Managing permissions
      • Associating with SCM account
      • Creating users manually
      • Deactivating users
      • Changing user password
    • Authentication and provisioning
      • Overview of authentication and provisioning
      • HTTP header
      • LDAP
      • SAML
        • Overview of SAML support
        • With Microsoft Entra ID
          • Introduction to SAML with Microsoft Entra ID
          • Setup in Microsoft Entra ID
          • Setup in SonarQube Server
          • Setup of security features
        • With Keycloak
        • With Okta
        • With Ping Identity
          • Introduction to SAML with Ping Identity
          • Setup in Ping Identity
          • Setup in SonarQube Server
          • Setup of security features
        • With SCIM provisioning
          • SCIM overview
          • SCIM with Microsoft Entra ID
          • SCIM with Okta
      • GitHub
      • Bitbucket Cloud
      • GitLab
        • Provisioning modes
          • Introduction to GitLab provisioning modes
          • Just-in-Time provisioning
          • Automatic provisioning
        • Setting up authentication
        • Managing JIT provisioning
        • Managing automatic provisioning
        • Disabling authentication
      • Troubleshooting
    • License administration
    • UI customization
      • Look and feel
      • Custom messages
    • System info and server ID
    • Inactive projects
  • Quality standards administration
    • Managing quality gates
      • Introduction
      • Understanding quality gates
      • Viewing a quality gate
      • Managing custom quality gates
      • Changing default quality gate
      • Associating a quality gate with projects
    • Managing quality profiles
      • Introduction
      • Understanding quality profiles
      • Viewing quality profiles
      • Creating a quality profile
      • Editing a quality profile
      • Associating with projects
      • Changing default quality profile
      • Maintaining quality profiles
      • Granting permissions to users
    • Standards for AI Code Assurance
      • Set your AI standards
      • Quality gates for AI code
      • Quality profiles for AI code
      • Monitor projects with AI code
  • Design and Architecture
    • Overview
    • Cycle detection
    • Configuring the architecture analysis
  • Extension guide
    • Web API
    • Adding coding rules
    • Developing a plugin
      • Plugin basics
      • Supporting new languages
      • Executable lines
      • Adding pages to the webapp
      • Supporting SCM providers
    • Internationalization
  • SonarQube glossary
On this page

Was this helpful?

  1. Analyzing source code

Scanners

Information about various SonarScanners.

Scanner environmentSonarScanner CLIAzure DevOps ExtensionJenkins extensionSonarScanner for MavenSonarScanner for GradleSonarScanner for .NETSonarScanner for NPMSonarScanner for Python
PreviousProject analysis setupNextScanner environment

Was this helpful?

Resources

  • Sonar
  • Sonar Rules Catalog
  • Sonar Community

© 2008-2024 SonarSource SA. All rights reserved.