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

# Introduction

> Command-line interface for the CarrotHub multimodal AI API

## Overview

**CarrotHub CLI** is the official command-line interface for
[CarrotHub](https://www.carrothub.ai). It exposes every supported
text-to-image, text-to-video, image-to-video, text-to-speech, and
text-to-music endpoint through a single, scriptable binary called
`carrothub`.

The CLI is designed for three audiences:

* **Developers** who want to try a model without writing any integration code.
* **Operators and scripts** that need to drive generation from shell pipelines, cron jobs, or CI.
* **AI agents** that can shell out to a stable, JSON-aware command.

## Highlights

* **40+ model endpoints** across Alibaba, Google, KlingAI, Midjourney, OpenAI and more.
* **One verb per task**: `list`, `params`, `run`, `status`, `config`.
* **Async-aware**: every long-running task can either be polled to completion or queued with `--no-wait` and resumed later via `status`.
* **Local file support**: pass `--image /path/to/photo.png` and the CLI validates, reads, and base64-encodes the file automatically.
* **JSON mode** on every command for clean machine-readable output.
* **Zero runtime config** beyond an API key — the binary talks to `https://api.carrothub.ai` out of the box.

## Packages

The CLI ships as two npm packages that you can mix and match:

| Package | What it is | When to install |
| - | - | - |
| [`carrothub`](https://www.npmjs.com/package/carrothub) | The `carrothub` executable | You want the CLI |
| [`@carrothub/core`](https://www.npmjs.com/package/@carrothub/core) | The TypeScript SDK that powers the CLI — registry, API client, task poller, image helpers | You are embedding CarrotHub calls in a Node/Bun/TypeScript program |

Both packages are MIT-licensed and have zero runtime dependencies beyond
`picocolors` (used only by the CLI for terminal colors).

## Where to go next

> [card] [Install & configure](https://www.carrothub.ai/docs/cli/installation.md)
>
> Install the binary and point it at your API key.

> [card] [Quickstart](https://www.carrothub.ai/docs/cli/quickstart.md)
>
> Generate your first image, video, or audio clip in under a minute.

> [card] [Commands](https://www.carrothub.ai/docs/cli/commands/list.md)
>
> Reference for every subcommand and flag.

> [card] [Model cheatsheet](https://www.carrothub.ai/docs/cli/models.md)
>
> Pick the right endpoint for the job.


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