Inngest logo

Skill

inngest-cli

configure Inngest CLI and dev server

Published by Inngest Updated Jul 12
Covers Inngest Local Development CLI Docker

Description

Use when installing or running the Inngest CLI and Dev Server for local development, local testing, serve endpoint debugging, Docker or Docker Compose setup, MCP configuration, self-hosted `inngest start`, or deployment workflow checks. Covers `inngest dev`, `inngest start`, auto-discovery, config files, environment variables, `@inngest/test`, local event sending, platform gotchas, and production/self-hosted server flags.

SKILL.md

Inngest CLI

Master the Inngest CLI for local development, testing, and self-hosted production. The CLI provides the Dev Server — a fully-featured, open-source local version of the Inngest Platform.

These skills are focused on TypeScript. For Python or Go, refer to the Inngest documentation for language-specific guidance. Core concepts apply across all languages.

Use this skill for CLI setup, Dev Server workflows, local testing, Docker, MCP, and self-hosted server operations. For run/trace inspection through inngest api, use inngest-api-cli when available.

Installation

# npx (recommended — always latest)
npx inngest-cli@latest dev

# yarn
yarn dlx inngest-cli@latest dev

# pnpm
pnpm dlx inngest-cli@latest dev

# Global install
npm install -g inngest-cli

# Docker
docker pull inngest/inngest

If your npm configuration disables lifecycle scripts and the binary is missing, retry with npx --ignore-scripts=false inngest-cli@latest dev. Bun does not support lifecycle scripts by default, so prefer npx for the CLI even in Bun projects.

inngest dev — Local Dev Server

Starts an in-memory local version of Inngest with a browser UI at http://localhost:8288.

# Auto-discover apps on common ports/endpoints
npx inngest-cli@latest dev

# Specify your app URL
npx inngest-cli@latest dev -u http://localhost:3000/api/inngest

# Custom port
npx inngest-cli@latest dev -p 9999

# Multiple apps
npx inngest-cli@latest dev \
  -u http://localhost:3000/api/inngest \
  -u http://localhost:4000/api/inngest

# Disable auto-discovery (use with -u)
npx inngest-cli@latest dev --no-discovery -u http://localhost:3000/api/inngest

CLI Flags

FlagShortDefaultDescription
--sdk-url-uhttp://localhost:3000/api/inngestApp serve endpoint URL(s)
--port-p8288Dev Server port
--hostDev Server host
--no-discoveryfalseDisable auto-discovery of apps
--no-pollfalseDisable polling apps for changes
--configPath to configuration file
--connect-gateway-port8289Connect gateway endpoint port
--persistfalsePersist data between restarts
--poll-interval5Seconds between app polling checks
--queue-workers100Number of executor workers
--retry-interval0Linear retry interval in seconds
--tick150Executor queue polling interval in milliseconds

Auto-Discovery

Without --no-discovery, the Dev Server scans common ports and endpoints automatically:

Ports scanned: Common development ports including 3000, 3030, and others

Endpoints scanned:

  • /api/inngest
  • /x/inngest
  • /.netlify/functions/inngest
  • /.redwood/functions/inngest

Configuration File

Create an inngest.json (or .yaml, .toml) in your project root. The CLI walks up directories to find it.

{
  "sdk-url": [
    "http://localhost:3000/api/inngest",
    "http://localhost:3030/api/inngest"
  ],
  "no-discovery": true
}
# inngest.yaml
sdk-url:
  - "http://localhost:3000/api/inngest"
  - "http://localhost:3030/api/inngest"
no-discovery: true

Environment Variables

VariableDescription
INNGEST_DEV=1 enables Dev Mode (disables signature verification). =0 forces Cloud mode. Accepts a URL (e.g., http://localhost:8288). Defaults to Cloud mode if unset.
INNGEST_BASE_URLHost for SDK-to-Inngest communication (e.g., http://localhost:8288). Leave unset in most cases.
INNGEST_EVENT_KEYAuthentication key for sending events. Use any dummy value locally — Dev Server does not validate.
INNGEST_SIGNING_KEYSecures requests between Inngest and your app. Required in production. Determines which Inngest environment receives syncs.
INNGEST_SIGNING_KEY_FALLBACKFallback key for signing key rotation (v3.18.0+).
INNGEST_SERVE_ORIGINFull origin URL for Inngest to reach your app (e.g., https://my-app.com). Auto-inferred from request headers; set explicitly for AWS Lambda, proxies, or tunnels.
INNGEST_SERVE_PATHURL path to your serve endpoint (e.g., /api/inngest). Auto-inferred in most cases.
INNGEST_STREAMINGEnable response streaming (true/false). Extends timeout limits on Vercel and edge runtimes.
INNGEST_ENVTarget Inngest Environment. Auto-detected on some platforms.

Debugging Your Serve Endpoint

Verify your serve() endpoint is configured correctly:

curl -s http://localhost:3000/api/inngest | jq
{
  "message": "Inngest endpoint configured correctly.",
  "hasEventKey": false,
  "hasSigningKey": false,
  "functionsFound": 3
}

If functionsFound is 0, check that your functions are passed to the serve() call.

Testing Functions Locally

Send Events via SDK

import { Inngest } from "inngest";

const inngest = new Inngest({ id: "my-app" });

await inngest.send({
  name: "user/signup.completed",
  data: {
    userId: "user_123",
    email: "user@example.com",
  },
});

Send Events via curl

curl -X POST "http://localhost:8288/e/test" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "user/signup.completed",
    "data": {
      "userId": "user_123",
      "email": "user@example.com"
    }
  }'

The event key in the URL path (test above) can be any value locally.

Unit Testing with @inngest/test

Requires inngest@>=4.0.0.

npm install -D @inngest/test
import { InngestTestEngine } from "@inngest/test";
import { helloWorld } from "./functions";

// Execute full function
const t = new InngestTestEngine({ function: helloWorld });
const { result } = await t.execute();
expect(result).toEqual("Hello World!");

// Test a single step
const { result: stepResult } = await t.executeStep("calculate-price");
expect(stepResult).toEqual(123);

// Assert step state
const { state } = await t.execute();
await expect(state["my-step"]).resolves.toEqual("output");
await expect(state["risky-step"]).rejects.toThrowError("failed");

// Mock events
const { result: eventResult } = await t.execute({
  events: [{ name: "demo/event.sent", data: { message: "Hi!" } }],
});

// Mock step responses
const { result: mockResult } = await t.execute({
  steps: [{ id: "external-api-call", handler() { return { status: "ok" }; } }],
});

// Mock sleep/waitForEvent (pause-inducing steps require mocking)
await t.execute({
  steps: [{ id: "wait-one-day", handler() {} }],
});

Mock external dependencies with your test framework's standard mocking (jest.mock, vi.mock, etc.) — @inngest/test handles only Inngest-specific mocking.

Docker Setup

Standalone

docker run -p 8288:8288 -p 8289:8289 \
  inngest/inngest \
  inngest dev -u http://host.docker.internal:3000/api/inngest

Use host.docker.internal to reach your app running on the host machine (works out of the box on Docker Desktop). On Linux, add --add-host=host.docker.internal:host-gateway or use an equivalent host-access method.

Docker Compose

services:
  app:
    build: ./app
    environment:
      - INNGEST_DEV=1
      - INNGEST_BASE_URL=http://inngest:8288
    ports:
      - "3000:3000"
  inngest:
    image: inngest/inngest
    command: "inngest dev -u http://app:3000/api/inngest"
    ports:
      - "8288:8288"
      - "8289:8289"

Port 8288 is the main server and UI. Port 8289 is the connect() WebSocket gateway.

Critical: Set INNGEST_DEV=1 on your app — the TypeScript SDK defaults to Cloud mode, which will skip the Dev Server.

MCP Server (AI Dev Tools)

The Dev Server exposes an MCP server at http://127.0.0.1:8288/mcp (HTTP transport).

# Claude Code
claude mcp add --transport http inngest-dev http://127.0.0.1:8288/mcp
// .cursor/mcp.json or another MCP-capable client config
{
  "mcpServers": {
    "inngest-dev": {
      "url": "http://127.0.0.1:8288/mcp"
    }
  }
}

Available MCP Tools

ToolDescription
send_eventSend events to trigger functions
list_functionsList all registered functions and triggers
invoke_functionExecute a function synchronously (default 30s timeout)
get_run_statusGet detailed status of a function run
poll_run_statusPoll multiple runs until completion
grep_docsSearch Inngest documentation by regex pattern
read_docRead a specific documentation page
list_docsList available documentation structure

inngest start — Self-Hosted Production

Runs Inngest as a self-hosted production server. Not the same as inngest dev — this is for production workloads.

inngest start --event-key <key> --signing-key <key>
FlagShortDefaultDescription
--port-p8288Server port
--signing-keyHex key for request signing (even character count)
--event-keyAuthentication key for apps (repeatable)
--sdk-url-uApp serve URLs (repeatable)
--redis-uriExternal Redis connection
--postgres-uriExternal PostgreSQL connection
--sqlite-dirSQLite database directory
--poll-interval0App sync polling interval (seconds)
--queue-workers100Number of executor workers
--connect-gateway-port8289Connect gateway port
--retry-interval0Linear retry interval in seconds
--tick150Executor queue polling interval in milliseconds
--no-uiDisable web UI and GraphQL API
--postgres-conn-max-idle-time5PostgreSQL idle connection lifetime in minutes
--postgres-conn-max-lifetime30PostgreSQL maximum connection reuse time in minutes
--postgres-max-idle-conns10PostgreSQL max idle connections
--postgres-max-open-conns100PostgreSQL max open connections

Global flags such as --log-level, --verbose, and --json are also available. For environment variables, follow the current CLI and deployment docs; do not assume every flag has an INNGEST_ environment variable equivalent.

Default persistence: in-memory Redis + SQLite at ./.inngest/main.db. For production, use external Redis and PostgreSQL.

Deployment Workflow

Local Development → Production

  1. Develop locally with inngest dev — no keys needed, no code changes for production
  2. Deploy your app to your hosting platform
  3. Sync with Inngest using one of three methods:
# Option 1: Curl from CI/CD
curl -X PUT https://your-app.com/api/inngest --fail-with-body

# Option 2: Vercel/Netlify integrations (automatic on deploy)

# Option 3: Manual sync via Inngest Cloud dashboard
  1. Set environment variables in production:
INNGEST_EVENT_KEY=<your-event-key>
INNGEST_SIGNING_KEY=<your-signing-key>

No code changes are needed when moving from local dev to production. The SDK automatically detects the environment.

Platform-Specific Gotchas

PlatformGotcha
ExpressRequires express.json() middleware; default body limit is 100kb — increase to handle Inngest payloads (up to 4MB)
AWS LambdaSet INNGEST_SERVE_ORIGIN and INNGEST_SERVE_PATH explicitly — auto-inference fails
Firebase Cloud FunctionsMust set INNGEST_SERVE_PATH env var
DigitalOcean FunctionsBoth serveOrigin and servePath required in serve() config
Cloudflare Workers (Wrangler --remote)Requires tunnel (ngrok/localtunnel) for Dev Server connection
Supabase Edge FunctionsservePath must match function name — Supabase rewrites request paths
Google Cloud Run (1st gen)Not officially supported; may cause signature verification errors
DockerMust set INNGEST_DEV=1 — SDK defaults to Cloud mode
External webhooks (Stripe, Clerk)Require tunnel solution (ngrok, localtunnel) for local testing

Quick Reference

# Start dev server with auto-discovery
npx inngest-cli@latest dev

# Start with explicit app URL
npx inngest-cli@latest dev -u http://localhost:3000/api/inngest

# Check serve endpoint health
curl -s http://localhost:3000/api/inngest | jq

# Send test event via curl
curl -X POST http://localhost:8288/e/test -d '{"name": "test/event", "data": {}}'

# Sync after deploy (CI/CD)
curl -X PUT https://your-app.com/api/inngest --fail-with-body

# Self-hosted production
inngest start --event-key <key> --signing-key <key>

Troubleshooting

IssueCauseSolution
Dev Server doesn't find functionsApp not running or wrong portStart your app first; use -u to specify the correct URL
functionsFound: 0 in debug outputFunctions not passed to serve()Verify all functions are in the array passed to serve()
SDK connects to Cloud instead of Dev ServerINNGEST_DEV not setSet INNGEST_DEV=1 in your environment
Functions sync to wrong Inngest environmentWrong signing keyCheck INNGEST_SIGNING_KEY matches target environment
Duplicate app in Inngest dashboardApp id was changedKeep the id in new Inngest({ id }) stable across deploys
Webhook events not reaching Dev ServerNo tunnel configuredUse ngrok or localtunnel for external webhook sources
"Unattached sync" in dashboardAuto-sync failed silentlyCheck integration logs; resync manually

See inngest-setup for SDK installation and inngest-durable-functions for function configuration.

© 2026 YourAI.tools. Every skill from an identity-verified publisher.

Independent catalog. Not affiliated with, endorsed by, or sponsored by Anthropic or any listed publisher. All trademarks belong to their respective owners.