---
title: CircleCI
slug: docs/circleci
description: Learn how to effectively scan CircleCI build logs for credentials. It offers a local configuration example in YAML format and highlights the supported capabilities, including scanning build logs and base64 encoded data.
icon: {"faIcon":"fa-solid fa-circle-notch"}
docTags: 
createdAt: 2024-04-17T16:33:26.498Z
---

# CircleCI

:::BlockQuote
**Edition:** Enterprise + Open Source
:::

The CircleCI integration scans CircleCI build logs for credentials and other sensitive data. To scan the contents of your CI pipeline, see [Scanning in CI](docId:8DqNVC9XDDXKjkD3dY8xU) instead.

## Configuration

The CircleCI integration is configured via a local configuration file. Web configuration in TruffleHog is not available for this source.

### Local configuration

:::BlockQuote
sources:
  \- connection:
      "@type": type.googleapis.com/sources.CircleCI
      token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    name: CircleCI logs
    scanPeriod: 12h
    type: SOURCE\_TYPE\_CIRCLECI
    verify: true
:::

## Configuration options

| Field | Type   | Required | Description                  |
| ----- | ------ | -------- | ---------------------------- |
| token | string | Yes      | A CircleCI API access token. |

## Capabilities

| Feature                  | Supported |
| ------------------------ | --------- |
| Scan build logs          | ✅         |
| Scan base64-encoded data | ✅         |
| Auto-resume              | ✅         |

## Notes

- Build artifacts are not scanned. The CircleCI integration covers build logs only.
- Include and exclude filters are not supported. The scanner covers all build logs the token has access to.