Skip to main content

Installation

For project checks, install rev-dep as a development dependency.

pnpm add -D rev-dep
npm install -D rev-dep
yarn add -D rev-dep

Global installation is fine for one-off CLI use, but local installation is the better default for teams and CI.

Initialize Configuration

Create a configuration file to start defining your and rules:

npx rev-dep config init

More about config file structure.

Exec the configuration file:

npx rev-dep config run

Run a Exploratory Toolkit Check

If you just want to look around, use exploratory toolkit. For example detect circular imports in your project:

npx rev-dep circular