Command Line Interface

type-coverage [options] [-- file1.ts file2.ts ...]

# Basic coverage check
type-coverage

# Check specific project
type-coverage -p ./tsconfig.json

# Check only specific files
type-coverage -- src/main.ts src/utils.ts

-p, --project <string>     Path to tsconfig.json directory or file

# Use specific tsconfig.json
type-coverage -p ./src/tsconfig.json

# Use tsconfig.json in specific directory
type-coverage -p ./backend

--at-least <number>        Fail if coverage rate < this value
--is <number>              Fail if coverage rate !== this exact value

# Require at least 90% coverage
type-coverage --at-least 90

# Require exactly 95% coverage
type-coverage --is 95

--detail                   Show detailed results with file locations
--no-detail-when-failed    Hide details when coverage check fails
--show-relative-path       Show relative paths instead of absolute paths
--json-output              Output results as JSON format

# Show detailed results
type-coverage --detail --at-least 80

# JSON output for CI integration
type-coverage --json-output --at-least 90

--strict                   Enable strict mode (includes all strict options)
--ignore-catch             Ignore catch clause variables
--ignore-nested            Ignore any in type arguments (Promise<any>)
--ignore-as-assertion      Ignore as assertions (foo as string)
--ignore-type-assertion    Ignore type assertions (<string>foo)
--ignore-non-null-assertion Ignore non-null assertions (foo!)
--ignore-object            Don't count Object type as any
--ignore-empty-type        Don't count empty type {} as any
--ignore-unread            Allow writes to variables with implicit any types

# Enable all strict checks
type-coverage --strict --at-least 95

# Custom strict configuration
type-coverage --ignore-catch --ignore-nested --at-least 90

--ignore-files <patterns>  Ignore files matching glob patterns (can be repeated)
--not-only-in-cwd         Include results outside current working directory
-- <files>                Only check specified files

# Ignore test files and generated code
type-coverage --ignore-files "**/*.test.ts" --ignore-files "**/generated/**"

# Check only specific files (useful with lint-staged)
type-coverage -- src/main.ts src/utils.ts

# Include files outside current directory
type-coverage --not-only-in-cwd

--cache                    Enable result caching
--cache-directory <path>   Set custom cache directory location

# Enable caching (uses .type-coverage directory)
type-coverage --cache --at-least 90

# Use custom cache directory
type-coverage --cache --cache-directory ./build/.type-coverage

--update                   Update typeCoverage section in package.json
--update-if-higher         Update only if new coverage is higher

# Update package.json with current coverage
type-coverage --update

# Update only if coverage improved
type-coverage --update-if-higher

--history-file <filename>  Save coverage history to specified file

# Track coverage over time
type-coverage --history-file coverage-history.json --at-least 85

--report-semantic-error    Report TypeScript semantic errors
--report-unused-ignore     Report unused type-coverage ignore directives
--debug                    Show debug information during analysis

# Include semantic errors in analysis
type-coverage --report-semantic-error --detail

# Show debug information
type-coverage --debug --detail

-h, --help                 Show help information
-v, --version              Show version number

# Show help
type-coverage --help

# Show version
type-coverage --version

{
  "typeCoverage": {
    "atLeast": 90,
    "detail": true,
    "strict": true,
    "ignoreCatch": true,
    "ignoreFiles": ["**/*.test.ts", "**/generated/**"],
    "ignoreUnread": false,
    "showRelativePath": true,
    "cache": true
  }
}

0    Success - coverage meets requirements
1    Failure - coverage below threshold or errors occurred

# GitHub Actions / Jenkins
type-coverage --at-least 90 --no-detail-when-failed

# Generate coverage report for artifacts
type-coverage --json-output --detail > coverage-report.json

# With lint-staged - check only staged files
type-coverage -- $(git diff --cached --name-only --diff-filter=AM | grep '\\.ts$')

# Start with low threshold and gradually increase
type-coverage --at-least 70 --update-if-higher --history-file coverage-history.json