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

# nightfall/nightfall_code_scanner

Scan your application code for sensitive data on every CircleCI build using Nightfall’s Data Loss Prevention (DLP) orb. Classify and protect your credentials, PII, credit card numbers and more to avoid committing sensitive information to your repositories.


## Jobs

### scan

Scan Pull Requests and Commits for sensitive findings. You must set the NIGHTFALL_API_KEY as a CircleCI project environment variable to use this orb. View this orb's source and README for usage instructions.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `base_branch` | string |  | Parent branch to diff against |
| `event_before` | string |  | Commit SHA that triggered the previous workflow |

## Examples

### scan_findings

Scan diff for potential sensitive items.

```yaml
version: '2.1'
orbs:
  nightfall_code_scanner: nightfall/nightfall_code_scanner@3.0.1
workflows:
  build:
    jobs:
      - nightfall_code_scanner/scan:
          event_before: << pipeline.git.base_revision >>
```