LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

codecov

Code coverage report uploader for the Codecov service

TLDR

Upload coverage report with token
$ codecovcli upload-process -t [token]
copy
Upload a specific coverage file
$ codecovcli do-upload -t [token] -f [coverage.xml]
copy
Upload with coverage flags
$ codecovcli do-upload -t [token] -F [unittests]
copy
Upload for a specific commit SHA
$ codecovcli do-upload -t [token] -C [commit_sha]
copy
Upload with verbose output
$ codecovcli -v upload-process -t [token]
copy
Create commit and upload in one step
$ codecovcli upload-process -t [token] -r [owner/repo] --git-service [github]
copy

SYNOPSIS

codecovcli [global-options] command [options]

DESCRIPTION

codecovcli is the command-line interface for the Codecov code coverage service. It uploads coverage reports generated by testing frameworks and provides insights through dashboards and pull request comments.The CLI automatically detects CI environments (GitHub Actions, GitLab CI, Jenkins, etc.) and extracts commit, branch, and build information. It searches for coverage files in common formats (lcov, cobertura, jacoco, etc.) and uploads them.Key commands include upload-process (a wrapper that creates a commit, creates a report, and uploads in one step), do-upload (upload only), create-commit, create-report, and send-notifications.

PARAMETERS

-t TOKEN

Repository upload token. Can also be set via CODECOV_TOKEN environment variable.
-f, --file FILE
Specific coverage report file to upload.
-F, --flag NAME
Flag to group coverage (e.g., unittests, integration). May be specified multiple times.
-C, --sha SHA
Commit SHA to associate with the upload.
-B, --branch NAME
Branch name for the upload.
-r, --slug OWNER/REPO
Repository slug (owner/repo).
-n, --name NAME
Custom upload name.
--git-service SERVICE
Git hosting service (github, gitlab, bitbucket, githubenterprise, gitlabenterprise, bitbucket_server).
-v, --verbose
Enable verbose logging.
-Z, --fail-on-error
Exit with non-zero status on upload failure.
-s, --dir DIR
Search for coverage files in a specific directory.
--enterprise-url URL
Upload host for Codecov Self-Hosted instances.
--disable-search
Disable automatic coverage file discovery.

CAVEATS

Requires a Codecov account and repository token (or tokenless upload for public repos). Coverage format must be supported (lcov, cobertura, clover, etc.). Private repositories require authentication. The older Bash uploader script has been deprecated in favor of this CLI.

HISTORY

Codecov was founded in 2014 by Steve Peak and Eli Hooten to provide code coverage analytics for development teams. In 2022, Codecov was acquired by Sentry. The original Bash uploader was replaced by the Python-based codecovcli for improved security and functionality.

SEE ALSO

lcov(1), gcov(1)

Copied to clipboard
Kai