check

Analyze one or more TypeScript files for rule violations.

pulsar check [path] [options]

Arguments:

Options:

The check command walks all .ts and .tsx files recursively, parses each file, builds an IR graph, and runs every enabled rule against it.

If a [database] section is configured, the schema is loaded once and linked to each file's graph, enabling schema-aware rules.

Usage examples:

# Check a specific file
pulsar check src/db/users.ts

# Check an entire directory with JSON output
pulsar check src/ --format json

# Use a custom config file
pulsar check src/ --config ./config/pulsar.toml

Exit codes:

init

Generate a default pulsar.toml config file with all rules enabled.

pulsar init

The generated file includes commented-out sections for ignoring files and connecting a Prisma schema.

explain

Print documentation for a specific rule to the terminal.

pulsar explain no-select-star

Useful when you want a quick reminder of what a rule does without opening the docs site.

Global flags