Skip to main content

Circle CI


GitGuardian CI/CD integration with Circle CI is performed through our CLI application ggshield. ggshield is a wrapper around the GitGuardian API for secrets detection, an API key is required for authentication.

Circle CI is supported in ggshield through ggshield-orb.


Circle CI output


Service accounts are recommended to run this integration.

Please note that service accounts are only available for workspaces under our Business plan, and their administration is restricted to Managers. If your workspace is under the Free plan, you can still use a personal access token to run this integration.

  1. Create a service account from the API section of your GitGuardian workspace (or a personal access token if you are on the Free plan).
  2. Add this API key to the GITGUARDIAN_API_KEY environment variable in your project settings.
  3. In order to add ggshield to your pipelines configure your .circleci/config.yml add the ggshield orb:
orbs:  ggshield: gitguardian/ggshield
workflows:  main:    jobs:      - ggshield/scan:          name: ggshield-scan # best practice is to name each orb job          base_revision: << pipeline.git.base_revision >>          revision: <<pipeline.git.revision>>