Getting Started

This page shows how to install compat-finder and start using it from the library or CLI as quickly as possible.

Requirements

• Library usage: any ESM-compatible runtime
• CLI usage: Node.js ^22 || >=24

Installation

Install compat-finder with your preferred package manager:

npm

npm install compat-finder

pnpm

pnpm add compat-finder

yarn

yarn add compat-finder

bun

bun add compat-finder

deno

deno add npm:compat-finder

vlt

vlt install compat-finder

vp

vp add compat-finder

Then import it and create a session:

import { createCompatibilitySession } from "compat-finder";

const session = createCompatibilitySession(["A", "B"]);

If you just want to try the CLI, you can run it without installing it first:

npm

npx compat-finder --help

pnpm

pnpm dlx compat-finder --help

yarn

yarn dlx compat-finder --help

bun

bunx compat-finder --help

deno

deno run npm:compat-finder --help

vlt

vlx compat-finder --help

vp

vp exec compat-finder

Library Example

The example below shows the smallest useful compat-finder session:

import { createCompatibilitySession } from "compat-finder";

const session = createCompatibilitySession(["A", "B", "C", "D"]);

let step = session.current();

while (step.status === "testing") {
  const result = askUser(step.targets);

  if (result === "undo") {
    step = session.undo();
    continue;
  }

  step = session.answer(result === "issue");
}

console.log("Result:", step.targets);

function askUser(targets: readonly string[]): "issue" | "pass" | "undo" {
  console.log("Targets to test:", targets);
  return "issue";
}

CLI Example

If you would rather start in the terminal, try these commands first.

Run a full interactive check:

npm

npx compat-finder interactive --count 4

pnpm

pnpm dlx compat-finder interactive --count 4

yarn

yarn dlx compat-finder interactive --count 4

bun

bunx compat-finder interactive --count 4

deno

deno run npm:compat-finder interactive --count 4

vlt

vlx compat-finder interactive --count 4

vp

vp exec compat-finder interactive --count 4

Calculate the next targets to test from existing answers:

npm

npx compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

pnpm

pnpm dlx compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

yarn

yarn dlx compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

bun

bunx compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

deno

deno run npm:compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

vlt

vlx compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

vp

vp exec compat-finder next -c 3 -n "Alpha,Beta,Gamma" -a "y,n"

Expected JSON output:

{
  "status": "testing",
  "targetCount": 3,
  "targets": ["Beta"]
}

Next

• Learn how to Work with AI
• Try compat-finder Online
• View CLI for the full command list and options
• View API Reference