flakiness

Flakiness CLI

A command-line interface for interacting with flakiness.io service.

Installation

npm install -g flakiness

Or run directly with npx:

npx flakiness <command>

Commands

Authentication

# Login to flakiness.io (opens browser for authentication)
flakiness login

# Show current logged-in user
flakiness whoami

# Logout from current session
flakiness logout

Project Linking

Link your local repository to a flakiness.io project to show local reports in context of their cloud history.

# Link using project URL
flakiness link https://flakiness.io/my-org/my-project

# Or using shorthand
flakiness link flakiness.io/my-org/my-project

# Check link status
flakiness status

# Unlink repository
flakiness unlink

Upload Reports

Upload Flakiness report files to the service:

# Upload using linked project
flakiness upload ./flakiness-report/report.json

# Upload with explicit access token
flakiness upload ./report.json --access-token <token>

# Upload with custom endpoint
flakiness upload ./report.json --endpoint https://custom.flakiness.io

Options:

• -t, --access-token <token> — Read-write access token (env: FLAKINESS_ACCESS_TOKEN)
• -e, --endpoint <url> — Service endpoint (env: FLAKINESS_ENDPOINT)
• --attachments-dir <dir> — Directory containing attachments (defaults to report directory)

Download Reports

Download reports from a linked project:

# Download all reports since a date
flakiness download --since 2024-01-01

# Download a specific run
flakiness download --run-id 123

# Download with parallel jobs
flakiness download --since 2024-01-01 -j 4

View Reports

Open a local Flakiness report in the browser:

# Show report from default directory (flakiness-report)
flakiness show

# Show report from specific path
flakiness show ./path/to/report

Convert JUnit XML

Convert JUnit XML reports to Flakiness format:

# Convert a single XML file
flakiness convert-junit ./junit-report.xml

# Convert all XML files in a directory
flakiness convert-junit ./test-results/

# With options
flakiness convert-junit ./junit.xml \
  --env-name "CI" \
  --commit-id abc123 \
  --output-dir ./flakiness-report

Options:

• --env-name <name> — Environment name for the report (default: junit)
• --commit-id <id> — Git commit ID (auto-detected if not provided)
• --output-dir <dir> — Output directory (default: flakiness-report)

Environment Variables

Variable	Description
FLAKINESS_ACCESS_TOKEN	Read-write access token for authentication
FLAKINESS_ENDPOINT	Custom service endpoint URL

License

Fair Source 100