跳到主内容
智客 ZICQ

技能库 智客分类:运维与云 inngest-cli

Inngest Cli

当安装或运行Inngest CLI和Dev Server用于本地开发,本地测试,服务端点调试,Docker或Docker编译设置,MCP配置,自办"inngest start",或部署工作流程检查. 包括`ingest dev'、`ingest start'、自动发现、配置文件、环境变量、`ingest/test'、本地事件发送、平台获取和制作/自行托管的服务器旗帜.

672 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

当安装或运行Inngest CLI和Dev Server用于本地开发,本地测试,服务端点调试,Docker或Docker编译设置,MCP配置,自办"inngest start",或部署工作流程检查. 包括`ingest dev'、`ingest start'、自动发现、配置文件、环境变量、`ingest/test'、本地事件发送、平台获取和制作/自行托管的服务器旗帜.

何时用

安装或运行Inngest CLI和Dev Server,用于本地开发、本地测试、服务端点调试、Docker或Docker编译设置、MCP配置、自办的“inngest start”或部署工作流程检查。 涵盖`最热门'、`最热门 ' 、自动发现

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Inngest CLI、Installation、npx (recommended — always latest)、yarn、pnpm、Global install。

文件分析

文件分析:除 SKILL.md 外,正文引用了 references/local-mcp.md,属于带资源的技能包,这些文件按需再读。

官方 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.

Inngest CLIInstallationnpx (recommended — always latest)yarnpnpmGlobal installDocker`inngest dev` — Local Dev ServerAuto-discover apps on common ports/endpointsSpecify your app URLCustom portMultiple apps

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
inngest-cli
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.
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。
指令中引用的文件 · 1
  • references/local-mcp.md

以下路径提取自原文;文件是否齐全请以来源仓库中的完整目录为准。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

该技能引用了附属文件,请从来源获取完整目录;仅复制 SKILL.md 可能缺少依赖。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「inngest-cli」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-bebf8598d73c2335-%E5%8E%9F%E5%A7%8B%E5%86%85%E5%AE%B9%E5%AD%98%E6%A1%A3%E4%BA%8E2018-09-21-%E8%8B%B1%E8%AF%AD-Ingest-Cli.html
请存为 .cursor/skills/inngest-cli/SKILL.md 或 .claude/skills/inngest-cli/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。
该技能还带 scripts/、references/、assets/ 等文件,请从 https://github.com/inngest/inngest-skills 取完整目录,不要只建一个 SKILL.md。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/inngest/inngest-skills' --list

npx skills add 'https://github.com/inngest/inngest-skills' --skill 'inngest-cli'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版
--- name: inngest-cli 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. --- # 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](https://www.inngest.com/llms.txt) 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 ```bash # 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`. ```bash # 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 | Flag | Short | Default | Description | |---|---|---|---| | `--sdk-url` | `-u` | `http://localhost:3000/api/inngest` | App serve endpoint URL(s) | | `--port` | `-p` | `8288` | Dev Server port | | `--host` | | | Dev Server host | | `--no-discovery` | | `false` | Disable auto-discovery of apps | | `--no-poll` | | `false` | Disable polling apps for changes | | `--config` | | | Path to configuration file | | `--connect-gateway-port` | | `8289` | Connect gateway endpoint port | | `--persist` | | `false` | Persist data between restarts | | `--poll-interval` | | `5` | Seconds between app polling checks | | `--queue-workers` | | `100` | Number of executor workers | | `--retry-interval` | | `0` | Linear retry interval in seconds | | `--tick` | | `150` | Executor 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. ```json { "sdk-url": [ "http://localhost:3000/api/inngest", "http://localhost:3030/api/inngest" ], "no-discovery": true } ``` ```yaml # inngest.yaml sdk-url: - "http://localhost:3000/api/inngest" - "http://localhost:3030/api/inngest" no-discovery: true ``` ## Environment Variables | Variable | Description | |---|---| | `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_URL` | Host for SDK-to-Inngest communication (e.g., `http://localhost:8288`). Leave unset in most cases. | | `INNGEST_EVENT_KEY` | Authentication key for sending events. **Use any dummy value locally** — Dev Server does not validate. | | `INNGEST_SIGNING_KEY` | Secures requests between Inngest and your app. **Required in production.** Determines which Inngest environment receives syncs. | | `INNGEST_SIGNING_KEY_FALLBACK` | Fallback key for signing key rotation (v3.18.0+). | | `INNGEST_SERVE_ORIGIN` | Full 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_PATH` | URL path to your serve endpoint (e.g., `/api/inngest`). Auto-inferred in most cases. | | `INNGEST_STREAMING` | Enable response streaming (`true`/`false`). Extends timeout limits on Vercel and edge runtimes. | | `INNGEST_ENV` | Target Inngest Environment. Auto-detected on some platforms. | ## Debugging Your Serve Endpoint Verify your `serve()` endpoint is configured correctly: ```bash curl -s http://localhost:3000/api/inngest | jq ``` ```json { "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 ```typescript import { Inngest } from "inngest"; const inngest = new Inngest({ id: "my-app" }); await inngest.send({ name: "user/signup.completed", data: { userId: "user_123", email: "[email protected]", }, }); ``` ### Send Events via curl ```bash curl -X POST "http://localhost:8288/e/test" \ -H "Content-Type: application/json" \ -d '{ "name": "user/signup.completed", "data": { "userId": "user_123", "email": "[email protected]" } }' ``` The event key in the URL path (`test` above) can be any value locally. ### Unit Testing with `@inngest/test` Requires `inngest@>=4.0.0`. ```bash npm install -D @inngest/test ``` ```typescript 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 ```bash 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 ```yaml 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 plugins bundle `inngest-cloud` for OAuth access to deployed resources. Local Dev Server MCP is a separate, opt-in connection named `inngest-dev`. Both can be used in the same coding session. For local MCP setup or connection troubleshooting, read [Local MCP setup](references/local-mcp.md). Use the configured local connection for apps and runs on the Dev Server (`inngest-dev` by default; keep an existing connection’s name). Use `inngest-cloud` for deployed resources, selecting the intended account and environment. If the target is unclear, resolve it before calling either server. Never switch from local to Cloud because the local server is offline. Read each server's live tool schemas. Local tools include app, function, event, run, and trace operations, plus embedded documentation search. Availability and inputs depend on the running Dev Server version. ## `inngest start` — Self-Hosted Production Runs Inngest as a self-hosted production server. **Not the same as `inngest dev`** — this is for production workloads. ```bash inngest start --event-key --signing-key ``` | Flag | Short | Default | Description | |---|---|---|---| | `--port` | `-p` | `8288` | Server port | | `--signing-key` | | | Hex key for request signing (even character count) | | `--event-key` | | | Authentication key for apps (repeatable) | | `--sdk-url` | `-u` | | App serve URLs (repeatable) | | `--redis-uri` | | | External Redis connection | | `--postgres-uri` | | | External PostgreSQL connection | | `--sqlite-dir` | | | SQLite database directory | | `--poll-interval` | | `0` | App sync polling interval (seconds) | | `--queue-workers` | | `100` | Number of executor workers | | `--connect-gateway-port` | | `8289` | Connect gateway port | | `--retry-interval` | | `0` | Linear retry interval in seconds | | `--tick` | | `150` | Executor queue polling interval in milliseconds | | `--no-ui` | | | Disable web UI and GraphQL API | | `--postgres-conn-max-idle-time` | | `5` | PostgreSQL idle connection lifetime in minutes | | `--postgres-conn-max-lifetime` | | `30` | PostgreSQL maximum connection reuse time in minutes | | `--postgres-max-idle-conns` | | `10` | PostgreSQL max idle connections | | `--postgres-max-open-conns` | | `100` | PostgreSQL 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: ```bash # 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 ``` 4. **Set environment variables** in production: ```bash INNGEST_EVENT_KEY= INNGEST_SIGNING_KEY= ``` **No code changes** are needed when moving from local dev to production. The SDK automatically detects the environment. ## Platform-Specific Gotchas | Platform | Gotcha | |---|---| | **Express** | Requires `express.json()` middleware; default body limit is `100kb` — increase to handle Inngest payloads (up to 4MB) | | **AWS Lambda** | Set `INNGEST_SERVE_ORIGIN` and `INNGEST_SERVE_PATH` explicitly — auto-inference fails | | **Firebase Cloud Functions** | Must set `INNGEST_SERVE_PATH` env var | | **DigitalOcean Functions** | Both `serveOrigin` and `servePath` required in `serve()` config | | **Cloudflare Workers (Wrangler `--remote`)** | Requires tunnel (ngrok/localtunnel) for Dev Server connection | | **Supabase Edge Functions** | `servePath` must match function name — Supabase rewrites request paths | | **Google Cloud Run (1st gen)** | Not officially supported; may cause signature verification errors | | **Docker** | Must set `INNGEST_DEV=1` — SDK defaults to Cloud mode | | **External webhooks (Stripe, Clerk)** | Require tunnel solution (ngrok, localtunnel) for local testing | ## Quick Reference ```bash # 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 --signing-key ``` ## Troubleshooting | Issue | Cause | Solution | |---|---|---| | Dev Server doesn't find functions | App not running or wrong port | Start your app first; use `-u` to specify the correct URL | | `functionsFound: 0` in debug output | Functions not passed to `serve()` | Verify all functions are in the array passed to `serve()` | | SDK connects to Cloud instead of Dev Server | `INNGEST_DEV` not set | Set `INNGEST_DEV=1` in your environment | | Functions sync to wrong Inngest environment | Wrong signing key | Check `INNGEST_SIGNING_KEY` matches target environment | | Duplicate app in Inngest dashboard | App `id` was changed | Keep the `id` in `new Inngest({ id })` stable across deploys | | Webhook events not reaching Dev Server | No tunnel configured | Use ngrok or localtunnel for external webhook sources | | "Unattached sync" in dashboard | Auto-sync failed silently | Check integration logs; resync manually | See [inngest-setup](../inngest-setup/SKILL.md) for SDK installation and [inngest-durable-functions](../inngest-durable-functions/SKILL.md) for function configuration.

相关技能

运维与云

Docker Essentials

用于容器管理,图像操作,调试的基本道克命令和工作流程.

运维与云

Find Skills

从开放的代理技能生态系统中发现并安装技能. 使用时:(1)用户问"我如何做X",X可能拥有现有技能,(2)用户说"为X找到技能"或"是否为X有技能",(3)用户问"你能否做X",X是专门能力,(4)用户想扩展代理能力,(5)用户想搜索工具,模板,或工作流程,(6)用户提到他们希望…

运维与云

Microsoft Foundry

构建,部署,评价,优化,微调,管理微软创始代理,模型,资源最终结束. 用法:铸造、azd ai代理、azd 提供/部署、托管代理脚手架/开发/运行/部署/拖放、即时代理创建、创建代理、更新代理、添加代理工具、援引代理、代理.yaml、评估代理、批量活化、连续活化、持续监测、代理C…

运维与云

Azure Deploy

执行已有.azure/部署计划.md和基础设施文件的ALREADY-PREPARED应用程序的Azure部署。 当用户向 CREATE 请求新应用程序时, 请不要使用此技能 。 这种技能运行了 azd上行, azd 部署, trarraform 应用, 和 az 部署命令带有内置…