Skip to content
Go to platform

Quickstart

Get a software bill of materials (SBOM) and a list of known vulnerabilities for the software your repository builds. You connect GitHub, move one build job to CRACI, and review the results in CRACI.

To be certain what your shipped software contains, it must be built in CI. That is why CRACI runs your build instead of scanning your repository afterward.

Move the job that builds the software you ship, such as a binary, a zip archive, or a container image.

  • A CRACI account.
  • Owner access to the GitHub organization that owns your repository, or help from an owner. CRACI installs a GitHub App in that organization.
  • A private or internal repository. Public repositories need a change in your GitHub organization’s runner settings first; see Public repositories.
  • A GitHub Actions job that installs your project’s dependencies and builds it. If you do not have one yet, add a build job first.

After you sign in to CRACI for the first time, choose what brings you to CRACI and continue to Connect GitHub:

  1. Sign in to GitHub in the same browser. GitHub can show an error if you are signed out while CRACI creates its GitHub App.
  2. Enter the name of the GitHub organization that owns your repository and click Connect GitHub.
  3. On GitHub, finish the installation. Give CRACI access to all repositories or only to the repository you want to build.
  4. Back in CRACI, check that your repository is listed under Repositories CRACI can see, and click Continue.

If you skipped this during sign-up, go to Settings → Builds, enter the organization name, and click Install GitHub App. See Connect your GitHub organization for details.

Open your workflow file under .github/workflows/. In the job that installs your dependencies and builds your software, change runs-on to craci:

jobs:
build:
runs-on: ubuntu-latest
runs-on: craci
steps:

Leave the job’s steps as they are. You do not need to add a separate SBOM or vulnerability scanning step.

Commit the change and push it to your repository’s default branch. The job runs on CRACI instead of GitHub’s runners. CRACI’s default runner image matches GitHub’s Ubuntu 24.04 runner image, so tools your job already relies on are available.

When the run finishes, CRACI shows Your first run with the number of packages it found and the known vulnerabilities in them. From there:

  • Click Download SBOM to open your project’s dependencies and download the SBOM.
  • Click Vulnerabilities to see the known vulnerabilities found in that run.

To return to these results later, open your project in CRACI. Dependencies shows the dependencies from the latest builds on your default branch. Runs lists every run; open one and click View vulnerabilities.

The job stays queued. GitHub has not sent the job to CRACI. Check that the GitHub App has access to the repository; see Updating permissions. If the repository is public, GitHub blocks self-hosted runners such as CRACI’s by default; see Public repositories.

The job fails on CRACI but passes on GitHub. CRACI runs Linux jobs only. Keep macOS and Windows jobs on their current runners. If the job log shows certificate or connection errors, see Debug network problems in jobs.

Few or no packages appear. Check that the job installs your dependencies rather than only checking out your code. If the job restores dependencies from a cache, see Understand job and cache SBOM completeness.

CRACI reports incomplete package evidence. CRACI could not confirm that the SBOM covers everything the job may have downloaded. See Understand job and cache SBOM completeness for what affects this.