Installation

Prerequisites

Node.js v22 or higher (LTS recommended)
pnpm v8 or higher (recommended) or npm/yarn
Google Generative AI API key (for production embeddings)

Install from npm

Install the core packages from npm:

# Install core packages
pnpm add @flakiness-detective/core @flakiness-detective/adapters

# Or with npm
npm install @flakiness-detective/core @flakiness-detective/adapters

# Or with yarn
yarn add @flakiness-detective/core @flakiness-detective/adapters

Optional: Peer Dependencies

If you're using Firestore or Google AI embeddings, install the peer dependencies:

# For Firestore storage
pnpm add @google-cloud/firestore

# For AI embeddings
pnpm add @google/generative-ai

# Or install both
pnpm add @google-cloud/firestore @google/generative-ai

CLI Installation

Install the CLI globally for command-line usage:

# Install globally
pnpm add -g @flakiness-detective/cli

# Or use npx (no installation needed)
npx @flakiness-detective/cli detect --help

Development Setup

For contributing or development, clone the monorepo:

# Clone the repository
git clone https://github.com/prosdev/flakiness-detective-ts.git
cd flakiness-detective-ts

# Install dependencies
pnpm install

# Build all packages
pnpm build

Verify Installation

Verify that everything is installed correctly:

# Check CLI version
npx @flakiness-detective/cli --version

# Or in Node.js
node -e "console.log(require('@flakiness-detective/core'))"

Next Steps

Now that you have Flakiness Detective installed, check out: