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

# Installation

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

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

## Global install

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

```bash npm theme={null}
npm install -g carrothub
```

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

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

```bash yarn theme={null}
yarn global add carrothub
```

Verify the install:

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

## Run on demand

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

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

bunx carrothub list
bunx carrothub 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 carrothub
```

Then call it through your package runner:

```bash theme={null}
npx carrothub list
# or, from a npm script:
# "scripts": { "gen": "carrothub 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/carrothub-cli/blob/main/CHANGELOG.md)
before upgrading across major versions.

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

## Uninstall

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

## Next step

Head to [Configuration](https://www.carrothub.ai/docs/cli/configuration.md) to set your API key and pick a site.


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