Aikido CLI: Release Gating

The Aikido Security CI client allows you to integrate Aikido Security scans into custom CI pipelines such as Jenkins or CircleCI. It helps ensure that security scans are part of your build process.

Use Cases

Release Gating: Block a new release or build based on a commit.

Step-by-Step Guide

Step 1: Install the @aikidosec/ci-api-client package globally.

# For npm users
$ npm install -g @aikidosec/ci-api-client

# For yarn users
$ yarn global add @aikidosec/ci-api-client

Step 2: Configure your Aikido API key

Obtain the API key from the Continuous Integration Settings page.
Set the API key globally:

$ aikido-api-client apikey <your-api-key-here>

Step 3: Run a release or pull request scan
The scan-release command is used for release gating.

$ aikido-api-client scan-release <repository_id or repository_name> <commit_id>

Options:

Flags for this command are documented on the @aikidosec/ci-api-client package. Print them locally with:

aikido-api-client help scan-release