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

# lightspin-tech/lightspin

Scan your IaC templates with the LightSpin IaC platform.


## Commands

### scan

Run LightSpin IaC scan


| Parameter | Type | Default | Description |
|---|---|---|---|
| `friendly-name` | string | LightSpin-IaC-scan | A name for the scan to be performed |
| `path-to-scan` | string | . | The path to IaC files in this repository |
| `tenant-id` | env_var_name | LIGHTSPIN_TENANT_ID | Environment Variable ID that holds the LightSpin tenant ID |
| `token` | env_var_name | LIGHTSPIN_API_TOKEN | Environment Variable ID that holds the LightSpin API Token |

## Jobs

### lightspin_scan

Run the LightSpin IaC scan


| Parameter | Type | Default | Description |
|---|---|---|---|
| `friendly-name` | string | LightSpin-IaC-scan | A name for the scan to be performed |
| `path-to-scan` | string | . | The path to IaC files in this repository |
| `tenant-id` | env_var_name | LIGHTSPIN_TENANT_ID | Environment Variable ID that holds the LightSpin tenant ID |
| `token` | env_var_name | LIGHTSPIN_API_TOKEN | Environment Variable ID that holds the LightSpin API Token |

## Examples

### lightspin_scan

Run LightSpin IaC scan on your IaC files


```yaml
version: '2.1'
orbs:
  lightspin-orb: lightspin-tech/lightspin@x.y.z
workflows:
  invoke-iac:
    jobs:
      - lightspin-orb/lightspin_scan:
          friendly-name: $CIRCLE_BUILD_NUM'_circle_CI'
          path-to-scan: terraform
          tenant-id: LS_TENANT
          token: LS_TOKEN
```