> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# clicklogiq/sonarqube

## Commands

### setup-environment

Setup requirements

### install-engine

Install Sonarqube scanner

| Parameter | Type | Default | Description |
|---|---|---|---|
| `engine_version` | string | 4.2.0.1873 |  |

### code-analysis

Run Sonarqube scanner for code analysis

| Parameter | Type | Default | Description |
|---|---|---|---|
| `organization` | string |  |  |
| `host_url` | string |  |  |
| `login` | string |  |  |
| `projectKey` | string |  |  |
| `projectBaseDir` | string | /root/circleci-build |  |
| `sources` | string | . |  |
| `github_oauth` | string |  |  |
| `github_repository` | string |  |  |
| `runner_opts` | string | -Xms1024m -Xmx4096m |  |
| `exclusions` | string | **/*.yaml,**/*.yml |  |
| `engine_version` | string | 4.2.0.1873 |  |

### commit-analysis

Run Sonarqube scanner for commit analysis

| Parameter | Type | Default | Description |
|---|---|---|---|
| `organization` | string |  |  |
| `host_url` | string |  |  |
| `login` | string |  |  |
| `projectKey` | string |  |  |
| `projectVersion` | string |  |  |
| `projectBaseDir` | string | /root/circleci-build |  |
| `sources` | string | . |  |
| `github_oauth` | string |  |  |
| `github_pullRequest` | string |  |  |
| `github_repository` | string |  |  |
| `github_disableInlineComments` | boolean | false |  |
| `analysis_mode` | string | preview |  |
| `issuesReport_console_enable` | boolean | true |  |
| `runner_opts` | string | -Xms1024m -Xmx4096m |  |
| `exclusions` | string | **/*.yaml,**/*.yml |  |
| `engine_version` | string | 4.2.0.1873 |  |

## Jobs

### analyze

| Parameter | Type | Default | Description |
|---|---|---|---|
| `organization` | env_var_name | SONARQUBE_SERVER_ORGANIZATION |  |
| `host_url` | env_var_name | SONARQUBE_SERVER_URL |  |
| `login` | env_var_name | SONARQUBE_SERVER_LOGIN |  |
| `projectKey` | env_var_name | CIRCLE_PROJECT_REPONAME |  |
| `projectVersion` | env_var_name | CIRCLE_BUILD_NUM |  |
| `github_oauth` | env_var_name | SONARQUBE_GITHUB_OAUTH |  |
| `github_repository` | env_var_name | SONARQUBE_SERVER_ORGANIZATION |  |
| `github_pullRequest` | env_var_name | CIRCLECI_PULL_REQUEST_NUMBER |  |

## Executors

### scanner