MuleRouter Documentation - AI API Gateway & Routing Platform

The CLI is published to npm as the 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.

npm install -g mulerouter

bun add -g mulerouter

pnpm add -g mulerouter

yarn global add mulerouter

Verify the install:

mulerouter --version
mulerouter --help

Run on demand

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

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):

npm install --save-dev mulerouter

Then call it through your package runner:

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 before upgrading across major versions.

npm install -g mulerouter@latest

Uninstall

npm uninstall -g mulerouter
# or
bun remove -g mulerouter

Next step

Head to Configuration to set your API key and pick a site.

Getting Started

Commands

Workflows

Reference

Installation

Global install

Run on demand

Per-project install

Upgrading

Uninstall

Next step

​Global install

​Run on demand

​Per-project install

​Upgrading

​Uninstall

​Next step

Global install

Run on demand

Per-project install

Upgrading

Uninstall

Next step