Quickstart - Darkplane

This guide walks you through installing Darkplane and getting your first readiness score.

Prerequisites

GitHub organization: You need admin access to install the Darkplane GitHub App.
A repository with CI: Darkplane reads check runs, so at least one workflow should run on pull requests.

Install the GitHub App

Go to the Darkplane app page and install it on your organization. Grant access to the repositories you want Darkplane to evaluate.

The app requires the contents:read permission. Without it, ingestion silently writes nothing.

Open the Darkplane app and sign in with your GitHub account. Repositories from your installation appear automatically.

Open a pull request

Darkplane evaluates every new pull request in connected repositories. Open one and watch the evaluation appear as a check run.

Review your readiness score

The repository overview shows your current level and what is blocking the next one.