> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# accurics/accurics-cli

Scan common Infrastructure-as-Code (IaC) templates like Terraform, Kubernetes YAML, Dockerfile, and OpenFaaS YAML to identify and remediate vulnerabilities before provisioning your cloud-native infrastructure. Maintain app and infrastructure security throughout the build and deployment process.


## Commands

### scan

Run Accurics scan


| Parameter | Type | Default | Description |
|---|---|---|---|
| `app-id` | env_var_name | ACCURICS_API_KEY | Accurics CLI Application Token ID |
| `debug-mode` | boolean | false |  |
| `directories` | string | . | A list of directories to scan within this repository separated by a space. (default=current directory) |
| `env-id` | env_var_name | ACCURICS_ENV_ID | Environment ID for Accurics to scan |
| `fail-on-all-errors` | boolean | true | Allows Accurics to fail the build when any errors are encountered (default=true) |
| `fail-on-violations` | boolean | true | Allows Accurics to fail the build when violations are found (default=true) |
| `plan-args` | string |  | Terraform plan arguments |
| `repo-name` | string | __empty__ | Repository Location |
| `terraform-version` | string | latest | The Terraform version used to process the files in this repository (ex: 0.12.26). (default=latest) |
| `url` | string | https://app.accurics.com | Accurics Application URL |

## Jobs

### accurics_scan

Run Accurics scan


| Parameter | Type | Default | Description |
|---|---|---|---|
| `app-id` | env_var_name | ACCURICS_API_KEY | Accurics CLI Application Token ID |
| `debug-mode` | boolean | false |  |
| `directories` | string | . | A list of directories to scan within this repository separated by a space. (default=current directory) |
| `env-id` | env_var_name | ACCURICS_ENV_ID | Environment ID for Accurics to scan |
| `fail-on-all-errors` | boolean | true | Allows Accurics to fail the build when any errors are encountered (default=true) |
| `fail-on-violations` | boolean | true | Allows Accurics to fail the build when violations are found (default=true) |
| `plan-args` | string |  | Terraform plan arguments |
| `repo-name` | string | __empty__ | Repository Location |
| `terraform-version` | string | latest | The Terraform version used to process the files in this repository (ex: 0.12.26). (default=latest) |
| `url` | string | https://app.accurics.com | Accurics Application URL |

## Executors

### default

## Examples

### scan

The Accurics CircleCI Orb scans IaC (Infrastructure as Code) to help identify vulnerabilities prior to
cloud deployment.


```yaml
orbs:
  accurics: accurics/accurics-cli@x.y.z
version: 2.1
workflows:
  deploy:
    jobs:
      - accurics/accurics_scan:
          directories: ./your-root
          fail-on-all-errors: true
          fail-on-violations: false
          plan-args: '-var your-var=your-value'
          terraform-version: latest
```