Practical examples and step-by-step guides for integrating Sonar into developer workflows
Website · Docs · Community · @SonarSource
The repositories linked from this page are example implementations, not supported Sonar products. They exist to help you learn and adapt Sonar for your own workflows. Test, secure, and validate anything you use here against your team’s standards before it touches production.
Choose what you want to do, then open the repository that matches your tool or environment. Each guide repository includes the complete steps and supporting files.
I want to:
- Work with AI coding agents
- Improve pull request reviews with Gitar
- Manage application architecture
- Browse every workshop, blueprint, and sample
| If you use | Start here | What you will set up |
|---|---|---|
| Claude Code | Set up Sonar Vortex in Claude Code | Project guidance, automatic analysis after edits, multi-file analysis, and secrets detection |
| OpenAI Codex | Wire your team for agentic development with SonarQube and OpenAI Codex | A hands-on SonarQube Cloud workflow for finding secrets, investigating issues, and verifying AI-generated code |
| Cursor | Set up the SonarQube plugin for Cursor | The SonarQube plugin, SonarQube MCP Server, analysis hooks, secrets detection, and project context |
| A terminal or multiple coding agents | Get started with the SonarQube CLI | Local analysis, agent integrations, Git hooks, project queries, and SonarQube authentication |
| If you want to | Start here |
|---|---|
| Learn the full review workflow in a browser | Gitar workshop |
| Make reviews aware of repository conventions and rules | Configure Gitar context for project-aware code reviews |
| Add organization instructions, Jira, Slack, or custom context | Extend Gitar with organization and external context |
| Run the application used in the Gitar context blueprints | Gitar context ingestion sample |
| If you want to | Start here |
|---|---|
| Explore current architecture, define an intended architecture, and find deviations | Get started managing your architecture with SonarQube |
| Repository | What it covers |
|---|---|
learn-codex-workshop |
Connect Codex CLI to SonarQube Cloud and work through secrets detection, issue investigation, and verification of AI-generated code. |
gitar-workshop |
Use Gitar to review pull requests, enforce repository conventions, and investigate a failing CI pipeline. |
| Repository | What it covers |
|---|---|
blueprint-sonar-vortex-claude |
Set up Sonar Vortex in Claude Code with project context, code verification, and secrets detection. |
blueprint-sonarqube-plugin-cursor |
Add the SonarQube plugin and its supporting integrations to Cursor. |
blueprint-sonarqube-cli |
Use the SonarQube CLI for local analysis, agent integrations, Git hooks, and project data. |
blueprint-architecture-management-sonarqube-cloud |
Explore current architecture, define an intended architecture, and find deviations in SonarQube Cloud. |
blueprint-gitar-context-ingestion |
Configure repository context for project-aware Gitar reviews. |
blueprint-gitar-advanced-config |
Extend Gitar reviews with organization instructions, Jira, Slack, and custom integrations. |
| Repository | What it covers |
|---|---|
sample-gitar-context-ingestion |
Run the Flask application and intentional error-handling bugs used by the Gitar context blueprints. |
Use GitHub topics to narrow the repository list by product, workflow, tool, or language.
- Content:
blueprint,workshop,sample - Product and workflow:
sonarqube-cloud,sonarqube-cli,sonar-vortex,gitar,architecture,code-review - Tool:
claude-code,codex,cursor,github,github-actions,jira,slack - Language:
python,java,flask
Repository names signal what kind of content they contain.
| Name | Content |
|---|---|
blueprint- prefix |
Step-by-step implementation guides with supporting configuration, code, or screenshots |
learn- prefix or -workshop suffix |
Hands-on workshops that can also be followed as standalone tutorials |
sample- prefix |
Focused applications, templates, or configurations used by guides and workshops |
These repositories are examples designed for learning and reference. Review the prerequisites and product documentation for your own environment.
For Sonar product documentation, visit docs.sonarsource.com. For product questions, use the Sonar Community.