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

# Installation

> Install the mulerouter CLI globally, per-project, or run it on demand

The CLI is published to npm as the [`mulerouter`](https://www.npmjs.com/package/mulerouter)
package. It runs on Node.js 18+ and Bun 1.x.

## Global install

The recommended setup. The `mulerouter` binary becomes available everywhere on your `PATH`.

<CodeGroup>
  ```bash npm theme={null}
  npm install -g mulerouter
  ```

  ```bash bun theme={null}
  bun add -g mulerouter
  ```

  ```bash pnpm theme={null}
  pnpm add -g mulerouter
  ```

  ```bash yarn theme={null}
  yarn global add mulerouter
  ```
</CodeGroup>

Verify the install:

```bash theme={null}
mulerouter --version
mulerouter --help
```

## Run on demand

For one-off use, run the CLI through `npx` or `bunx` without installing anything:

```bash theme={null}
npx mulerouter list
npx mulerouter run openai/gpt-image-2/generation --prompt "A cat in a teacup"

bunx mulerouter list
bunx mulerouter run alibaba/wan2.6-t2i --prompt "A blooming cherry tree"
```

The package will be cached locally; subsequent invocations reuse the same install.

## Per-project install

If you want the version pinned to a single repository (recommended for CI):

```bash theme={null}
npm install --save-dev mulerouter
```

Then call it through your package runner:

```bash theme={null}
npx mulerouter list
# or, from a npm script:
# "scripts": { "gen": "mulerouter run alibaba/wan2.6-t2v --prompt \"$PROMPT\"" }
```

## Upgrading

Re-run the install command. The CLI follows semantic versioning; check the
[CHANGELOG](https://github.com/openmule/mulerouter-cli/blob/main/CHANGELOG.md)
before upgrading across major versions.

```bash theme={null}
npm install -g mulerouter@latest
```

## Uninstall

```bash theme={null}
npm uninstall -g mulerouter
# or
bun remove -g mulerouter
```

## Next step

Head to [Configuration](/docs/cli/configuration) to set your API key and pick a site.