TypeScript SDK v4 is now available! See what's new
GuidesCLI

Inngest CLI

Inspect runs, fetch traces, invoke functions, and give coding agents access to your Inngest data from the terminal.

npx inngest-cli@latest

Quick start

Set your API key and start inspecting runs:

export INNGEST_API_KEY=sk-inn-api-...

# Get a function run
npx inngest-cli@latest api get-function-run 01KTCTWT8XDEGWDMVX3Q9M69ND

# Get runs triggered by an event
npx inngest-cli@latest api get-event-runs 01KTCTWSZJEKAFEDA4F9GYHFQW --include-output --limit 5

# Invoke a function
npx inngest-cli@latest api invoke-function my-app my-function --data '{"message": "hello"}'

# Fetch a full trace
npx inngest-cli@latest api get-function-trace 01KTCTWT8XDEGWDMVX3Q9M69ND --include-output

The CLI auto-generates commands from the Inngest v2 REST API. Every API endpoint is available as a subcommand under inngest-cli api.

Authentication

The CLI accepts environment-scoped API keys. These are separate from signing keys and can be scoped to a specific environment.

Create an API key in the Inngest dashboard under Settings > API Keys. Environment-scoped keys automatically target the right environment without any extra configuration.

Auth precedence:

  1. --api-key flag (explicit override)
  2. INNGEST_API_KEY environment variable
  3. INNGEST_SIGNING_KEY environment variable (fallback)
  4. Dev server: no auth required

Dev server vs cloud

The CLI targets your local dev server by default. Use --prod to hit Inngest Cloud:

# Local dev server (default)
npx inngest-cli@latest api get-function-run 01ABC123

# Inngest Cloud
npx inngest-cli@latest api --prod get-function-run 01ABC123

# Custom API host
npx inngest-cli@latest api --api-host http://localhost:8288 get-function-run 01ABC123

Target resolution:

  1. --api-host or --api-port flags
  2. --prod flag
  3. Default: local dev server

Available commands

All commands live under inngest-cli api. Run --help on any command to see its options:

npx inngest-cli@latest api --help
npx inngest-cli@latest api get-function-run --help

Runs

CommandDescription
get-function-run <run_id>Get a function run summary
get-function-trace <run_id>Get the full trace with step spans
get-event-runs <event_id>List runs triggered by a specific event

Functions

CommandDescription
invoke-function <app_id> <function_id>Invoke a function with a JSON payload

Common flags:

  • --include-output includes step and run output in the response
  • --limit N limits the number of results
  • --prod targets Inngest Cloud instead of the dev server

Output format

The CLI outputs compact JSON by default. Pipe to jq or other tools:

# Get just the status
npx inngest-cli@latest api --prod get-function-run 01ABC123 | jq '.data.status'

# Pretty print
npx inngest-cli@latest api --prod get-function-run 01ABC123 | jq .