Once your CLI Installation is successful, there are additional commands and customizations possible.
📘Usage
Running
codecovcli --help
will output the available commands along with the different general options that can be used with them.
Usage: codecovcli [OPTIONS] COMMAND [ARGS]...
Codecov-cli supports inputs. These inputs, along with their descriptions and usage contexts, are listed in the table below:
Input Description Usage--auto-load-params-from
The CI/CD platform Optional --codecov-yml-path
The path for your codecov.yml Optional --enterprise-url
Change the upload host (Enterprise use) Optional --version
Codecov-cli's version Optional --verbose
or -v
Run the cli with verbose logging Optional Command Description create-commit
Saves the commit's metadata in codecov, it's only necessary to run this once per commit create-report
Creates an empty report in codecov with initial data e.g. report name, report's commit do-upload
Searches for and uploads coverage data to codecov pr-base-picking
Tells codecov that you want to explicitly define a base for your PR
Note: Every command has its own different options that will be mentioned later in this doc. Codecov will try to load these options from your CI environment variables, if not, it will try to load them from git, if not found, you may need to add them manually.
codecovcli create-commit [Options]
codecovcli create-report [OPTIONS]
codecovcli do-upload [OPTIONS]
xcode
, gcov
, pycoverage
. The default behavior runs them all. noop
disables all Optional -Z, --fail-on-error Exit with non-zero code in case of error uploading. Optional -d, --dry-run Don't upload files to Codecov Optional --legacy, --use-legacy-uploader Use the legacy upload endpoint Optional --git-service Git Provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server Required --disable-file-fixes Disable file fixes to ignore common lines from coverage (e.g. blank lines or empty brackets) Optional --help Shows usage, and command options
codecovcli pr-base-picking [OPTIONS]
codecovcli send-notifications
Codecov doesn't intrinsically know when you have finished making uploads for a commit, this allows you to tell us. When this is enabled we'll send one PR comment and you'll be notified just one time that we've posted a comment (if you have notifications for PR comments turned on in your code host of choice).
This particular command also needs a corresponding Codecov yaml setting:
codecov:
notify:
manual trigger: true
Used if the changes made don't need testing, but PRs require a passing Codecov status to be merged.
This command will scan the files in the commit and send passing status checks configured if all the changed files
are ignored by Codecov (including README and configuration files)
Usage: codecovcli empty-upload [OPTIONS]
Updated 4 months ago
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4