Prerequisites

To create a Sonar plugin, you need Java 6 or later. Maven is required to compile and package the plugin.

Creating a New Plugin

The recommended way is to duplicate one of the examples located in the 'plugins' directory of the following GitHub repository: https://github.com/SonarSource/sonar-examples. If you don't know which one must be used, then select plugins/sonar-reference-plugin.

There are two ways to copy the example:

1. if you have Git, just clone the repository
2. if you don't have Git, download the repository at https://github.com/SonarSource/sonar-examples/zipball/master

Building and Deploying a Plugin

Simply execute:

from the root directory, for example /path/to/sonar-reference-plugin. The JAR file is generated in the 'target' directory.

Then, copy the JAR to the '$SONAR_HOME/extensions/plugin' directory and restart your Sonar server.

Next step is: coding a plugin.