# codacy component functions Requires FluentCI v0.17.3 or newer. The compiler derives native WIT signatures and embedded help from these typed PureScript functions. Optional arguments may be omitted. ## `run` Execute arbitrary literal CLI arguments. | Argument | Type | Required | Description | | --- | --- | --- | --- | | `project` | `string` | no | Working directory containing the source checkout; defaults to the current directory. Default: ".". | | `run-dir` | `string` | yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. | | `executable` | `string` | no | Native CLI executable name or absolute path; defaults to this operation’s tool. | | `timeout-ms` | `integer` | no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. | | `artifacts` | `array` | no | Output artifacts to collect as NAME=PATH entries; names must be unique. | | `arguments` | `array` | yes | Literal native CLI argument tokens, passed without shell expansion. | Returns `Contract.ExecutionResult`. ## `help` help | Argument | Type | Required | Description | | --- | --- | --- | --- | | `project` | `string` | no | Working directory containing the source checkout; defaults to the current directory. Default: ".". | | `run-dir` | `string` | yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. | | `executable` | `string` | no | Native CLI executable name or absolute path; defaults to this operation’s tool. | | `timeout-ms` | `integer` | no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. | | `artifacts` | `array` | no | Output artifacts to collect as NAME=PATH entries; names must be unique. | Returns `Contract.ExecutionResult`. ## `upload` Upload an existing coverage report to Codacy. | Argument | Type | Required | Description | | --- | --- | --- | --- | | `project` | `string` | no | Working directory containing the source checkout; defaults to the current directory. Default: ".". | | `run-dir` | `string` | yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. | | `executable` | `string` | no | Native CLI executable name or absolute path; defaults to this operation’s tool. | | `timeout-ms` | `integer` | no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. | | `artifacts` | `array` | no | Output artifacts to collect as NAME=PATH entries; names must be unique. | | `coverage-file` | `string` | yes | Coverage File supplied to the codacy upload operation. | | `language` | `string` | no | Language supplied to the codacy upload operation. | | `commit-uuid` | `string` | no | Commit Uuid supplied to the codacy upload operation. | | `prefix` | `string` | no | Prefix supplied to the codacy upload operation. | | `force-coverage-parser` | `string` | no | Force Coverage Parser supplied to the codacy upload operation. Allowed values: opencover, clover, lcov, phpunit, jacoco, dotcover, cobertura, go. | Returns `Contract.ExecutionResult`.