Skip to content

Commit e647c38

Browse files
CLI-93 Add Claude Code setup steps to readme (#73)
1 parent 5b7575f commit e647c38

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,16 @@ curl -o- https://raw.githubusercontent.com/SonarSource/sonarqube-cli/refs/heads/
1919
irm https://raw.githubusercontent.com/SonarSource/sonarqube-cli/refs/heads/master/user-scripts/install.ps1 | iex
2020
```
2121

22+
## Setup steps for Claude Code integration
23+
Below is an example of a setup which will work for SonarQube Cloud.
24+
The authentication step is optional. With authentication, more types of secrets can be detected.
25+
26+
```
27+
sonar auth login
28+
sonar install secrets
29+
sonar integrate claude -g
30+
```
31+
2232
## Commands
2333

2434
### `sonar auth`

build-scripts/README.template.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Build](https://github.com/SonarSource/sonarqube-cli/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/SonarSource/sonarqube-cli/actions/workflows/build.yml)
44
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SonarSource_sonarqube-cli&metric=alert_status&token=4ad890bd54c6c3feb5d5251004fa3e5b1f665dea)](https://sonarcloud.io/summary/new_code?id=SonarSource_sonarqube-cli)
55

6-
A CLI application for interacting with SonarQube products. This product is currently in Open Beta and we are actively collecting feedback on it. Please share your thoughts via [this form](https://forms.gle/xE61HS2E5NzxFCSR9)!
6+
A CLI application for interacting with SonarQube products. This product is currently in open Beta, and we are actively collecting feedback on it. Please share your thoughts via [this form](https://forms.gle/xE61HS2E5NzxFCSR9)!
77

88
## Installation
99

@@ -19,6 +19,16 @@ curl -o- https://raw.githubusercontent.com/SonarSource/sonarqube-cli/refs/heads/
1919
irm https://raw.githubusercontent.com/SonarSource/sonarqube-cli/refs/heads/master/user-scripts/install.ps1 | iex
2020
```
2121

22+
## Setup steps for Claude Code integration
23+
Below is an example of a setup which will work for SonarQube Cloud.
24+
The authentication step is optional. With authentication, more types of secrets can be detected.
25+
26+
```
27+
sonar auth login
28+
sonar install secrets
29+
sonar integrate claude -g
30+
```
31+
2232
## Commands
2333

2434
<!-- COMMANDS -->

0 commit comments

Comments
 (0)