Skip to content
Documentation

Documentation

sonarqube-client-go is a type-safe Go client library and command-line interface for the SonarQube web API.

  • Go SDK (sonar package): strongly typed request options and responses, token or basic authentication, V1 and V2 APIs, opt-in retries, pluggable HTTP middleware.
  • CLI (sonar-cli): every SDK service and method as a subcommand, JSON / YAML / table output, automatic pagination, shell completion.

These guides explain how to use both. The details of every type and method are in the API reference on pkg.go.dev.

Installation
Install the CLI or add the SDK to a Go module.
CLI
Authentication, output formats, pagination and completion of sonar-cli.
Go SDK
Create a client, authenticate and call the API.
Client configuration
Timeouts, HTTP client, transport, retries and middleware.
Errors and pagination
Handle API errors and walk through paginated results.
Services
Every service, its CLI command and its methods (generated).
Compatibility
Supported SonarQube versions and editions.