---
name: "istanbul"
section: "1"
platform: "linux"
package: "node-istanbul"
version: "0.4.5+repack10+~cs98.25.59-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/istanbul"
---

# istanbul(1)

a JS code coverage tool written in JS

## NAME

istanbul - a JS code coverage tool written in JS

## SYNOPSIS

**istanbul** *help config \| \<command\>*

## DESCRIPTION

Available commands are:

- check-coverage

  -

  checks overall/per-file coverage against thresholds from coverage JSON files. Exits 1 if thresholds are not met, 0 otherwise

- cover

  -

  transparently adds coverage information to a node command. Saves coverage.json and reports at the end of execution

- help

  -

  shows help

- instrument

  -

  instruments a file or a directory tree and writes the instrumented code to the desired output location

- report

  -

  writes reports for coverage JSON objects produced in a previous run

- test

  -

  cover a node command only when npm\_config\_coverage is set. Use in an \`npm test\` script for conditional coverage

Command names can be abbreviated as long as the abbreviation is unambiguous.

## SEE ALSO

[tap(1)](/tap/1.md)