> ## Documentation Index
> Fetch the complete documentation index at: https://docs.raigal.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the Raigal CLI via npm, npx, pnpm, yarn, or bun on macOS, Linux, and Windows.

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

## System requirements

* **Node.js**: version 20.12 or higher (Node 22 LTS recommended)
* **Package manager**: `npm`, `pnpm`, `yarn`, or `bun`
* **Operating systems**: macOS, Linux, or Windows (PowerShell and cmd.exe)

## Run directly with `npx`

Run a scan immediately without installing packages:

```bash theme={null}
npx --yes @methiu/raigal@latest scan .
```

Run the interactive setup wizard:

```bash theme={null}
npx --yes @methiu/raigal@latest init
```

## Global installation

Install Raigal globally to make the `raigal` command available anywhere:

**npm**

```bash theme={null}
npm install -g @methiu/raigal
```

**pnpm**

```bash theme={null}
pnpm add -g @methiu/raigal
```

**yarn**

```bash theme={null}
yarn global add @methiu/raigal
```

**bun**

```bash theme={null}
bun add -g @methiu/raigal
```

Verify the CLI version:

```bash theme={null}
raigal --version
```

## Project dependency

Add Raigal as a development dependency in your repository:

**npm**

```bash theme={null}
npm install -D @methiu/raigal
```

**pnpm**

```bash theme={null}
pnpm add -D @methiu/raigal
```

**yarn**

```bash theme={null}
yarn add -D @methiu/raigal
```

**bun**

```bash theme={null}
bun add -d @methiu/raigal
```

Add convenient scripts to your `package.json`:

```json theme={null}
{
  "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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.