codacy/Codacy Analysis CLI

Execute Codacy code analysis using your remote Codacy configuration

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Mar 25, 2026
License
Apache 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: codacy/codacy-analysis-cli-action@562ee3e92b8e92df8b67e0a5ff8aa8e261919c08 # v4.4.7

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
verboseRun with verbose outputno
project-tokenAPI project token to retrieve your remote Codacy configuration for the project being analyzedno
api-tokenAPI account token to retrieve your remote Codacy configuration for the project being analyzedno
codacy-api-base-urlCodacy API URL to retrieve your remote Codacy configurationno
formatOutput file formatno
outputPath to a file to save the analysis resultsno
directoryDirectory to analyzeno
parallelNumber of tools to run in parallelno
max-tool-memoryMaximum allowed memory for running each tool (bytes)no
max-allowed-issuesMaximum number of issues allowed for the analysis to succeedno2147483647
registry-addressAlternative registry address (e.g. artprod.mycompany/)no""
toolOnly run a specific tool or tool category (metrics, issues, duplication). For the full list of tools, see https://docs.codacy.com/repositories-configure/codacy-configuration-file/#which-tools-can-be-configured-and-which-name-should-i-useno
tool-timeoutTool execution timeout (e.g. 15minutes, 1hour)no
uploadUpload analysis results to Codacyno
upload-batch-sizeMaximum number of results in each batch to upload to Codacyno
fail-if-incompleteFail the analysis if any tool fails to runno
allow-networkAllow the tools to access the networkno
force-file-permissionsForce files to be readable by changing the permissions before running the analysisno
gh-code-scanning-compatReduce issue severity by one level for non-security issues, for compatibility with GitHub's code scanning feature. This option only has an effect when used with 'format: sarif'.no
run-docker-toolsRun all dockerized tools supported by Codacy. For the full list of tools, see https://docs.codacy.com/repositories-configure/codacy-configuration-file/#which-tools-can-be-configured-and-which-name-should-i-usenotrue
run-gosecRun Gosecno
run-staticcheckRun Staticcheckno
clang-tidy-outputPath to a file containing the output of Clang-Tidy.no
faux-pas-outputPath to a file containing the output of Faux Pas.no
skip-uncommitted-files-checkSkip validation of uncommitted changesno
skip-container-engine-checkSkip check for the presence of a known container engine before executingno

no outputs