Skip to content

Commit 33259cb

Browse files
claudiacodacyclaude
andcommitted
refactor: consolidate code blocks for readability
Replace alternating prose/code/prose/code pattern with grouped, commented code blocks. Reduces 18 code blocks to 12 across the What you can do section. Also removes italics from skill prompt examples. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 96d4a78 commit 33259cb

1 file changed

Lines changed: 27 additions & 48 deletions

File tree

docs/codacy-cloud-cli/index.md

Lines changed: 27 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ claude plugin install codacy-skills@codacy
5353

5454
Once installed, you can ask Claude things like:
5555

56-
- *"Show me the critical security findings in my org"*
57-
- *"What issues were introduced in PR #42?"*
58-
- *"Ignore all false positives in the last pull request"*
56+
- "Show me the critical security findings in my org"
57+
- "What issues were introduced in PR #42?"
58+
- "Ignore all false positives in the last pull request"
5959

6060
## What you can do
6161

@@ -71,33 +71,31 @@ Use `--output json` on any command to get machine-readable output for scripting.
7171

7272
### Manage your repositories
7373

74-
List the repositories in an organization and see their analysis status:
75-
7674
```bash
75+
# List repositories in an organization
7776
codacy repositories gh my-org
78-
```
79-
80-
Get a full overview of a specific repository (analysis status, quality metrics, and recent activity):
8177

82-
```bash
78+
# Get a full overview of a specific repository
8379
codacy repository gh my-org my-repo
8480
```
8581

8682
You can also add or remove repositories, follow/unfollow them, link coding standards, and request reanalysis. Use flags like `--add`, `--remove`, and `--reanalyze` on the same command.
8783

8884
### Review code issues
8985

90-
List issues in a repository, with optional filters for severity, category, tool, author, and branch:
86+
List and filter issues by severity, category, tool, author, or branch:
9187

9288
```bash
89+
# List all issues
9390
codacy issues gh my-org my-repo
91+
92+
# Filter by severity and category
9493
codacy issues gh my-org my-repo --severities Critical,High --categories Security
95-
codacy issues gh my-org my-repo --branch feature/my-feature --authors dev@example.com
96-
```
9794

98-
Get a count overview instead of the full list:
95+
# Filter by branch or author
96+
codacy issues gh my-org my-repo --branch feature/my-feature --authors dev@example.com
9997

100-
```bash
98+
# Show counts only
10199
codacy issues gh my-org my-repo --overview
102100
```
103101

@@ -115,16 +113,16 @@ codacy issue gh my-org my-repo <issueId> --ignore --ignore-reason AcceptedUse
115113

116114
### Investigate security findings
117115

118-
List security findings for an organization or a specific repository:
116+
List findings for an organization or a specific repository, with optional filters:
119117

120118
```bash
119+
# Organization-wide findings
121120
codacy findings gh my-org
122-
codacy findings gh my-org my-repo --severities Critical,High
123-
```
124121

125-
Filter by scan type to focus on what matters:
122+
# Per-repository, filtered by severity
123+
codacy findings gh my-org my-repo --severities Critical,High
126124

127-
```bash
125+
# Filter by scan type
128126
codacy findings gh my-org --scan-types SAST,Secrets
129127
codacy findings gh my-org --scan-types SCA,IaC --severities High
130128
```
@@ -137,61 +135,42 @@ codacy findings gh my-org --statuses Overdue,DueSoon
137135

138136
### Inspect pull requests
139137

140-
Get the full analysis summary for a pull request:
141-
142138
```bash
139+
# Get the full analysis summary
143140
codacy pull-request gh my-org my-repo 42
144-
```
145141

146-
View an annotated diff showing new issues and coverage changes line by line:
147-
148-
```bash
142+
# View an annotated diff with new issues and coverage changes
149143
codacy pull-request gh my-org my-repo 42 --diff
150-
```
151-
152-
Ignore all potential false positives in a PR at once:
153144

154-
```bash
145+
# Ignore all false positives in bulk
155146
codacy pull-request gh my-org my-repo 42 --ignore-all-false-positives
156-
```
157147

158-
Request reanalysis of the pull request HEAD commit:
159-
160-
```bash
148+
# Trigger reanalysis of the HEAD commit
161149
codacy pull-request gh my-org my-repo 42 --reanalyze
162150
```
163151

164152
### Configure tools and patterns
165153

166-
List all tools for a repository and see which ones are enabled:
167-
168154
```bash
155+
# List all tools and see which are enabled
169156
codacy tools gh my-org my-repo
170-
```
171157

172-
Enable or disable a specific tool:
173-
174-
```bash
158+
# Enable or disable a tool
175159
codacy tool gh my-org my-repo eslint --enable
176160
codacy tool gh my-org my-repo pylint --disable
177-
```
178-
179-
Import tool configurations from a `.codacy/codacy.config.json` file:
180161

181-
```bash
162+
# Import tool configuration from .codacy/codacy.config.json
182163
codacy tools gh my-org my-repo --import
183164
```
184165

185-
Bulk-enable or bulk-disable patterns for a tool:
166+
Bulk-enable or bulk-disable patterns, or set a parameter on a specific pattern:
186167

187168
```bash
169+
# Bulk-enable or bulk-disable by category or severity
188170
codacy patterns gh my-org my-repo eslint --categories Security --enable-all
189171
codacy patterns gh my-org my-repo eslint --severities Minor --disable-all
190-
```
191172

192-
Set a parameter on a specific pattern:
193-
194-
```bash
173+
# Set a parameter on a specific pattern
195174
codacy pattern gh my-org my-repo eslint max-len --enable --parameter max=120
196175
```
197176

0 commit comments

Comments
 (0)