repository.md

repository Command Spec

Status: ✅ Done (2026-02-18); actions (--add, --remove, --follow, --unfollow) added 2026-02-25; analysis status + --reanalyze added 2026-03-05

Purpose

Show details, status, and metrics for a specific repository — a full dashboard view.

Usage

codacy repository <provider> <organization> <repository>
codacy repo gh my-org my-repo --output json
codacy repo gh my-org my-repo --reanalyze

API Endpoints (parallel)

• getRepositoryWithAnalysis — AnalysisService.getRepositoryWithAnalysis(provider, org, repo)
• listRepositoryPullRequests — AnalysisService.listRepositoryPullRequests(provider, org, repo)
• issuesOverview — AnalysisService.issuesOverview(provider, org, repo)
• listRepositoryCommits with limit=1 — head commit timing for analysis status
• listCoverageReports with limit=1 — hasCoverageOverview flag

Output Sections

About (key-value table)

Field	Source
Repository	provider / org / name
Visibility	repo.visibility
Default Branch	repo.defaultBranch.name
Last Updated	repo.lastUpdated (friendly date)
Analysis	formatAnalysisStatus() — see analysis.md

Setup (key-value table)

Field	Source
Languages	repo.languages (comma-separated)
Coding Standards	repo.standards (names, comma-separated)
Quality Gate	repo.gatePolicyName
Problems	repo.problems (yellow if present, green "None" otherwise)

Metrics (key-value table)

Colored by goals thresholds from RepositoryQualitySettings:

Field	Notes
Issues	Count + Issues/kLoC ratio
Coverage	% (min threshold)
Complex Files	% (max threshold)
Duplication	% (max threshold)

Open Pull Requests (columnar table)

Columns: #, Title (truncated 50), Branch (truncated 40), ✓, Issues, Coverage, Complexity, Duplication, Updated.

Metric columns colored by resultReasons gate pass/fail.

Shows pagination warning if more PRs exist.

Issues Overview (three count tables)

By category, severity level, and language — sorted descending by count.

Actions

In all cases, show a success message on completion or an error message with details on failure.

Add repository (--add)

• API: addRepository
• Shows an additional note that the repository will be available after a few minutes (initial clone + analysis).

Remove repository (--remove)

• API: deleteRepository

Follow repository (--follow)

• API: followAddedRepository

Unfollow repository (--unfollow)

• API: unfollowRepository

Reanalyze (--reanalyze)

• Fetches the HEAD commit SHA via listRepositoryCommits(limit=1)
• API: reanalyzeCommitById
• Shows success/failure message

Tests

File: src/commands/repository.test.ts — 16 tests.