Commands

Complete CLI command reference with examples.

Auth Commands

`cueapi login`

Authenticate via browser with magic link.

bash

cueapi login

`cueapi whoami`

Show current user info and usage.

bash

cueapi whoami

`cueapi logout`

Remove stored credentials.

bash

cueapi logout          # Default profile
cueapi logout --all    # All profiles

Cue Commands

`cueapi create`

Create a new cue.

bash

# Recurring cue
cueapi create --name "daily-sync" --cron "0 9 * * *" \
  --url https://api.example.com/sync
 
# One-time cue
cueapi create --name "reminder" --at "2026-03-15T14:00:00Z" \
  --url https://api.example.com/notify
 
# With payload
cueapi create --name "agent-task" --cron "0 9 * * 1-5" \
  --url https://api.example.com/hook \
  --payload '{"task": "draft-linkedin", "kind": "agent_turn"}'
 
# With description
cueapi create --name "daily-sync" --cron "0 9 * * *" \
  --url https://api.example.com/sync \
  --description "Sync inventory from warehouse A"
 
# Worker transport (no public URL needed; cueapi-worker pulls work locally)
cueapi create --name "agent-task" --cron "0 9 * * *" --worker
 
# With on-failure escalation
cueapi create --name "critical-job" --cron "0 * * * *" \
  --url https://api.example.com/run \
  --on-failure '{"after_attempts": 3, "notify": "[email protected]"}'

Flag	Required	Description
`--name`	Yes	Cue name
`--cron`	One of	Cron expression (recurring)
`--at`	One of	ISO timestamp (one-time)
`--url` / `--callback`	If webhook	Callback URL (omit for `--worker`)
`--worker`	No	Worker transport — agents pull work via cueapi-worker daemon instead of receiving a webhook
`--method`	No	HTTP method (default: POST)
`--timezone`	No	Timezone (default: UTC)
`--payload`	No	JSON payload string
`--description`	No	Cue description
`--on-failure`	No	JSON config for failure escalation (e.g. `{"after_attempts": 3, "notify": "[email protected]"}`)

`cueapi list`

List your cues.

bash

cueapi list
cueapi list --status active
cueapi list --limit 50 --offset 10

Flag	Default	Description
`--status`	all	Filter: `active`, `paused`
`--limit`	20	Max results
`--offset`	0	Skip results

`cueapi get <cue_id>`

Get detailed info about a cue, including recent executions.

bash

cueapi get cue_a1b2c3d4e5f6

`cueapi update <cue_id>`

Update an existing cue. Pass at least one field to change. Fields not specified stay as they are.

bash

# Rename
cueapi update cue_a1b2c3d4e5f6 --name "renamed-cue"
 
# Change schedule
cueapi update cue_a1b2c3d4e5f6 --cron "0 10 * * *"
 
# Change callback URL
cueapi update cue_a1b2c3d4e5f6 --url https://new-handler.example.com/run
 
# Replace payload
cueapi update cue_a1b2c3d4e5f6 --payload '{"task": "updated"}'
 
# Update on-failure config
cueapi update cue_a1b2c3d4e5f6 \
  --on-failure '{"after_attempts": 5, "notify": "[email protected]"}'

Flag	Description
`--name`	New cue name
`--cron`	New cron expression
`--url` / `--callback`	New callback URL
`--payload`	New JSON payload (full replacement)
`--description`	New description
`--on-failure`	New JSON `on_failure` config

Specifying zero fields raises an error. Sends PATCH /v1/cues/{id}.

`cueapi pause <cue_id>`

Pause a cue.

bash

cueapi pause cue_a1b2c3d4e5f6

`cueapi resume <cue_id>`

Resume a paused cue.

bash

cueapi resume cue_a1b2c3d4e5f6

`cueapi delete <cue_id>`

Delete a cue (asks for confirmation).

bash

cueapi delete cue_a1b2c3d4e5f6
cueapi delete cue_a1b2c3d4e5f6 -y   # Skip confirmation

Usage & Billing

`cueapi usage`

Show current usage stats.

bash

cueapi usage

Plan: Free
Active cues: 3 / 10
Executions: 42 / 300 (14.0%)
Rate limit: 60 req/min

`cueapi upgrade`

Upgrade your plan via Stripe Checkout.

bash

cueapi upgrade

Interactive prompt for plan (pro/scale) and interval (monthly/annual). Opens Stripe Checkout in your browser.

`cueapi manage`

Open Stripe billing portal to manage your subscription.

bash

cueapi manage

Key Management

`cueapi key regenerate`

Regenerate your API key (revokes the current one).

bash

cueapi key regenerate
cueapi key regenerate -y   # Skip confirmation

Setup

`cueapi quickstart`

Guided setup: creates a test cue, verifies delivery, and cleans up.

bash

cueapi quickstart

Walks you through:

Creating an echo token
Creating a one-time cue
Verifying the webhook delivery
Cleaning up the test cue

Previous← Login NextTroubleshooting →