> ## 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.

# Quickstart

> From zero to a generated image, video, or audio clip in under a minute

This guide walks through the full happy path: install, configure, discover a
model, and run it.

<Steps>
  <Step title="Install">
    ```bash theme={null}
    npm install -g mulerouter
    mulerouter --version
    ```

    See [Installation](/docs/cli/installation) for `bun`, `pnpm`, or one-off `npx`
    usage.
  </Step>

  <Step title="Set your API key">
    ```bash theme={null}
    export MULEROUTER_API_KEY="sk-..."
    ```

    Get a key from the [MuleRouter Console](https://www.mulerouter.ai/app/api-keys).
    See [Configuration](/docs/cli/configuration) for `.env` files, custom gateways,
    and other options.
  </Step>

  <Step title="Discover a model">
    ```bash theme={null}
    mulerouter list --output-type image
    ```

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

  <Step title="Inspect its parameters">
    ```bash theme={null}
    mulerouter params alibaba/wan2.6-t2i
    ```

    The output lists every flag, its type, whether it is required, default
    values, and enum choices.
  </Step>

  <Step title="Run it">
    ```bash theme={null}
    mulerouter run alibaba/wan2.6-t2i \
      --prompt "A serene mountain lake at sunset, photorealistic" \
      --size "1280*1280"
    ```

    The CLI submits the task, polls until the result is ready, and prints the
    asset URLs.
  </Step>
</Steps>

## Three more recipes

**Text-to-Video**

```bash theme={null}
mulerouter run alibaba/wan2.6-t2v \
  --prompt "A golden retriever running on a beach at sunrise" \
  --duration 10 \
  --audio
```

**Image-to-Video** (local file path is auto-converted to base64)

```bash theme={null}
mulerouter run alibaba/wan2.6-i2v \
  --image ./photo.png \
  --prompt "Slow cinematic push-in, clouds drifting" \
  --resolution "1080P"
```

**Text-to-Image** (OpenAI GPT Image 2)

```bash theme={null}
mulerouter run openai/gpt-image-2/generation \
  --prompt "A vector logo of a fox, flat style" \
  --size "1024x1024"
```

## What you got

By default `run` blocks until the task completes and prints something like:

```
Creating task at /vendors/alibaba/v1/wan2.6-t2i/generation...
[12s] status: queued
[32s] status: running
[52s] status: succeeded

Task ID: 9d2b8...
Status:  succeeded

Results:
  https://cdn.mulerouter.ai/.../image-0.png
```

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`](/docs/cli/commands/status).

## Next

* Read through the [command reference](/docs/cli/commands/list) to learn every flag.
* Browse the [model cheatsheet](/docs/cli/models) to find the right endpoint.
* Skim [Workflows](/docs/cli/workflows/async-tasks) for async batching, jq pipelines,
  and CI patterns.