Installation

Install the CueAPI CLI and worker packages.

CLI

The CueAPI CLI lets you manage cues, check usage, and authenticate from the terminal.

bash
pip install cueapi

Verify the installation:

bash
cueapi --version

Info

Requires Python 3.9 or later. Available on PyPI.

Worker (optional)

If you want to run handlers locally (without a public URL), install the worker daemon:

bash
pip install cueapi-worker

Verify:

bash
cueapi-worker --help

Info

The worker is only needed for worker transport. If you're using webhook delivery to a public URL, you don't need it.

What's next

Authenticate

Run cueapi login to authenticate via browser. See Authentication.

Create your first cue

Follow the Quickstart to create and test a cue.

Set up a worker (optional)

See Local Worker Setup to run handlers on your machine.