Installation

You can run Raigal directly without installing anything using npx, install it globally, or add it as a project dependency.

System requirements

Run a scan immediately without installing packages:

npx --yes @methiu/raigal@latest scan .

Run the interactive setup wizard:

npx --yes @methiu/raigal@latest init

Install Raigal globally to make the raigal command available anywhere:

npm install -g @methiu/raigal

pnpm add -g @methiu/raigal

yarn global add @methiu/raigal

bun add -g @methiu/raigal

Verify the CLI version:

raigal --version

Add Raigal as a development dependency in your repository:

npm install -D @methiu/raigal

pnpm add -D @methiu/raigal

yarn add -D @methiu/raigal

bun add -d @methiu/raigal

Add convenient scripts to your package.json:

{
  "scripts": {
    "scan": "raigal scan .",
    "gate": "raigal ci .",
    "fix": "raigal fix ."
  }
}

Now anyone on the team can run pnpm scan or npm run gate with consistent settings.