Getting started

Install ngcompass.

ngcompass is a command-line tool. Install it locally in each Angular project so the CLI version, config file, and CI runs all use the same package. This avoids hard-to-debug mismatches between a global CLI and the project's config model.

Requirements

Node.js: ^20.19.0 or >=22.12.0
Angular: v15 or later
Package manager: npm, pnpm, or yarn
TypeScript: bundled with Angular

Recommended setup

For Angular CLI projects, use ng add. It installs ngcompass in the project and initializes ngcompass.config.ts in one step.

bash

01ng add ngcompass

If your workspace cannot use Angular schematics, install the package locally and run init manually:

bash

01npm i -D ngcompass
02npx ngcompass init

Or with pnpm:

bash

01pnpm add -D ngcompass
02pnpm ngcompass init

Or with yarn:

bash

01yarn add -D ngcompass
02yarn ngcompass init

Package page: ngcompass on npm.

Verify

bash

01npx ngcompass --version
02# or
03pnpm ngcompass --version

You should see 0.2.2-beta or later.

Global installs

Prefer project-local installation. Use a global install only for throwaway checks outside a committed Angular workspace, because a global CLI can drift away from the config schema in the project.

bash

01npm install -g ngcompass

Next steps

Quick start

Initialize a config and run your first analysis.

Configuration

Learn about ngcompass.config.ts and all available options.