@ctdio/inngest-ctl
v0.2.0
Published
CLI for interacting with Inngest's REST API - list events, send events, check run status, and cancel runs
Maintainers
Readme
inngest-ctl
Command-line interface for Inngest events and runs.
Setup
# Via bunx (no install needed)
bunx @ctdio/inngest-ctl <command>
# Or create an alias
alias inngest-ctl="bunx @ctdio/inngest-ctl"Agent Skill
Install as an agent skill for AI-assisted Inngest operations:
npx skills install ctdio/inngest-ctlOnce installed, your agent can query events, check run status, and manage Inngest functions directly.
Environment Variables
export INNGEST_EVENT_KEY="your-event-key" # Required for sending events
export INNGEST_SIGNING_KEY="your-signing-key" # Required for API queriesUsage
inngest-ctl <command> [options]
Commands:
events Send and query events
runs Query function runs
cancel Cancel running functions
Global Options:
--pretty Human-readable output with colors
--output <file> Write JSON output to file
--dev Use local dev server (default: localhost:8288)
--port <port> Dev server port (default: 8288)
--help, -h Show help
--version, -v Show versionEvents
inngest-ctl events <subcommand> [options]
Subcommands:
list List recent events
send Send an event
get Get event details
runs List runs triggered by an event
List Options:
--name <name> Filter by event name
--limit <n> Max events to return
Send Options:
--name <name> Event name (required)
--data <json> Event data as JSON (required)
--id <id> Deduplication ID
--env <env> Branch environment nameExamples:
inngest-ctl events list --pretty
inngest-ctl events list --name "user.signup" --limit 10 --pretty
inngest-ctl events send --name "user.signup" --data '{"userId": "123"}'
inngest-ctl events get 01H08W4TMBNKMEWFD0TYC532GG --pretty
inngest-ctl events runs 01H08W4TMBNKMEWFD0TYC532GG --prettyRuns
inngest-ctl runs <subcommand> [options]
Subcommands:
status Get run status and duration
get Get run details (jobs/steps)
list List runs for an event
List Options:
--event <id> Event ID to list runs forExamples:
inngest-ctl runs status 01H08W5TMBNKMEWFD0TYC532GH --pretty
inngest-ctl runs get 01H08W5TMBNKMEWFD0TYC532GH --pretty
inngest-ctl runs list --event 01H08W4TMBNKMEWFD0TYC532GGCancel
inngest-ctl cancel --app <app> --function <fn> --started-after <time> --started-before <time> [--if <expr>]Example:
inngest-ctl cancel --app my-app --function my-func --started-after 1h --started-before nowDev Server
Use --dev flag to target local Inngest dev server:
# Start Inngest dev server
npx inngest-cli@latest dev
# Query local events
inngest-ctl events list --dev --pretty
# Send event to local
inngest-ctl events send --name "test.event" --data '{}' --devOverride URL with INNGEST_DEV_URL:
export INNGEST_DEV_URL="http://localhost:9000"License
MIT
