-
Notifications
You must be signed in to change notification settings - Fork 46
docs: add Codacy Skills section under Developer tools #2745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
d5ca10b
docs: add Codacy Skills section under Developer tools
claudiacodacy 2a4e327
docs: state the Skills IA decision as a durable rule
claudiacodacy cc6bcb7
fix: clear Vale on the lines this branch adds
claudiacodacy 7d85932
docs: trim the Skills IA entry to the decision and its reason
claudiacodacy 203016b
Merge branch 'master' into docs/codacy-skills-section
claudiacodacy ca0baf2
docs: drop stale premises from the Guardrails IA entries
claudiacodacy 32ccb20
docs: remove the overview video from the Codacy Cloud CLI page
claudiacodacy fe3f6a1
docs: cover Copilot and Gemini CLI in the update instructions
claudiacodacy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,6 +14,7 @@ bundler-audit | |
| Checkov | ||
| Checkstyle | ||
| Clang-Tidy | ||
| CLIs | ||
| cloc | ||
| CloudFormation | ||
| Cobertura | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| --- | ||
| description: Install the Codacy Skills to let your AI assistant query your Codacy data, review pull requests, configure analysis, and set up coverage in plain language. | ||
| --- | ||
|
|
||
| # Codacy Skills | ||
|
|
||
| The Codacy Skills teach your AI coding assistant how to drive Codacy: they tell it which command to run, how to read the output, and what to do next. You describe what you want in plain language instead of remembering command syntax. | ||
|
|
||
| The skills are open source under the MIT license and live in the [`codacy/codacy-skills`](https://github.com/codacy/codacy-skills) repository. They follow the [Agent Skills](https://agentskills.io/) standard, so they work with Claude Code, Claude.ai, OpenAI Codex, GitHub Copilot, Gemini CLI, and any other assistant that supports it. | ||
|
|
||
| ## Available skills | ||
|
|
||
| | Skill | What it does | Needs | | ||
| |---|---|---| | ||
| | `codacy-cloud-cli` | Queries repositories, issues, security findings, pull requests, tools, and patterns on Codacy Cloud | Codacy Cloud CLI | | ||
| | `codacy-code-review` | Adds Codacy issues, security findings, coverage, and duplication to a pull request review | Both CLIs | | ||
| | `codacy-analysis-cli` | Runs static analysis locally, without sending your code to Codacy | Codacy Analysis CLI | | ||
| | `configure-codacy` | Discovers your project's stack, enables the tools and patterns that fit it, and cuts noise from the results | Both CLIs | | ||
| | `configure-codacy-cloud` | Tunes the configuration of a repository already analyzed on Codacy, without running local analysis | Both CLIs | | ||
| | `setup-coverage` | Detects your test framework and CI, then adds what's missing to generate and upload coverage reports | A repository on Codacy | | ||
|
|
||
| The skills work together. Ask your assistant to review a pull request and it uses `codacy-code-review`, which in turn reaches for the two CLI skills to get local analysis and cloud coverage data. | ||
|
|
||
| !!! note | ||
| The Codacy Cloud CLI (`codacy`) and the Codacy Analysis CLI (`codacy-analysis`) are different tools. Use `codacy` to query your data on Codacy, and `codacy-analysis` to run analyzers on your machine. | ||
|
|
||
| ## Requirements | ||
|
|
||
| Install the CLIs the skills you want depend on: | ||
|
|
||
| ```bash | ||
| npm install -g @codacy/codacy-cloud-cli | ||
| npm install -g @codacy/analysis-cli | ||
| ``` | ||
|
|
||
| Then authenticate. Run `codacy login` and paste an [account API token](../codacy-api/api-tokens.md#account-api-tokens), or set the `CODACY_API_TOKEN` environment variable for non-interactive environments. Both CLIs read the same credentials from `~/.codacy/credentials`, so a single login covers both. | ||
|
|
||
| See [Codacy Cloud CLI](../codacy-cloud-cli/index.md#authentication) for the full set of authentication options, including repository API tokens. | ||
|
|
||
| ## Install the skills | ||
|
|
||
| How you install the skills depends on your assistant. | ||
|
|
||
| ### Claude Code | ||
|
|
||
| Add the Codacy marketplace, then install the plugin: | ||
|
|
||
| ```bash | ||
| claude plugin marketplace add codacy/codacy-skills | ||
| claude plugin install codacy-skills@codacy | ||
| ``` | ||
|
|
||
| ### Claude.ai | ||
|
|
||
| Download the folder of the skill you want from the repository, zip it, and upload it under **Settings > Capabilities > Skills > Upload skill**. Repeat for each skill you want. | ||
|
|
||
| ### OpenAI Codex | ||
|
|
||
| Codex discovers skills from an `.agents/skills/` directory. The repository already points at each skill from that path, so cloning the repository is enough: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/codacy/codacy-skills ~/.codacy-skills | ||
|
|
||
| # For a single project, from the project's root directory | ||
| ln -s ~/.codacy-skills/.agents/skills .agents/skills | ||
|
|
||
| # Or for every project | ||
| ln -s ~/.codacy-skills/.agents/skills ~/.agents/skills | ||
|
claudiacodacy marked this conversation as resolved.
|
||
| ``` | ||
|
|
||
| ### GitHub Copilot | ||
|
|
||
| Copilot's coding agent reads an `AGENTS.md` file from the root of your repository: | ||
|
|
||
| ```bash | ||
| curl -o AGENTS.md https://raw.githubusercontent.com/codacy/codacy-skills/master/AGENTS.md | ||
| ``` | ||
|
|
||
| If your repository already has an `AGENTS.md`, merge the two files instead of overwriting yours. | ||
|
|
||
| ### Gemini CLI | ||
|
|
||
| ```bash | ||
| gemini extensions install https://github.com/codacy/codacy-skills.git --consent | ||
| ``` | ||
|
|
||
| ## Keep the skills up to date | ||
|
|
||
| The skills change as the CLIs gain commands, so update them periodically. How you do that depends on how you installed them: | ||
|
|
||
| - **Claude Code:** `claude plugin update` | ||
| - **Claude.ai:** download and upload the skill folder again, replacing the existing one | ||
| - **OpenAI Codex:** `git -C ~/.codacy-skills pull` | ||
| - **GitHub Copilot:** download `AGENTS.md` again and merge it into yours. The install copies the file into your repository rather than linking to it, so it never updates on its own. | ||
| - **Gemini CLI:** `gemini extensions update codacy-skills`. Restart the CLI afterward for the change to take effect. | ||
|
|
||
| ## What you can ask for | ||
|
|
||
| Once the skills are installed, describe the outcome you want rather than the command: | ||
|
|
||
| ```text | ||
| Show me the critical security findings in my org | ||
| What issues were introduced in PR #42? | ||
| Ignore all false positives in the last pull request | ||
| Set up coverage reporting for this repository | ||
| ``` | ||
|
|
||
| Your assistant picks the skill that matches, runs the underlying commands, and reports back. Two workflows are documented in more detail elsewhere: | ||
|
|
||
| - [Auditing vulnerable dependencies across repositories](../codacy-cloud-cli/index.md#affected-functions-scale) with `codacy-cloud-cli`. | ||
| - [Running auto-configuration locally](../repositories-configure/configuring-code-patterns.md#running-it-with-codacy-skills) with `configure-codacy`, which works on any plan. | ||
|
|
||
| !!! note | ||
| A skill runs the CLIs with your credentials and acts on what it finds. Review what it proposes before letting it ignore findings, change your tool configuration, or upgrade a dependency. | ||
|
|
||
| ## See also | ||
|
|
||
| - [Codacy Skills on GitHub](https://github.com/codacy/codacy-skills) | ||
| - [Codacy Cloud CLI](../codacy-cloud-cli/index.md) | ||
| - [API tokens](../codacy-api/api-tokens.md) | ||
| - [Adding coverage to your repository](../coverage-reporter/index.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.