> ## Documentation Index
> Fetch the complete documentation index at: https://docs.binarly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Learn how to automate firmware security scanning in your CI/CD pipeline.

This guide demonstrates how to integrate the Binarly Transparency Platform into your CI/CD pipeline.

## Prerequisites

Before integrating, ensure you have:

* **API Client credentials** (`BINARLY_CLIENT_ID` and `BINARLY_CLIENT_SECRET`) – See [Setup API Client](/api-reference/authentication/create-api-client)
  * *SaaS customers*: Contact [support@binarly.io](mailto:support@binarly.io) to request credentials
  * *On-Prem customers*: Create credentials via Keycloak Admin Console
* **Product ID** (`BINARLY_PRODUCT_ID`) for your firmware project
* **Binary file** to scan

## Workflow Overview

All CI/CD integrations follow the same four-step workflow:

```mermaid theme={null}
graph LR
    A[Authenticate] --> B[Upload]
    B --> C[Poll]
    C --> D[Verify]
```

1. **Authenticate**: Obtain an access token using Client Credentials
2. **Upload**: Submit the binary image for analysis
3. **Poll**: Check the scan status until completion
4. **Verify**: Pass/fail the build based on findings – [See Details](/api-reference/use-cases/cicd/verify-results)

## Choose Your Platform

<CardGroup cols={2}>
  <Card title="Bash Script" icon="terminal" href="/api-reference/use-cases/cicd/bash">
    Universal script using curl and jq
  </Card>

  <Card title="GitHub Actions" icon="github" href="/api-reference/use-cases/cicd/github-actions">
    Native GitHub workflow integration
  </Card>

  <Card title="Jenkins" icon="gears" href="/api-reference/use-cases/cicd/jenkins">
    Jenkinsfile pipeline example
  </Card>

  <Card title="GitLab CI" icon="gitlab" href="/api-reference/use-cases/cicd/gitlab-ci">
    .gitlab-ci.yml configuration
  </Card>

  <Card title="Verify Results" icon="check-double" href="/api-reference/use-cases/cicd/verify-results">
    Pass/fail builds with comparison statistics
  </Card>
</CardGroup>

## Next Steps

* **Set up your Client**: See [Setup API Client](/api-reference/authentication/create-api-client)
* **Best Practices**: See [Best Practices](/api-reference/best-practices) for retry strategies