Installation

1. Sign in to Flakiness.io

   Note about Act on your behalf

   Flakiness.io Github App only asks for read-only permissions.

   There is a long thread disscussing this weird “Act on your behalf” wording here on GitHub’s own commuity forum.

   Sign in

2. Create an Organization

   Organizations are groups of users with shared permissions that contain your projects. Think of them as your company, team, or personal workspace where you manage access control and billing.

   Start with creating a new organization for your team or personal use:

   Create Organization

3. Create a Project

   Projects are containers for your test data, associated with a specific code repository. Each project stores test results, analytics, and history for one repository.

   Within your organization, create a project linked to your GitHub repository. You’ll need to grant access via the Flakiness.io GitHub App, which provides secure, scoped access to your repositories.

4. Configure Your Testing Framework

   Set up your testing framework to send reports to Flakiness.io:

   Playwright
   JUnit
   Pytest

5. Install Flakiness CLI Tool

   Flakiness CLI handles viewing, downloading & uploading Flakiness Reports. It can be installed on any system:

   Mac & Linux

   curl -LsSf https://cli.flakiness.io/install.sh | sh

   Windows

   pwsh -c "irm https://cli.flakiness.io/install.ps1 | iex"

   NPM

   npm i @flakiness/sdk@latest

   Learn more about the Flakiness CLI Tool.