boll
Get started
Documentation
GitHub
Get started
Documentation
GitHub
  • Documentation
  • Configuration
  • Running boll
  • Disabling rules
  • Rules
  • Advanced configuration: Custom rules

Running boll

CLI usage

Use npx (or your package's preferred launcher) to run boll in the root of each package.

npx boll run

Library usage

In order to integrate with other schedulers and build tools, it is easy to launch boll from within an already running node process.

First, import the configuration registry and bootstrap so that other rules can be run successfully.

import { ConfigRegistryInstance } from "@boll/cli/dist/lib/config-registry";

ConfigRegistryInstance.register(baseConfig);

Next, call runBoll.

import { runBoll } from "@boll/cli/dist/main";

const result = await runBoll();
if (!result) {
  throw new Error("boll (repo-wide linter) failed; please inspect previous output.");
}

See details on ConfigRegistryInstance.register and runBoll.

Last Updated: 12/10/25, 8:50 PM
Prev
Configuration
Next
Disabling rules