diff --git a/docs/ai-chat/changelog.mdx b/docs/ai-chat/changelog.mdx index e7567b422b7..d47e02acac8 100644 --- a/docs/ai-chat/changelog.mdx +++ b/docs/ai-chat/changelog.mdx @@ -2,8 +2,13 @@ title: "AI Agents SDK changelog" sidebarTitle: "Changelog" description: "Changelog for the AI Agents SDK." +hidden: true --- + + This page covers releases up to 4.5.0. For newer releases, see the [Trigger.dev changelog](https://trigger.dev/changelog). + + ## Point chat sessions at a different project or environment diff --git a/docs/ai-chat/mcp.mdx b/docs/ai-chat/mcp.mdx index 78ddf489ec8..65878777426 100644 --- a/docs/ai-chat/mcp.mdx +++ b/docs/ai-chat/mcp.mdx @@ -4,7 +4,7 @@ sidebarTitle: "MCP Server" description: "Chat with your agents from any AI coding tool using the Trigger.dev MCP server." --- -The Trigger.dev MCP server includes tools for having conversations with your chat agents directly from AI coding tools like Claude Code, Cursor, Windsurf, and others. This lets your AI assistant interact with your agents without writing any code. +The Trigger.dev MCP server includes tools for having conversations with your chat agents directly from AI coding tools like Claude Code, Codex, Cursor and others. This lets your AI assistant interact with your agents without writing any code. ## Available tools diff --git a/docs/building-with-ai.mdx b/docs/building-with-ai.mdx index 7290a39b3e9..4847a8fa36f 100644 --- a/docs/building-with-ai.mdx +++ b/docs/building-with-ai.mdx @@ -12,7 +12,7 @@ We provide multiple tools to help AI coding assistants write correct Trigger.dev - Give your AI assistant direct access to Trigger.dev tools — search docs, trigger tasks, deploy projects, and monitor runs. Works with Claude Code, Cursor, Windsurf, VS Code (Copilot), and Zed. + Give your AI assistant direct access to Trigger.dev tools — search docs, trigger tasks, deploy projects, and monitor runs. Works with Claude Code, Codex, Cursor, VS Code (Copilot), Gemini CLI, Zed and other MCP clients. ```bash npx trigger.dev@latest install-mcp @@ -53,13 +53,13 @@ If you prefer a lightweight/passive approach, paste the snippet below into a con | File | Read by | |:-----|:--------| +| `AGENTS.md` | Most coding agents, including Codex, Cursor, GitHub Copilot, Devin Desktop, Cline, Jules and opencode | | `CLAUDE.md` | Claude Code | -| `AGENTS.md` | OpenAI Codex, Jules, OpenCode | | `.cursor/rules/*.md` | Cursor | | `.github/copilot-instructions.md` | GitHub Copilot | -| `CONVENTIONS.md` | Windsurf, Cline, and others | +| `CONVENTIONS.md` | Aider (load it with `aider --read CONVENTIONS.md`) | -Create the file that matches your AI tool (or multiple files if your team uses different tools) and paste the snippet below. This gives the AI essential Trigger.dev context without installing anything. +`AGENTS.md` covers most tools, so start there and add `CLAUDE.md` if your team uses Claude Code. Create the file that matches your AI tool (or multiple files if your team uses different tools) and paste the snippet below. This gives the AI essential Trigger.dev context without installing anything. diff --git a/docs/docs.json b/docs/docs.json index b29fd403e33..a5cc3b98079 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -2,7 +2,7 @@ "$schema": "https://mintlify.com/docs.json", "theme": "maple", "name": "Trigger.dev", - "description": "Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required.", + "description": "Build and run durable AI agents and workflows in TypeScript. Long-running tasks with retries, queues, webhooks, observability, and elastic scaling. Open source and self-hostable.", "colors": { "primary": "#A8FF53", "light": "#A8FF53", @@ -21,13 +21,86 @@ "groups": [ { "group": "Getting started", + "pages": ["introduction", "quick-start", "manual-setup", "how-it-works", "limits"] + }, + { + "group": "Agents", "pages": [ - "introduction", - "quick-start", - "manual-setup", - "video-walkthrough", - "how-it-works", - "limits" + "ai-chat/overview", + "ai-chat/quick-start", + "ai-chat/migrating-from-a-route-handler", + { + "group": "Building agents", + "pages": [ + "ai-chat/anatomy", + "ai-chat/backend", + "ai-chat/lifecycle-hooks", + "ai-chat/tools", + "ai-chat/frontend", + "ai-chat/server-chat", + "ai-chat/sessions", + "ai-chat/side-channels", + "ai-chat/chat-local", + "ai-chat/types", + "ai-chat/custom-agents", + "ai-chat/how-it-works" + ] + }, + { + "group": "Features", + "pages": [ + "ai/prompts", + "ai/observability", + "ai-chat/fast-starts", + "ai-chat/compaction", + "ai-chat/prompt-caching", + "ai-chat/pending-messages", + "ai-chat/background-injection", + "ai-chat/actions", + "ai-chat/transcript-storage", + "ai-chat/migrating-from-hydrate-messages", + "ai-chat/error-handling" + ] + }, + { + "group": "Channels", + "pages": [ + "webhooks/channels", + "webhooks/slack", + "webhooks/linear", + "webhooks/human-in-the-loop" + ] + }, + { + "group": "Patterns", + "pages": [ + "ai-chat/patterns/sub-agents", + "ai-chat/patterns/version-upgrades", + "ai-chat/patterns/database-persistence", + "ai-chat/patterns/persistence-and-replay", + "ai-chat/patterns/branching-conversations", + "ai-chat/patterns/code-sandbox", + "ai-chat/patterns/human-in-the-loop", + "ai-chat/patterns/tool-result-auditing", + "ai-chat/patterns/large-payloads", + "ai-chat/patterns/skills", + "ai-chat/patterns/oom-resilience", + "ai-chat/patterns/recovery-boot", + "ai-chat/patterns/trusted-edge-signals", + "ai-chat/patterns/redacting-telemetry", + "ai-chat/patterns/native-compaction" + ] + }, + { + "group": "Reference", + "pages": [ + "ai-chat/reference", + "ai-chat/client-protocol", + "ai-chat/testing", + "ai-chat/mcp", + "ai-chat/upgrade-guide" + ] + } ] }, { @@ -108,87 +181,6 @@ "runs/bulk-actions" ] }, - { - "group": "Agents", - "pages": [ - "ai-chat/overview", - "ai-chat/quick-start", - "ai-chat/migrating-from-a-route-handler", - { - "group": "Building agents", - "pages": [ - "ai-chat/anatomy", - "ai-chat/backend", - "ai-chat/lifecycle-hooks", - "ai-chat/tools", - "ai-chat/frontend", - "ai-chat/server-chat", - "ai-chat/sessions", - "ai-chat/side-channels", - "ai-chat/chat-local", - "ai-chat/types", - "ai-chat/custom-agents", - "ai-chat/how-it-works" - ] - }, - { - "group": "Features", - "pages": [ - "ai/prompts", - "ai/observability", - "ai-chat/fast-starts", - "ai-chat/compaction", - "ai-chat/prompt-caching", - "ai-chat/pending-messages", - "ai-chat/background-injection", - "ai-chat/actions", - "ai-chat/transcript-storage", - "ai-chat/migrating-from-hydrate-messages", - "ai-chat/error-handling" - ] - }, - { - "group": "Channels", - "pages": [ - "webhooks/channels", - "webhooks/slack", - "webhooks/linear", - "webhooks/human-in-the-loop" - ] - }, - { - "group": "Patterns", - "pages": [ - "ai-chat/patterns/sub-agents", - "ai-chat/patterns/version-upgrades", - "ai-chat/patterns/database-persistence", - "ai-chat/patterns/persistence-and-replay", - "ai-chat/patterns/branching-conversations", - "ai-chat/patterns/code-sandbox", - "ai-chat/patterns/human-in-the-loop", - "ai-chat/patterns/tool-result-auditing", - "ai-chat/patterns/large-payloads", - "ai-chat/patterns/skills", - "ai-chat/patterns/oom-resilience", - "ai-chat/patterns/recovery-boot", - "ai-chat/patterns/trusted-edge-signals", - "ai-chat/patterns/redacting-telemetry", - "ai-chat/patterns/native-compaction" - ] - }, - { - "group": "Reference", - "pages": [ - "ai-chat/reference", - "ai-chat/client-protocol", - "ai-chat/testing", - "ai-chat/mcp", - "ai-chat/upgrade-guide", - "ai-chat/changelog" - ] - } - ] - }, { "group": "Webhooks", "pages": [ @@ -621,38 +613,34 @@ "group": "Introduction", "pages": ["guides/introduction"] }, + { + "group": "AI agents", + "pages": [ + "guides/ai-agents/overview", + "guides/ai-agents/chat-agent", + "guides/ai-agents/generate-translate-copy", + "guides/ai-agents/route-question", + "guides/ai-agents/respond-and-check-content", + "guides/ai-agents/translate-and-refine", + "guides/ai-agents/verify-news-article", + "guides/ai-agents/claude-code-trigger" + ] + }, { "group": "Frameworks", "pages": [ - "guides/frameworks/bun", "guides/frameworks/nextjs", "guides/frameworks/nodejs", - "guides/frameworks/remix", + "guides/frameworks/bun", "guides/frameworks/nextjs-webhooks", - "guides/frameworks/remix-webhooks", - "guides/community/sveltekit" + "guides/community/sveltekit", + "guides/frameworks/remix", + "guides/frameworks/remix-webhooks" ] }, { "group": "Guides", "pages": [ - { - "group": "AI Agents", - "icon": { - "name": "microchip-ai", - "style": "regular" - }, - "pages": [ - "guides/ai-agents/overview", - "guides/ai-agents/chat-agent", - "guides/ai-agents/generate-translate-copy", - "guides/ai-agents/route-question", - "guides/ai-agents/respond-and-check-content", - "guides/ai-agents/translate-and-refine", - "guides/ai-agents/verify-news-article" - ] - }, - "guides/ai-agents/claude-code-trigger", "guides/frameworks/drizzle", "guides/frameworks/prisma", "guides/frameworks/nango", @@ -672,10 +660,6 @@ } ] }, - { - "group": "Migration guides", - "pages": ["migrating-from-v3", "migration-mergent", "migration-n8n"] - }, { "group": "Use cases", "pages": [ @@ -694,14 +678,12 @@ "guides/example-projects/batch-llm-evaluator", "guides/example-projects/claude-changelog-generator", "guides/example-projects/claude-github-wiki", - "guides/example-projects/claude-thinking-chatbot", "guides/example-projects/clickhouse-chat-agent", "guides/example-projects/cursor-background-agent", "guides/example-projects/elevenlabs-voice-agent", "guides/example-projects/grok-ai-teammates", "guides/example-projects/human-in-the-loop-workflow", "guides/example-projects/mastra-agents-with-memory", - "guides/example-projects/meme-generator-human-in-the-loop", "guides/example-projects/openai-agents-sdk-typescript-playground", "guides/example-projects/product-image-generator", "guides/example-projects/realtime-csv-importer", @@ -709,8 +691,7 @@ "guides/example-projects/resend-email-agent", "guides/example-projects/smart-spreadsheet", "guides/example-projects/turborepo-monorepo-prisma", - "guides/example-projects/vercel-ai-sdk-deep-research", - "guides/example-projects/vercel-ai-sdk-image-generator" + "guides/example-projects/vercel-ai-sdk-deep-research" ] }, { @@ -726,7 +707,6 @@ { "group": "Example tasks", "pages": [ - "guides/examples/dall-e3-generate-image", "guides/examples/deepgram-transcribe-audio", "guides/examples/fal-ai-image-to-cartoon", "guides/examples/fal-ai-realtime", @@ -760,6 +740,18 @@ "guides/community/rate-limiter", "guides/community/sveltekit" ] + }, + { + "group": "Migration guides", + "pages": [ + "migration-n8n", + { + "group": "Legacy", + "hidden": true, + "searchable": true, + "pages": ["migrating-from-v3"] + } + ] } ] } diff --git a/docs/guides/ai-agents/overview.mdx b/docs/guides/ai-agents/overview.mdx index e7ed76a25be..802aa362cd4 100644 --- a/docs/guides/ai-agents/overview.mdx +++ b/docs/guides/ai-agents/overview.mdx @@ -82,14 +82,6 @@ description: "Real world AI agent example tasks using Trigger.dev" Evaluate multiple LLM models in parallel with the Vercel AI SDK and stream the results to a Next.js frontend using Trigger.dev Realtime. - - Build a Next.js chatbot that streams Claude's extended thinking to the frontend with the Vercel - AI SDK and Trigger.dev Realtime. - ## Chat agents diff --git a/docs/guides/example-projects/claude-thinking-chatbot.mdx b/docs/guides/example-projects/claude-thinking-chatbot.mdx index 9ac62e306f4..eb37bfb72d7 100644 --- a/docs/guides/example-projects/claude-thinking-chatbot.mdx +++ b/docs/guides/example-projects/claude-thinking-chatbot.mdx @@ -2,6 +2,7 @@ title: "Claude 3.7 thinking chatbot" sidebarTitle: "Claude thinking chatbot" description: "This example Next.js project uses Vercel's AI SDK and Anthropic's Claude 3.7 model to create a thinking chatbot." +hidden: true --- import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx"; diff --git a/docs/guides/example-projects/mastra-agents-with-memory.mdx b/docs/guides/example-projects/mastra-agents-with-memory.mdx index 344eb7913c7..762e77a8ad3 100644 --- a/docs/guides/example-projects/mastra-agents-with-memory.mdx +++ b/docs/guides/example-projects/mastra-agents-with-memory.mdx @@ -18,7 +18,7 @@ By combining Mastra's persistent memory system and agent orchestration with Trig - **[Mastra](https://mastra.ai)** for AI agent orchestration and memory management (Mastra is a Typescript framework for building AI agents, and uses Vercel's AI Agent SDK under the hood.) - **[PostgreSQL](https://postgresql.org)** for persistent storage and memory sharing - **[Trigger.dev](https://trigger.dev)** for task orchestration, batching, and observability -- **[OpenAI GPT-4](https://openai.com)** for natural language processing +- **[OpenAI GPT-4o](https://openai.com)** for the agents' responses - **[Open-Meteo API](https://open-meteo.com)** for weather data (no API key required) - **[Zod](https://zod.dev)** for schema validation and type safety diff --git a/docs/guides/example-projects/meme-generator-human-in-the-loop.mdx b/docs/guides/example-projects/meme-generator-human-in-the-loop.mdx index 050cfb543d5..15ae104c3a4 100644 --- a/docs/guides/example-projects/meme-generator-human-in-the-loop.mdx +++ b/docs/guides/example-projects/meme-generator-human-in-the-loop.mdx @@ -2,6 +2,7 @@ title: "Meme generator with human-in-the-loop approval" sidebarTitle: "AI meme generator" description: "This example project creates memes using OpenAI's DALL-E 3 with a human-in-the-loop approval workflow built using Trigger.dev waitpoint tokens." +hidden: true --- ## Overview diff --git a/docs/guides/example-projects/vercel-ai-sdk-image-generator.mdx b/docs/guides/example-projects/vercel-ai-sdk-image-generator.mdx index ea13ac92b08..7ab28ba2923 100644 --- a/docs/guides/example-projects/vercel-ai-sdk-image-generator.mdx +++ b/docs/guides/example-projects/vercel-ai-sdk-image-generator.mdx @@ -2,6 +2,7 @@ title: "Vercel AI SDK image generator" sidebarTitle: "Vercel AI SDK image generator" description: "This example Next.js project uses the Vercel AI SDK to generate images from a prompt." +hidden: true --- import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx"; diff --git a/docs/guides/examples/dall-e3-generate-image.mdx b/docs/guides/examples/dall-e3-generate-image.mdx index fc0a7f0d04f..c8e61ef7d84 100644 --- a/docs/guides/examples/dall-e3-generate-image.mdx +++ b/docs/guides/examples/dall-e3-generate-image.mdx @@ -2,6 +2,7 @@ title: "Generate an image using DALL·E 3" sidebarTitle: "DALL·E image generation" description: "This example will show you how to generate an image using DALL·E 3 and text using GPT-4o with Trigger.dev." +hidden: true --- ## Overview diff --git a/docs/guides/examples/react-email.mdx b/docs/guides/examples/react-email.mdx index 322b47da150..de7db80e374 100644 --- a/docs/guides/examples/react-email.mdx +++ b/docs/guides/examples/react-email.mdx @@ -169,7 +169,7 @@ export interface TriggerWelcomeEmailProps { export const TriggerWelcomeEmail = ({ name }: TriggerWelcomeEmailProps) => ( - Welcome to Trigger.dev - Your background jobs platform! + Welcome to Trigger.dev
@@ -182,8 +182,8 @@ export const TriggerWelcomeEmail = ({ name }: TriggerWelcomeEmailProps) => (
Welcome, {name}! - Thanks for signing up for Trigger.dev! You're now ready to start creating powerful - background jobs and workflows. + Thanks for signing up for Trigger.dev! You're now ready to start building durable + AI agents and workflows. You can monitor your jobs, view runs, and manage your projects right from your diff --git a/docs/guides/examples/scrape-hacker-news.mdx b/docs/guides/examples/scrape-hacker-news.mdx index fe9ecf1fd95..fcaff10880d 100644 --- a/docs/guides/examples/scrape-hacker-news.mdx +++ b/docs/guides/examples/scrape-hacker-news.mdx @@ -1,7 +1,7 @@ --- title: "Scrape the top 3 articles from Hacker News and email yourself a summary every weekday" sidebarTitle: "Browserbase & Puppeteer" -description: "This example demonstrates how to scrape the top 3 articles from Hacker News using BrowserBase and Puppeteer, summarize them with ChatGPT and send a nicely formatted email summary to yourself every weekday using Resend." +description: "This example demonstrates how to scrape the top 3 articles from Hacker News using BrowserBase and Puppeteer, summarize them with OpenAI and send a nicely formatted email summary to yourself every weekday using Resend." --- import LocalDevelopment from "/snippets/local-development-extensions.mdx"; @@ -188,7 +188,7 @@ export const scrapeAndSummarizeArticle = task({ logger.info(`Extracted content for article: ${title}`, { content }); - // Summarize the content using ChatGPT + // Summarize the content using OpenAI const response = await openai.chat.completions.create({ model: "gpt-4o", messages: [ diff --git a/docs/guides/introduction.mdx b/docs/guides/introduction.mdx index 122693eb52c..3e135076602 100644 --- a/docs/guides/introduction.mdx +++ b/docs/guides/introduction.mdx @@ -56,7 +56,6 @@ Example projects are full projects with example repos you can fork and use. Thes | [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) | | [Claude changelog generator](/guides/example-projects/claude-changelog-generator) | Automatically generate professional changelogs from git commits using Claude. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/changelog-generator) | | [Claude GitHub wiki agent](/guides/example-projects/claude-github-wiki) | Generate and maintain GitHub wiki documentation with Claude-powered analysis. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/claude-agent-github-wiki) | -| [Claude thinking chatbot](/guides/example-projects/claude-thinking-chatbot) | Use Vercel's AI SDK and Anthropic's Claude 3.7 model to create a thinking chatbot. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/claude-thinking-chatbot) | | [ClickHouse chat agent](/guides/example-projects/clickhouse-chat-agent) | Build a chat agent that answers questions about your ClickHouse data with charts, tables and maps using `chat.agent()` and generative UI. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/clickhouse-chat-agent) | | [Cursor background agent](/guides/example-projects/cursor-background-agent) | Run Cursor's headless CLI agent as a background task, streaming live output to the browser. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/cursor-cli-demo) | | [ElevenLabs Voice agent](/guides/example-projects/elevenlabs-voice-agent) | Hold a spoken conversation with a voice assistant using streaming ElevenLabs speech-to-text and text-to-speech, on a Trigger.dev `chat.agent()`. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/voice-agent-demo) | @@ -72,7 +71,6 @@ Example projects are full projects with example repos you can fork and use. Thes | [Resend email agent](/guides/example-projects/resend-email-agent) | An AI agent that drafts replies to a Resend inbox and waits for your approval in Slack before sending, using hosted webhooks and wait tokens. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/resend-slack-email-agent) | | [Smart Spreadsheet](/guides/example-projects/smart-spreadsheet) | Enrich company data using Exa search and Claude with real-time streaming results. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/smart-spreadsheet) | | [Turborepo monorepo with Prisma](/guides/example-projects/turborepo-monorepo-prisma) | Use Prisma in a Turborepo monorepo with Trigger.dev. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/monorepos/turborepo-prisma-tasks-package) | -| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) | | [Vercel AI SDK deep research agent](/guides/example-projects/vercel-ai-sdk-deep-research) | Use the Vercel AI SDK to generate comprehensive PDF reports using a deep research agent. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-deep-research-agent) | ## Example tasks @@ -81,7 +79,6 @@ Task code you can copy and paste to use in your project. They can all be extende | Example task | Description | | :---------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | -| [DALL·E 3 image generation](/guides/examples/dall-e3-generate-image) | Use OpenAI's GPT-4o and DALL·E 3 to generate an image and text. | | [Deepgram audio transcription](/guides/examples/deepgram-transcribe-audio) | Transcribe audio using Deepgram's speech recognition API. | | [Fal.ai image to cartoon](/guides/examples/fal-ai-image-to-cartoon) | Convert an image to a cartoon using Fal.ai, and upload the result to Cloudflare R2. | | [Fal.ai with Realtime](/guides/examples/fal-ai-realtime) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | @@ -97,7 +94,7 @@ Task code you can copy and paste to use in your project. They can all be extende | [Resend email sequence](/guides/examples/resend-email-sequence) | Send a sequence of emails over several days using Resend with Trigger.dev. | | [Replicate image generation](/guides/examples/replicate-image-generation) | Learn how to generate images from source image URLs using Replicate and Trigger.dev. | | [Satori](/guides/examples/satori) | Generate OG images using React Satori. | -| [Scrape Hacker News](/guides/examples/scrape-hacker-news) | Scrape Hacker News using BrowserBase and Puppeteer, summarize the articles with ChatGPT and send an email of the summary every weekday using Resend. | +| [Scrape Hacker News](/guides/examples/scrape-hacker-news) | Scrape Hacker News using BrowserBase and Puppeteer, summarize the articles with OpenAI and send an email of the summary every weekday using Resend. | | [Sentry error tracking](/guides/examples/sentry-error-tracking) | Automatically send errors to Sentry from your tasks. | | [Sharp image processing](/guides/examples/sharp-image-processing) | Use Sharp to process an image and save it to Cloudflare R2. | | [Supabase database operations](/guides/examples/supabase-database-operations) | Run basic CRUD operations on a table in a Supabase database using Trigger.dev. | diff --git a/docs/guides/use-cases/media-generation.mdx b/docs/guides/use-cases/media-generation.mdx index 919440df5f6..c3ae2beaa15 100644 --- a/docs/guides/use-cases/media-generation.mdx +++ b/docs/guides/use-cases/media-generation.mdx @@ -20,20 +20,6 @@ Build AI media generation pipelines that handle unpredictable API latencies and > Transform product photos into professional marketing images using Replicate. - - Generate memes with DALL·E 3 and add human approval steps. - - - Generate images from text prompts using the Vercel AI SDK. - ## Benefits of using Trigger.dev for AI media generation workflows @@ -83,7 +69,7 @@ graph TB - Simple AI image generation. Receives prompt and parameters, calls OpenAI DALL·E 3, post-processes result, uploads to storage. + Simple AI image generation. Receives prompt and parameters, calls an image generation model, post-processes result, uploads to storage.
diff --git a/docs/images/environment-variables-page.jpg b/docs/images/environment-variables-page.jpg index 21a6ac94b56..1da22f3469d 100644 Binary files a/docs/images/environment-variables-page.jpg and b/docs/images/environment-variables-page.jpg differ diff --git a/docs/images/environment-variables-panel.jpg b/docs/images/environment-variables-panel.jpg index 3dd3d642952..47686649052 100644 Binary files a/docs/images/environment-variables-panel.jpg and b/docs/images/environment-variables-panel.jpg differ diff --git a/docs/images/replay-run-action.png b/docs/images/replay-run-action.png index ea0a3eb15cd..a523acd7658 100644 Binary files a/docs/images/replay-run-action.png and b/docs/images/replay-run-action.png differ diff --git a/docs/images/replay-run-modal.png b/docs/images/replay-run-modal.png index f97494b724e..85e3c92ea11 100644 Binary files a/docs/images/replay-run-modal.png and b/docs/images/replay-run-modal.png differ diff --git a/docs/images/replay-runs-list-popover.png b/docs/images/replay-runs-list-popover.png index 7444225ac44..8585a3f4e12 100644 Binary files a/docs/images/replay-runs-list-popover.png and b/docs/images/replay-runs-list-popover.png differ diff --git a/docs/images/replay-runs-list.png b/docs/images/replay-runs-list.png index 8679520fbc8..5e414b4607f 100644 Binary files a/docs/images/replay-runs-list.png and b/docs/images/replay-runs-list.png differ diff --git a/docs/images/run-log.png b/docs/images/run-log.png index 7b695e5ed4d..9097f7f4f14 100644 Binary files a/docs/images/run-log.png and b/docs/images/run-log.png differ diff --git a/docs/images/run-page.png b/docs/images/run-page.png index aa895555be8..edbcc954d35 100644 Binary files a/docs/images/run-page.png and b/docs/images/run-page.png differ diff --git a/docs/images/tags-filtering.png b/docs/images/tags-filtering.png index 1b62503a274..a921ab34270 100644 Binary files a/docs/images/tags-filtering.png and b/docs/images/tags-filtering.png differ diff --git a/docs/images/tags-org-user.png b/docs/images/tags-org-user.png index a04d9e69b1c..0cae3cb34a7 100644 Binary files a/docs/images/tags-org-user.png and b/docs/images/tags-org-user.png differ diff --git a/docs/images/terminal-completed-run.png b/docs/images/terminal-completed-run.png index 805e32fda94..57bcc1901c9 100644 Binary files a/docs/images/terminal-completed-run.png and b/docs/images/terminal-completed-run.png differ diff --git a/docs/images/trigger-cli-run-success.png b/docs/images/trigger-cli-run-success.png index 76de17971a2..b4fa4d5e1c0 100644 Binary files a/docs/images/trigger-cli-run-success.png and b/docs/images/trigger-cli-run-success.png differ diff --git a/docs/images/troubleshooting-alerts-blank.png b/docs/images/troubleshooting-alerts-blank.png index e7f96a03a23..2d1e8f008e7 100644 Binary files a/docs/images/troubleshooting-alerts-blank.png and b/docs/images/troubleshooting-alerts-blank.png differ diff --git a/docs/images/troubleshooting-alerts-disable-delete.png b/docs/images/troubleshooting-alerts-disable-delete.png index bf64de5516d..8927d58e0f6 100644 Binary files a/docs/images/troubleshooting-alerts-disable-delete.png and b/docs/images/troubleshooting-alerts-disable-delete.png differ diff --git a/docs/images/troubleshooting-alerts-modal.png b/docs/images/troubleshooting-alerts-modal.png index 357185ff509..5a1e390e816 100644 Binary files a/docs/images/troubleshooting-alerts-modal.png and b/docs/images/troubleshooting-alerts-modal.png differ diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 50d4cd80785..951c7567172 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -15,7 +15,7 @@ import AgentSetupPrompt from "/snippets/agent-setup-prompt.mdx"; Durable, multi-turn agents with `chat.agent`, from your frontend to Slack and Linear. - Let Claude Code, Cursor and Windsurf write correct Trigger.dev code with the MCP server, Skills and rules. + Let Claude Code, Codex, Cursor and other coding agents write correct Trigger.dev code with the MCP server, Skills and rules. Frameworks like Next.js, worked example projects, and step-by-step how-to guides. diff --git a/docs/mcp-introduction.mdx b/docs/mcp-introduction.mdx index f9d2b39c5c8..744a208245b 100644 --- a/docs/mcp-introduction.mdx +++ b/docs/mcp-introduction.mdx @@ -57,36 +57,32 @@ Each client has a slightly different config format. Copy the snippet for your cl [View Claude Code MCP docs ↗](https://code.claude.com/docs/en/mcp) - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client cursor + npx trigger.dev@latest install-mcp --client openai-codex ``` - Or add this configuration to `~/.cursor/mcp.json` (user) or `.cursor/mcp.json` (project): + Or add this configuration to `~/.codex/config.toml`: - ```json - { - "mcpServers": { - "trigger": { - "command": "npx", - "args": ["trigger.dev@latest", "mcp"] - } - } - } + ```toml + [mcp_servers.trigger] + command = "npx" + args = ["trigger.dev@latest", "mcp"] + startup_timeout_sec = 30 ``` - [View Cursor MCP docs ↗](https://cursor.com/docs/context/mcp) + The `startup_timeout_sec = 30` is recommended. Codex defaults to 10 seconds, which may not be enough for `npx` to download the package on first run. - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client windsurf + npx trigger.dev@latest install-mcp --client cursor ``` - Or add this configuration to `~/.codeium/windsurf/mcp_config.json`: + Or add this configuration to `~/.cursor/mcp.json` (user) or `.cursor/mcp.json` (project): ```json { @@ -99,7 +95,7 @@ Each client has a slightly different config format. Copy the snippet for your cl } ``` - [View Windsurf MCP docs ↗](https://docs.windsurf.com/windsurf/cascade/mcp) + [View Cursor MCP docs ↗](https://cursor.com/docs/context/mcp) Install using the command line: @@ -125,72 +121,73 @@ Each client has a slightly different config format. Copy the snippet for your cl [View VS Code MCP docs ↗](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client zed + npx trigger.dev@latest install-mcp --client gemini-cli ``` - Or add this configuration to `~/.config/zed/settings.json`: + Or add this configuration to `~/.gemini/settings.json` (user) or `.gemini/settings.json` (project): ```json { - "context_servers": { + "mcpServers": { "trigger": { - "source": "custom", "command": "npx", "args": ["trigger.dev@latest", "mcp"] } } } ``` - - [View Zed context servers docs ↗](https://zed.dev/docs/ai/mcp) - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client cline + npx trigger.dev@latest install-mcp --client opencode ``` - Or add this configuration to `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`: + Or add this configuration to `~/.config/opencode/opencode.json` (user) or `./opencode.json` (project): ```json { - "mcpServers": { + "mcp": { "trigger": { - "command": "npx", - "args": ["trigger.dev@latest", "mcp"] + "type": "local", + "command": ["npx", "trigger.dev@latest", "mcp"], + "enabled": true } } } ``` - [View Cline MCP docs ↗](https://docs.cline.bot/mcp/configuring-mcp-servers) + [View opencode MCP docs ↗](https://opencode.ai/docs/mcp-servers/) - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client gemini-cli + npx trigger.dev@latest install-mcp --client zed ``` - Or add this configuration to `~/.gemini/settings.json` (user) or `.gemini/settings.json` (project): + Or add this configuration to `~/.config/zed/settings.json`: ```json { - "mcpServers": { + "context_servers": { "trigger": { + "source": "custom", "command": "npx", "args": ["trigger.dev@latest", "mcp"] } } } ``` + + [View Zed context servers docs ↗](https://zed.dev/docs/ai/mcp) - + Install using the command line: ```bash @@ -210,40 +207,37 @@ Each client has a slightly different config format. Copy the snippet for your cl } ``` - [View Sourcegraph AMP MCP docs ↗](https://ampcode.com/manual#mcp) + [View Amp MCP docs ↗](https://ampcode.com/manual#mcp) - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client openai-codex + npx trigger.dev@latest install-mcp --client cline ``` - Or add this configuration to `~/.codex/config.toml`: + Or add this configuration to `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`: - ```toml - [mcp_servers.trigger] - command = "npx" - args = ["trigger.dev@latest", "mcp"] - startup_timeout_sec = 30 + ```json + { + "mcpServers": { + "trigger": { + "command": "npx", + "args": ["trigger.dev@latest", "mcp"] + } + } + } ``` - The `startup_timeout_sec = 30` is recommended. Codex defaults to 10 seconds, which may not be enough for `npx` to download the package on first run. + [View Cline MCP docs ↗](https://docs.cline.bot/mcp/configuring-mcp-servers) - - Install using the command line: - - ```bash - npx trigger.dev@latest install-mcp --client crush - ``` - - Or add this configuration to `.crush.json` (project), `crush.json`, or `~/.config/crush/crush.json` (user). Files are loaded in priority order: `.crush.json` → `crush.json` → `$HOME/.config/crush/crush.json`. + + Add this configuration to `~/.config/devin/mcp_config.json`, or to `.devin/mcp_config.json` in your project to share it with your team: ```json { - "mcp": { + "mcpServers": { "trigger": { - "type": "stdio", "command": "npx", "args": ["trigger.dev@latest", "mcp"] } @@ -251,30 +245,30 @@ Each client has a slightly different config format. Copy the snippet for your cl } ``` - [View Charm MCP docs ↗](https://github.com/charmbracelet/crush) + [View Devin Desktop MCP docs ↗](https://docs.devin.ai/desktop/devin-local/customizations) - + Install using the command line: ```bash - npx trigger.dev@latest install-mcp --client opencode + npx trigger.dev@latest install-mcp --client crush ``` - Or add this configuration to `~/.config/opencode/opencode.json` (user) or `./opencode.json` (project): + Or add this configuration to `.crush.json` (project), `crush.json`, or `~/.config/crush/crush.json` (user). Files are loaded in priority order: `.crush.json` → `crush.json` → `$HOME/.config/crush/crush.json`. ```json { "mcp": { "trigger": { - "type": "local", - "command": ["npx", "trigger.dev@latest", "mcp"], - "enabled": true + "type": "stdio", + "command": "npx", + "args": ["trigger.dev@latest", "mcp"] } } } ``` - [View opencode MCP docs ↗](https://opencode.ai/docs/mcp-servers/) + [View Charm MCP docs ↗](https://github.com/charmbracelet/crush) Install using the command line: diff --git a/docs/migration-mergent.mdx b/docs/migration-mergent.mdx index 1d43dee8c06..b07d29ea54e 100644 --- a/docs/migration-mergent.mdx +++ b/docs/migration-mergent.mdx @@ -2,6 +2,7 @@ title: "Migrating from Mergent" description: "A guide for migrating from Mergent to Trigger.dev" sidebarTitle: "Migrating from Mergent" +hidden: true --- Mergent was acquired by Resend and its service shut down on July 28, 2025. If you ran background jobs or scheduled tasks on Mergent, you need to move them to another platform. Trigger.dev is a modern, developer-friendly platform for background jobs, workflows, and scheduling. diff --git a/docs/quick-start.mdx b/docs/quick-start.mdx index 97798be150f..f8c4cf47b75 100644 --- a/docs/quick-start.mdx +++ b/docs/quick-start.mdx @@ -1,7 +1,7 @@ --- title: "Quick start: add Trigger.dev to your project" sidebarTitle: "Quick start" -description: "Set up Trigger.dev in your existing project in under 3 minutes. Install the SDK, create your first background task, and trigger it from your code." +description: "Set up Trigger.dev in your existing project in under 3 minutes. Install the SDK, create your first task, and trigger it from your code." --- import CliInitStep from "/snippets/step-cli-init.mdx"; diff --git a/docs/realtime/overview.mdx b/docs/realtime/overview.mdx index 94cd48c5b82..df6309d484f 100644 --- a/docs/realtime/overview.mdx +++ b/docs/realtime/overview.mdx @@ -1,7 +1,7 @@ --- title: Realtime overview sidebarTitle: Overview -description: "Get live run updates and stream data from background tasks to your frontend or backend. No polling." +description: "Get live run updates and stream data from your tasks and agents to your frontend or backend. No polling." --- **Realtime is the umbrella for everything live in Trigger.dev.** It covers two things: getting notified when a run's state changes, and streaming continuous data (like AI tokens) from a running task to your app. diff --git a/docs/realtime/react-hooks/overview.mdx b/docs/realtime/react-hooks/overview.mdx index 3d5a3f15788..80278575410 100644 --- a/docs/realtime/react-hooks/overview.mdx +++ b/docs/realtime/react-hooks/overview.mdx @@ -1,12 +1,12 @@ --- title: "React hooks for real-time task updates" sidebarTitle: Overview -description: "Subscribe to background task progress, stream AI responses, and trigger tasks from React components using @trigger.dev/react-hooks." +description: "Subscribe to run progress, stream AI responses, and trigger tasks from React components using @trigger.dev/react-hooks." --- import RealtimeExamplesCards from "/snippets/realtime-examples-cards.mdx"; -**`@trigger.dev/react-hooks` gives your React components live access to background tasks.** Subscribe to run progress, stream AI output as it generates, or trigger tasks directly from the browser. +**`@trigger.dev/react-hooks` gives your React components live access to your runs.** Subscribe to run progress, stream AI output as it generates, or trigger tasks directly from the browser. ## Installation diff --git a/docs/realtime/react-hooks/streams.mdx b/docs/realtime/react-hooks/streams.mdx index ee6a8bd7cb6..816b01cb29f 100644 --- a/docs/realtime/react-hooks/streams.mdx +++ b/docs/realtime/react-hooks/streams.mdx @@ -1,7 +1,7 @@ --- title: "Stream data to React (AI, files, progress)" sidebarTitle: "Streaming" -description: "Display AI/LLM output token by token, stream file chunks, or pipe any continuous data from a background task into your React components." +description: "Display AI/LLM output token by token, stream file chunks, or pipe any continuous data from a task into your React components." --- **Display AI responses as they generate, stream file processing results, or pipe any continuous data from a running task into your React components.** Unlike [progress and status hooks](/realtime/react-hooks/subscribe) (which track run state), streaming hooks give you the raw data your task produces while it runs. diff --git a/docs/realtime/react-hooks/subscribe.mdx b/docs/realtime/react-hooks/subscribe.mdx index 5d207ffb358..80ed0e219f8 100644 --- a/docs/realtime/react-hooks/subscribe.mdx +++ b/docs/realtime/react-hooks/subscribe.mdx @@ -1,10 +1,10 @@ --- title: "Run updates in React" sidebarTitle: "Run updates" -description: "Build progress bars, status indicators, and live dashboards by subscribing to background task updates from React components." +description: "Build progress bars, status indicators, and live dashboards by subscribing to run updates from React components." --- -**Subscribe to a run and your component re-renders whenever its status, metadata, or tags change.** Build progress bars, deployment monitors, or any UI that needs to reflect what a background task is doing right now. +**Subscribe to a run and your component re-renders whenever its status, metadata, or tags change.** Build progress bars, deployment monitors, or any UI that needs to reflect what a run is doing right now. For streaming continuous data (AI tokens, file chunks), see [Streaming](/realtime/react-hooks/streams) instead. diff --git a/docs/realtime/react-hooks/triggering.mdx b/docs/realtime/react-hooks/triggering.mdx index ad7513f7cef..dadc9b130ad 100644 --- a/docs/realtime/react-hooks/triggering.mdx +++ b/docs/realtime/react-hooks/triggering.mdx @@ -1,7 +1,7 @@ --- title: "Trigger tasks from React" sidebarTitle: Triggering -description: "Trigger background tasks from React components and optionally subscribe to their progress or stream their output." +description: "Trigger tasks from React components and optionally subscribe to their progress or stream their output." --- Trigger tasks directly from your React components. You can fire-and-forget, or trigger and immediately subscribe to the run's progress or streamed output. diff --git a/docs/replaying.mdx b/docs/replaying.mdx index bd37181aefa..17869292da5 100644 --- a/docs/replaying.mdx +++ b/docs/replaying.mdx @@ -9,14 +9,12 @@ description: "A replay is a copy of a run with the same payload but against the - ![Select a task, then in the bottom right - click "Replay"](/images/replay-run-action.png) + ![The Replay run button in the top right of the run page](/images/replay-run-action.png) You can edit the payload (if available) and choose the environment to replay the run in. - ![Select a task, then in the bottom right - click "Replay"](/images/replay-run-modal.png) + ![The Replay this run dialog with the payload and environment](/images/replay-run-modal.png) diff --git a/docs/self-hosting/docker.mdx b/docs/self-hosting/docker.mdx index 1062a2ea08f..db3b0c28194 100644 --- a/docs/self-hosting/docker.mdx +++ b/docs/self-hosting/docker.mdx @@ -11,20 +11,18 @@ Should the burden ever get too much, we'd be happy to see you on [Trigger.dev cl **Warning:** This guide alone is unlikely to result in a production-ready deployment. Security, scaling, and reliability concerns are not fully addressed here. -## What's new? - -Goodbye v3, hello v4! We made quite a few changes: - -- **Much simpler setup.** The provider and coordinator are now combined into a single supervisor. No more startup scripts, just `docker compose up`. -- **Automatic container cleanup.** The supervisor will automatically clean up containers that are no longer needed. -- **Support for multiple worker machines.** This is a big one, and we're very excited about it! You can now scale your workers horizontally as needed. -- **Resource limits enforced by default.** This means that tasks will be limited to the total CPU and RAM of the machine preset, preventing noisy neighbours. -- **No direct Docker socket access.** The compose file now comes with [Docker Socket Proxy](https://github.com/Tecnativa/docker-socket-proxy) by default. Yes, you want this. -- **No host networking.** All containers are now running with network isolation, using only the network access they need. -- **No checkpoint support.** This was only ever experimental when self-hosting and not recommended. It caused a bunch of issues. We decided to focus on the core features instead. -- **Built-in container registry and object storage.** You can now deploy and execute tasks without needing third party services for this. -- **Improved CLI commands.** You don't need any additional flags to deploy anymore, and there's a new command to easily `switch` between profiles. -- **Whitelisting for GitHub OAuth.** Any whitelisted email addresses will now also apply to sign ins via GitHub, unlike v3 where they only applied to magic links. +## What's included + +- **Single supervisor.** The supervisor manages worker containers, so there are no startup scripts: just `docker compose up`. +- **Automatic container cleanup.** The supervisor cleans up containers that are no longer needed. +- **Multiple worker machines.** You can scale your workers horizontally as needed. +- **Resource limits enforced by default.** Tasks are limited to the total CPU and RAM of their machine preset, preventing noisy neighbours. +- **No direct Docker socket access.** The compose file comes with [Docker Socket Proxy](https://github.com/Tecnativa/docker-socket-proxy) by default. +- **No host networking.** All containers run with network isolation, using only the network access they need. +- **No checkpoint support.** Checkpoints are not available when self-hosting. +- **Built-in container registry and object storage.** You can deploy and execute tasks without third party services for these. +- **Simple CLI setup.** You don't need any additional flags to deploy, and you can `switch` between profiles. +- **Whitelisting for GitHub OAuth.** Whitelisted email addresses apply to sign ins via GitHub as well as magic links. ## Requirements diff --git a/docs/snippets/realtime-examples-cards.mdx b/docs/snippets/realtime-examples-cards.mdx index c7530849452..3a03d80e638 100644 --- a/docs/snippets/realtime-examples-cards.mdx +++ b/docs/snippets/realtime-examples-cards.mdx @@ -1,14 +1,6 @@ ## Examples - - A chatbot using the AI SDK that demonstrates Anthropic Claude 3.7's thinking capabilities through the Realtime API and - react hooks. -