Skip to content

docs: link each Codacy skill to its SKILL.md on GitHub #2747

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
claudiacodacy merged 1 commit into from
Sep 9, 2026
Merged

docs: link each Codacy skill to its SKILL.md on GitHub #2747

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions docs/codacy-skills/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The skills are open source under the MIT license and live in the [`codacy/codacy

## 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 |
| Skill | What it does |
|---|---|
| [`codacy-cloud-cli`](https://github.com/codacy/codacy-skills/blob/master/skills/codacy-cloud-cli/SKILL.md) | Queries repositories, issues, security findings, pull requests, tools, and patterns on Codacy Cloud |
| [`codacy-code-review`](https://github.com/codacy/codacy-skills/blob/master/skills/codacy-code-review/SKILL.md) | Adds Codacy issues, security findings, coverage, and duplication to a pull request review |
| [`codacy-analysis-cli`](https://github.com/codacy/codacy-skills/blob/master/skills/codacy-analysis-cli/SKILL.md) | Runs static analysis locally, without sending your code to Codacy |
| [`configure-codacy`](https://github.com/codacy/codacy-skills/blob/master/skills/configure-codacy/SKILL.md) | Discovers your project's stack, enables the tools and patterns that fit it, and cuts noise from the results |
| [`configure-codacy-cloud`](https://github.com/codacy/codacy-skills/blob/master/skills/configure-codacy-cloud/SKILL.md) | Tunes the configuration of a repository already analyzed on Codacy, without running local analysis |
| [`setup-coverage`](https://github.com/codacy/codacy-skills/blob/master/skills/setup-coverage/SKILL.md) | Detects your test framework and CI, then adds what's missing to generate and upload coverage reports |

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.

Expand All @@ -26,13 +26,15 @@ The skills work together. Ask your assistant to review a pull request and it use

## Requirements

Install the CLIs the skills you want depend on:
Most skills use both CLIs. Install them with:

```bash
npm install -g @codacy/codacy-cloud-cli
npm install -g @codacy/analysis-cli
```

`codacy-cloud-cli` needs only the Codacy Cloud CLI and `codacy-analysis-cli` only the Codacy Analysis CLI. `setup-coverage` also needs the repository to be added to Codacy.

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.
Expand Down
Loading