Skip to main content
fallow coverage currently exposes a single workflow command: setup.
fallow coverage setup
This command is the guided first-run path for paid production coverage. It is intentionally resumable: run it once to bootstrap the workflow, follow the generated recipe, then run it again after traffic has been captured.

setup

The setup flow performs four steps:
  1. check license state
  2. locate or install fallow-cov
  3. write a framework-specific collection recipe to docs/collect-coverage.md
  4. if coverage already exists, hand off directly to fallow health --production-coverage <path>
fallow coverage setup
fallow coverage setup --non-interactive
fallow coverage setup --yes

Flags

FlagDescription
-y, --yesAccept prompts automatically. Useful for local setup when you want fallow to continue without confirmation prompts.
--non-interactivePrint instructions instead of prompting. Useful in CI, remote shells, or agent workflows.

What setup detects automatically

fallow coverage setup inspects package.json, lockfiles, and scripts to tailor the instructions:
DetectionPurpose
FrameworkChooses a recipe for Next.js, NestJS, Nuxt, SvelteKit, Astro, Remix, plain Node services, or a generic fallback.
Package managerUses packageManager, lockfiles, or both to choose install commands for npm, pnpm, yarn, or bun.
Coverage artifactDetects existing coverage/coverage-final.json, .nyc_output/coverage-final.json, or JSON-containing V8 directories.
Sidecar binaryResolves FALLOW_COV_BIN, project-local shims, package-manager bin lookups, ~/.fallow/bin/fallow-cov, and PATH.
If the project does not match a built-in framework recipe, fallow still writes a fallback docs/collect-coverage.md with a link to the public coverage docs for manual setup.

Generated recipe

The generated docs/collect-coverage.md recipe typically looks like:
1. Remove any old dump directory: rm -rf ./coverage
2. Build the app
3. Start the app with NODE_V8_COVERAGE=./coverage ...
4. Exercise the routes or jobs you care about
5. Stop the app and run: fallow coverage setup
Framework-aware script selection means fallow prefers existing build, start, or preview scripts when they exist and falls back to common framework commands otherwise.

Typical flow

fallow license activate --trial --email you@company.com
fallow coverage setup

# Follow docs/collect-coverage.md, then:
fallow coverage setup
On the second run, if coverage is present, setup runs the actual analysis for you:
fallow health --production-coverage ./coverage

Sidecar installation

If fallow-cov is missing, setup tells you exactly what it checked and suggests the correct install command for your package manager, for example:
pnpm add -D @fallow-cli/fallow-cov
You can also bypass auto-discovery by setting FALLOW_COV_BIN to an explicit binary path.

See also

License commands

Start a trial, refresh a token, or inspect feature status.

Production coverage

Learn what runtime coverage adds and how it differs from static reachability.