feat: add Codacy Cloud CLI documentation#2673
Conversation
Introduces a dedicated page for the Codacy Cloud CLI under the Codacy AI section, covering installation, authentication, the optional Claude Code skill, capability overview with examples, and example workflows. Adds cross-references from Codacy AI, API tokens, Using the Codacy API, Issues, and Pull Requests pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Overall readability score: 54.22 (🟢 +0.04)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
The PR successfully adds comprehensive documentation for the Codacy Cloud CLI, covering installation, authentication, and core workflows. Codacy analysis indicates the changes are up to standards with no new quality issues detected.
Two primary concerns should be addressed before merging:
- The current navigation structure nests the CLI documentation under 'Codacy AI', which may hide its general-purpose utility for non-AI workflows such as repository and issue management.
- Hardcoded values in GitHub Actions documentation snippets reduce the 'copy-paste' usability for end-users and should be replaced with context variables.
About this PR
- No Jira ticket was provided to confirm broader project requirements or tracking.
Test suggestions
- Verify all relative links (cross-references) added to existing documentation files correctly resolve to the new CLI page or specific anchors.
- Validate the syntax and functionality of the provided 'jq' reporting examples against standard JSON output from the CLI.
- Ensure the Loom video embed (iframe) renders correctly and is responsive across different screen sizes.
- Verify the command syntax in all provided examples against the latest CLI help output (codacy --help).
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify all relative links (cross-references) added to existing documentation files correctly resolve to the new CLI page or specific anchors.
2. Validate the syntax and functionality of the provided 'jq' reporting examples against standard JSON output from the CLI.
3. Ensure the Loom video embed (iframe) renders correctly and is responsive across different screen sizes.
4. Verify the command syntax in all provided examples against the latest CLI help output (codacy --help).
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
| - codacy-guardrails/codacy-guardrails-faq.md | ||
| - Codacy AI: | ||
| - codacy-ai/codacy-ai.md | ||
| - Codacy Cloud CLI: codacy-cloud-cli/index.md |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Suggestion: The Codacy Cloud CLI is a general-purpose tool for repository and issue management. Consider moving it from the 'Codacy AI' section to a more prominent location, such as a new top-level section named 'Codacy CLI' located after 'Codacy Guardrails', to improve discoverability for non-AI use cases.
| env: | ||
| CODACY_API_TOKEN: ${{ secrets.CODACY_API_TOKEN }} | ||
| run: | | ||
| codacy issues gh ${{ github.repository_owner }} my-repo \ |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: Use the ${{ github.event.repository.name }} variable instead of the hardcoded my-repo to make the workflow example more reusable across different repositories.
| codacy issues gh ${{ github.repository_owner }} my-repo \ | |
| codacy issues gh ${{ github.repository_owner }} ${{ github.event.repository.name }} \ |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for the new Codacy Cloud CLI, including a dedicated index page and cross-references throughout the existing documentation. The feedback focuses on technical refinements: replacing deprecated iframe attributes with modern HTML5 standards, adding usage examples for specific CLI flags, and ensuring shell script safety in CI/CD examples by quoting variables.
|
|
||
| Pair it with the [Codacy Claude Code skill](#install-the-claude-code-skill) to interact with your Codacy data in plain language directly from your AI assistant. | ||
|
|
||
| <div style="position: relative; padding-bottom: 61.224489795918366%; height: 0;"><iframe src="https://www.loom.com/embed/1960b3f07f2c419682a1e22e2b2928d1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div> |
There was a problem hiding this comment.
The frameborder, webkitallowfullscreen, and mozallowfullscreen attributes are deprecated in HTML5. It is recommended to use the standard allowfullscreen attribute and set the border via CSS for better compatibility and adherence to modern standards.
| <div style="position: relative; padding-bottom: 61.224489795918366%; height: 0;"><iframe src="https://www.loom.com/embed/1960b3f07f2c419682a1e22e2b2928d1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div> | |
| <div style="position: relative; padding-bottom: 61.224489795918366%; height: 0;"><iframe src="https://www.loom.com/embed/1960b3f07f2c419682a1e22e2b2928d1" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; border: 0;"></iframe></div> |
| codacy findings gh my-org --scan-types SCA,IaC --severities High | ||
| ``` | ||
|
|
||
| Findings are tracked with statuses like `Overdue`, `OnTrack`, and `DueSoon`. Use `--statuses` to filter accordingly. |
There was a problem hiding this comment.
It would be helpful to include a concrete example of how to use the --statuses flag to show the expected format (e.g., comma-separated values).
| Findings are tracked with statuses like `Overdue`, `OnTrack`, and `DueSoon`. Use `--statuses` to filter accordingly. | |
| Findings are tracked with statuses like Overdue, OnTrack, and DueSoon. Use --statuses to filter accordingly (e.g., --statuses Overdue,DueSoon). |
| env: | ||
| CODACY_API_TOKEN: ${{ secrets.CODACY_API_TOKEN }} | ||
| run: | | ||
| codacy issues gh ${{ github.repository_owner }} my-repo \ |
There was a problem hiding this comment.
In GitHub Actions, it is a best practice to quote variables used in shell commands to prevent issues with word splitting or special characters, even if the current value is expected to be a single word.
| codacy issues gh ${{ github.repository_owner }} my-repo \ | |
| codacy issues gh "${{ github.repository_owner }}" my-repo \ |
- Replace spaced em dashes with parentheses/periods (Microsoft.Dashes) - Add unignore to vale vocabulary accept list - Fix PR's possessive to pull request - Wrap GitHub Actions YAML example in raw tags to prevent Jinja2 parsing Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Clarify that credentials are stored encrypted at ~/.codacy/credentials - Complete the API token path to include "API Tokens" step Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Move Codacy Cloud CLI from under Codacy AI to its own top-level section between Codacy Guardrails and Codacy AI (CLI covers repo/issue/findings management, not AI features) - Remove misplaced tip from codacy-ai.md - Remove deprecated iframe attributes (frameborder, webkitallowfullscreen, mozallowfullscreen) per HTML5 standards - Add --statuses example to security findings section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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>
Rename section from Claude Code-specific to general AI assistant guidance. Cover both Claude Code and Claude.ai installation paths. Add note for non-Claude users pointing them to the skills repo as a reference. Add codacy-skills repo to See also. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Remove monthly quality report section and simplify the CI example to a minimal, honest skeleton. The previous example only echoed to stdout without actually doing anything useful. Users can wire up the JSON output themselves. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…default Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Closing in favour of a clean squashed PR. |
1 participant
Summary
docs/codacy-cloud-cli/index.mdpage under the Codacy AI section covering installation, authentication, the optional Claude Code skill, and a capability-focused overview with example workflowsmkdocs.ymlto include the new page in the navigationWhat the page covers
codacy login(interactive) or--token/CODACY_API_TOKENfor CI/CDclaude plugin install codacy-skills@codacy) for natural-language interactionghCLI + AI Reviewer, monthly JSON quality report, scheduled GitHub Actions triageVideo
Includes a Loom embed of the walkthrough video.
Test plan
codacy --helpoutput🤖 Generated with Claude Code