sonar-shell's Introduction

sonar-shell

SonarQube SHELL

How to build

Clone a copy of the main SonarQube Shell git repository by running:

git clone https://github.com/cezarcoca/sonar-shell.git

Enter the sonar-shell directory

cd sonar-shell

Run the build script:

mvn clean package

Usage

To launch SonarQube Shell use the below command

java -jar sonar-shell-1.0-RC.jar

Shell commands

For assistance press or type help then hit ENTER. Type help <command> to read more about a specific command. These are the common SonarQube shell commands used in various situations:

connect

Connects to the SonarQube server. If this is not specified, attempts to connect to localhost, port 9000 using the HTTP protocol.

connect --host sonarqube.com --port 443 --protocol https

disconnect

Disconnects from the SonarQube server

export

Exports the issues reported by the SonarQube to a file using the maintainability profile provided as parameter

export --projectKeys "closure:library,org.apache.tika:tika,c-family:nginx" --profile maintainability.json --path issues.json

The profile file format is presented below:

{
  "category": "maintainability",
  "axes": [
    {
      "name": "complexity",
      "rules": ["javascript:FunctionComplexity", "squid:MethodCyclomaticComplexity", "squid:S1067", "cpp:FunctionComplexity"]
    },
    {
      "name": "readability",
      "rules": ["javascript:NestedIfDepth", "squid:S00115", "squid:S134", "c:S134"]
    }
  ]
}

Recommend Projects