Skip to main content
This guide walks through the full happy path: install, configure, discover a model, and run it.
1

Install

See Installation for bun, pnpm, or one-off npx usage.
2

Set your API key

Get a key from the MuleRouter Console. See Configuration for .env files, custom gateways, and other options.
3

Discover a model

Pick an endpoint identifier in the form provider/model (auto-resolved when only one action exists) or provider/model/action.
4

Inspect its parameters

The output lists every flag, its type, whether it is required, default values, and enum choices.
5

Run it

The CLI submits the task, polls until the result is ready, and prints the asset URLs.

​
Three more recipes

Text-to-Video
Image-to-Video (local file path is auto-converted to base64)
Text-to-Image (OpenAI GPT Image 2)

​
What you got

By default run blocks until the task completes and prints something like:
Add --json to get a machine-readable payload, or --no-wait to return as soon as the task is queued and check on it later with mulerouter status.

​
Next