From d36b7cba6c542638f5751346239b44c576f2b38a Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:18:43 +0100 Subject: [PATCH 1/7] readme wip --- packages/trigger-sdk/README.md | 254 +++++++++++++++++++++++++++++++-- 1 file changed, 240 insertions(+), 14 deletions(-) diff --git a/packages/trigger-sdk/README.md b/packages/trigger-sdk/README.md index c53b5cb906..c4a2679eeb 100644 --- a/packages/trigger-sdk/README.md +++ b/packages/trigger-sdk/README.md @@ -4,31 +4,257 @@ Trigger.dev logo - -### Open source background jobs with no timeouts -[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs) +# Official TypeScript SDK for Trigger.dev + +### 🤖 TypeScript SDK for building AI agents & workflows -[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev) +[![npm version](https://img.shields.io/npm/v/@trigger.dev/sdk.svg)](https://www.npmjs.com/package/@trigger.dev/sdk) +[![npm downloads](https://img.shields.io/npm/dm/@trigger.dev/sdk.svg)](https://www.npmjs.com/package/@trigger.dev/sdk) +[![GitHub stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social)](https://github.com/triggerdotdev/trigger.dev) +[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Open Source](https://img.shields.io/badge/Open%20Source-%E2%9D%A4-red)](https://github.com/triggerdotdev/trigger.dev) + +[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs) | [Examples](https://trigger.dev/docs/examples) -# Official TypeScript SDK for Trigger.dev +The **Trigger.dev SDK** enables you to create reliable, long-running AI agents and workflows in your TypeScript applications. Connect to the Trigger.dev platform (cloud or self-hosted) to execute jobs without timeouts, with built-in retries and monitoring. + +## ✨ What you get with this SDK + +- **Write normal async code** - No special syntax, just regular TypeScript functions +- **No timeouts** - Tasks can run for hours or days without failing +- **Built-in reliability** - Automatic retries, error handling, and durable execution +- **Real-time observability** - Watch your tasks execute with full OpenTelemetry tracing +- **Local development** - Test and debug tasks locally with the same environment +- **Checkpoint-resume system** - Efficient resource usage with automatic state management +- **50+ integrations** - Pre-built connectors for AI, databases, and external services +- **Framework agnostic** - Works with Next.js, Express, Fastify, Remix, and more + +## 🚀 Quick Start + +### Installation + +```bash +npm install @trigger.dev/sdk +# or +yarn add @trigger.dev/sdk +# or +pnpm add @trigger.dev/sdk +``` + +### Basic Usage + +```typescript +import { TriggerClient, eventTrigger } from "@trigger.dev/sdk"; + +const client = new TriggerClient({ + id: "my-app", + apiKey: process.env.TRIGGER_API_KEY!, +}); + +// Define a background task - just normal async code +export const generateContent = task({ + id: "generate-content", + retry: { + maxAttempts: 3, + }, + run: async ({ theme, description }: { theme: string; description: string }) => { + // Generate text with OpenAI + const textResult = await openai.chat.completions.create({ + model: "gpt-4o", + messages: [{ role: "user", content: `Create content about ${theme}: ${description}` }], + }); + + if (!textResult.choices[0]) { + throw new Error("No content generated, retrying..."); + } + + // Generate an image + const imageResult = await openai.images.generate({ + model: "dall-e-3", + prompt: `Create an image for: ${theme}`, + }); + + if (!imageResult.data[0]) { + throw new Error("No image generated, retrying..."); + } + + return { + text: textResult.choices[0].message.content, + image: imageResult.data[0].url, + }; + }, +}); + +// Trigger the task from your app +import { tasks } from "@trigger.dev/sdk/v3"; + +const handle = await tasks.trigger("generate-content", { + theme: "AI automation", + description: "How AI is transforming business workflows", +}); +``` + +### Scheduled Tasks & Workflows + +```typescript +import { schedules } from "@trigger.dev/sdk/v3"; + +// Scheduled task - runs every Monday at 9 AM +export const weeklyReport = schedules.task({ + id: "weekly-report", + cron: "0 9 * * MON", + run: async () => { + // Multi-step workflow with automatic retries + const data = await analyzeMetrics.triggerAndWait({ + timeframe: "week", + }); + + const report = await generateReport.triggerAndWait({ + data: data.output, + format: "pdf", + }); + + // Send to team - runs in parallel + await Promise.all([ + sendEmail.trigger({ + to: "team@company.com", + subject: "Weekly Report", + attachment: report.output.url, + }), + uploadToS3.trigger({ + file: report.output, + bucket: "reports", + }), + ]); + + return { success: true, reportId: report.output.id }; + }, +}); +``` + +## 📚 Documentation + +- **[Getting Started Guide](https://trigger.dev/docs/introduction)** - Complete setup walkthrough +- **[API Reference](https://trigger.dev/docs/sdk/introduction)** - Detailed API documentation +- **[Examples](https://trigger.dev/docs/examples)** - Real-world examples and use cases +- **[Integrations](https://trigger.dev/docs/integrations)** - Pre-built integrations catalog +- **[Best Practices](https://trigger.dev/docs/guides/best-practices)** - Production tips and patterns -The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project. +## 🔧 Framework Support -## About +Trigger.dev works seamlessly with popular frameworks: -Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs. Write normal async code, deploy, and never hit a timeout. +- **[Next.js](https://trigger.dev/docs/guides/frameworks/nextjs)** - App Router and Pages Router +- **[Express](https://trigger.dev/docs/guides/frameworks/express)** - Traditional Node.js apps +- **[Fastify](https://trigger.dev/docs/guides/frameworks/fastify)** - High-performance web framework +- **[Remix](https://trigger.dev/docs/guides/frameworks/remix)** - Full-stack web framework +- **[NestJS](https://trigger.dev/docs/guides/frameworks/nestjs)** - Enterprise Node.js framework -## Getting started +## 🧩 Popular Integrations -The quickest way to get started is to create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes. +```typescript +// Use any npm package - no special integrations needed +import OpenAI from "openai"; +import { PrismaClient } from "@prisma/client"; +import { Resend } from "resend"; -## SDK usage +export const processWithAI = task({ + id: "process-with-ai", + run: async ({ input }: { input: string }) => { + // OpenAI + const openai = new OpenAI(); + const completion = await openai.chat.completions.create({ + model: "gpt-4o", + messages: [{ role: "user", content: input }], + }); -For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction). + // Database + const prisma = new PrismaClient(); + await prisma.result.create({ + data: { content: completion.choices[0].message.content }, + }); -## Support + // Email + const resend = new Resend(); + await resend.emails.send({ + from: "noreply@example.com", + to: "user@example.com", + subject: "Processing Complete", + text: completion.choices[0].message.content, + }); -If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help. + return { success: true }; + }, +}); +``` + +## 🏃‍♂️ Getting Started + +### 1. Install the SDK + +```bash +npm install @trigger.dev/sdk +``` + +### 2. Set up your project + +```bash +npx @trigger.dev/cli@latest init +``` + +### 3. Connect to Trigger.dev + +Choose your deployment option: + +- **[Trigger.dev Cloud](https://cloud.trigger.dev)** - Managed service (recommended) +- **[Self-hosted](https://trigger.dev/docs/self-hosting)** - Deploy on your infrastructure + +### 4. Deploy your jobs + +```bash +npx @trigger.dev/cli@latest deploy +``` + +Or follow our comprehensive [Getting Started Guide](https://trigger.dev/docs/introduction). + +## 💡 Example Tasks + +Check out our [examples repository](https://github.com/triggerdotdev/trigger.dev/tree/main/examples) for production-ready workflows: + +- [AI agents & workflows](https://trigger.dev/docs/examples) - Build invincible AI agents with tools and memory +- [Video processing with FFmpeg](https://trigger.dev/docs/examples/ffmpeg) - Process videos without timeouts +- [PDF generation & processing](https://trigger.dev/docs/examples) - Convert documents at scale +- [Email campaigns](https://trigger.dev/docs/examples) - Multi-step email automation +- [Data pipelines](https://trigger.dev/docs/examples) - ETL processes and database sync +- [Web scraping](https://trigger.dev/docs/examples) - Scrape websites with Puppeteer + +## 🤝 Community & Support + +- **[Discord Community](https://trigger.dev/discord)** - Get help and share ideas +- **[GitHub Issues](https://github.com/triggerdotdev/trigger.dev/issues)** - Bug reports and feature requests +- **[Twitter](https://twitter.com/triggerdotdev)** - Latest updates and news +- **[Blog](https://trigger.dev/blog)** - Tutorials and best practices + +## 📦 Related Packages + +- **[@trigger.dev/cli](https://www.npmjs.com/package/@trigger.dev/cli)** - Command line interface +- **[@trigger.dev/react-hooks](https://www.npmjs.com/package/@trigger.dev/react-hooks)** - React hooks for real-time job monitoring +- **[@trigger.dev/nextjs](https://www.npmjs.com/package/@trigger.dev/nextjs)** - Next.js specific utilities + +## 📄 License + +MIT License - see the [LICENSE](https://github.com/triggerdotdev/trigger.dev/blob/main/LICENSE) file for details. + +## ⭐ Contributing + +We love contributions! Please see our [Contributing Guide](https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md) for details on how to get started. + +--- + +
+ Built with ❤️ by the Trigger.dev team +
From 79e38e0db4622da8f0b31c9a0869e858d5f46217 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:28:30 +0100 Subject: [PATCH 2/7] Added new commands --- packages/cli-v3/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/cli-v3/README.md b/packages/cli-v3/README.md index d7fba79d54..c2c47f5be1 100644 --- a/packages/cli-v3/README.md +++ b/packages/cli-v3/README.md @@ -17,6 +17,9 @@ Trigger.dev is an open source platform that makes it easy to create event-driven | [whoami](https://trigger.dev/docs/cli-whoami-commands) | Display the current logged in user and project details. | | [logout](https://trigger.dev/docs/cli-logout-commands) | Logout of Trigger.dev. | | [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles. | +| [preview archive](https://trigger.dev/docs/cli-preview-archive) | Archive a preview branch. | +| [promote](https://trigger.dev/docs/cli-promote-commands) | Promote a previously deployed version to the current version. | +| [switch](https://trigger.dev/docs/cli-switch) | Switch between CLI profiles. | | [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. | ## MCP Server From e9d0b259ddc6bbf307743e9ff80318fb39f22071 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:37:41 +0100 Subject: [PATCH 3/7] Simplified readme --- packages/trigger-sdk/README.md | 243 ++------------------------------- 1 file changed, 10 insertions(+), 233 deletions(-) diff --git a/packages/trigger-sdk/README.md b/packages/trigger-sdk/README.md index c4a2679eeb..a82ace1755 100644 --- a/packages/trigger-sdk/README.md +++ b/packages/trigger-sdk/README.md @@ -5,10 +5,6 @@ Trigger.dev logo -# Official TypeScript SDK for Trigger.dev - -### 🤖 TypeScript SDK for building AI agents & workflows - [![npm version](https://img.shields.io/npm/v/@trigger.dev/sdk.svg)](https://www.npmjs.com/package/@trigger.dev/sdk) [![npm downloads](https://img.shields.io/npm/dm/@trigger.dev/sdk.svg)](https://www.npmjs.com/package/@trigger.dev/sdk) [![GitHub stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social)](https://github.com/triggerdotdev/trigger.dev) @@ -20,241 +16,22 @@ -The **Trigger.dev SDK** enables you to create reliable, long-running AI agents and workflows in your TypeScript applications. Connect to the Trigger.dev platform (cloud or self-hosted) to execute jobs without timeouts, with built-in retries and monitoring. - -## ✨ What you get with this SDK - -- **Write normal async code** - No special syntax, just regular TypeScript functions -- **No timeouts** - Tasks can run for hours or days without failing -- **Built-in reliability** - Automatic retries, error handling, and durable execution -- **Real-time observability** - Watch your tasks execute with full OpenTelemetry tracing -- **Local development** - Test and debug tasks locally with the same environment -- **Checkpoint-resume system** - Efficient resource usage with automatic state management -- **50+ integrations** - Pre-built connectors for AI, databases, and external services -- **Framework agnostic** - Works with Next.js, Express, Fastify, Remix, and more - -## 🚀 Quick Start - -### Installation - -```bash -npm install @trigger.dev/sdk -# or -yarn add @trigger.dev/sdk -# or -pnpm add @trigger.dev/sdk -``` - -### Basic Usage - -```typescript -import { TriggerClient, eventTrigger } from "@trigger.dev/sdk"; - -const client = new TriggerClient({ - id: "my-app", - apiKey: process.env.TRIGGER_API_KEY!, -}); - -// Define a background task - just normal async code -export const generateContent = task({ - id: "generate-content", - retry: { - maxAttempts: 3, - }, - run: async ({ theme, description }: { theme: string; description: string }) => { - // Generate text with OpenAI - const textResult = await openai.chat.completions.create({ - model: "gpt-4o", - messages: [{ role: "user", content: `Create content about ${theme}: ${description}` }], - }); - - if (!textResult.choices[0]) { - throw new Error("No content generated, retrying..."); - } - - // Generate an image - const imageResult = await openai.images.generate({ - model: "dall-e-3", - prompt: `Create an image for: ${theme}`, - }); - - if (!imageResult.data[0]) { - throw new Error("No image generated, retrying..."); - } - - return { - text: textResult.choices[0].message.content, - image: imageResult.data[0].url, - }; - }, -}); - -// Trigger the task from your app -import { tasks } from "@trigger.dev/sdk/v3"; - -const handle = await tasks.trigger("generate-content", { - theme: "AI automation", - description: "How AI is transforming business workflows", -}); -``` - -### Scheduled Tasks & Workflows - -```typescript -import { schedules } from "@trigger.dev/sdk/v3"; - -// Scheduled task - runs every Monday at 9 AM -export const weeklyReport = schedules.task({ - id: "weekly-report", - cron: "0 9 * * MON", - run: async () => { - // Multi-step workflow with automatic retries - const data = await analyzeMetrics.triggerAndWait({ - timeframe: "week", - }); - - const report = await generateReport.triggerAndWait({ - data: data.output, - format: "pdf", - }); - - // Send to team - runs in parallel - await Promise.all([ - sendEmail.trigger({ - to: "team@company.com", - subject: "Weekly Report", - attachment: report.output.url, - }), - uploadToS3.trigger({ - file: report.output, - bucket: "reports", - }), - ]); - - return { success: true, reportId: report.output.id }; - }, -}); -``` - -## 📚 Documentation - -- **[Getting Started Guide](https://trigger.dev/docs/introduction)** - Complete setup walkthrough -- **[API Reference](https://trigger.dev/docs/sdk/introduction)** - Detailed API documentation -- **[Examples](https://trigger.dev/docs/examples)** - Real-world examples and use cases -- **[Integrations](https://trigger.dev/docs/integrations)** - Pre-built integrations catalog -- **[Best Practices](https://trigger.dev/docs/guides/best-practices)** - Production tips and patterns - -## 🔧 Framework Support - -Trigger.dev works seamlessly with popular frameworks: - -- **[Next.js](https://trigger.dev/docs/guides/frameworks/nextjs)** - App Router and Pages Router -- **[Express](https://trigger.dev/docs/guides/frameworks/express)** - Traditional Node.js apps -- **[Fastify](https://trigger.dev/docs/guides/frameworks/fastify)** - High-performance web framework -- **[Remix](https://trigger.dev/docs/guides/frameworks/remix)** - Full-stack web framework -- **[NestJS](https://trigger.dev/docs/guides/frameworks/nestjs)** - Enterprise Node.js framework - -## 🧩 Popular Integrations - -```typescript -// Use any npm package - no special integrations needed -import OpenAI from "openai"; -import { PrismaClient } from "@prisma/client"; -import { Resend } from "resend"; - -export const processWithAI = task({ - id: "process-with-ai", - run: async ({ input }: { input: string }) => { - // OpenAI - const openai = new OpenAI(); - const completion = await openai.chat.completions.create({ - model: "gpt-4o", - messages: [{ role: "user", content: input }], - }); - - // Database - const prisma = new PrismaClient(); - await prisma.result.create({ - data: { content: completion.choices[0].message.content }, - }); - - // Email - const resend = new Resend(); - await resend.emails.send({ - from: "noreply@example.com", - to: "user@example.com", - subject: "Processing Complete", - text: completion.choices[0].message.content, - }); - - return { success: true }; - }, -}); -``` - -## 🏃‍♂️ Getting Started - -### 1. Install the SDK - -```bash -npm install @trigger.dev/sdk -``` - -### 2. Set up your project - -```bash -npx @trigger.dev/cli@latest init -``` - -### 3. Connect to Trigger.dev - -Choose your deployment option: - -- **[Trigger.dev Cloud](https://cloud.trigger.dev)** - Managed service (recommended) -- **[Self-hosted](https://trigger.dev/docs/self-hosting)** - Deploy on your infrastructure - -### 4. Deploy your jobs - -```bash -npx @trigger.dev/cli@latest deploy -``` - -Or follow our comprehensive [Getting Started Guide](https://trigger.dev/docs/introduction). - -## 💡 Example Tasks - -Check out our [examples repository](https://github.com/triggerdotdev/trigger.dev/tree/main/examples) for production-ready workflows: - -- [AI agents & workflows](https://trigger.dev/docs/examples) - Build invincible AI agents with tools and memory -- [Video processing with FFmpeg](https://trigger.dev/docs/examples/ffmpeg) - Process videos without timeouts -- [PDF generation & processing](https://trigger.dev/docs/examples) - Convert documents at scale -- [Email campaigns](https://trigger.dev/docs/examples) - Multi-step email automation -- [Data pipelines](https://trigger.dev/docs/examples) - ETL processes and database sync -- [Web scraping](https://trigger.dev/docs/examples) - Scrape websites with Puppeteer - -## 🤝 Community & Support +# Official TypeScript SDK for Trigger.dev -- **[Discord Community](https://trigger.dev/discord)** - Get help and share ideas -- **[GitHub Issues](https://github.com/triggerdotdev/trigger.dev/issues)** - Bug reports and feature requests -- **[Twitter](https://twitter.com/triggerdotdev)** - Latest updates and news -- **[Blog](https://trigger.dev/blog)** - Tutorials and best practices +The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project. -## 📦 Related Packages +## About Trigger.dev -- **[@trigger.dev/cli](https://www.npmjs.com/package/@trigger.dev/cli)** - Command line interface -- **[@trigger.dev/react-hooks](https://www.npmjs.com/package/@trigger.dev/react-hooks)** - React hooks for real-time job monitoring -- **[@trigger.dev/nextjs](https://www.npmjs.com/package/@trigger.dev/nextjs)** - Next.js specific utilities +Trigger.dev is a platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling. -## 📄 License +## Getting started -MIT License - see the [LICENSE](https://github.com/triggerdotdev/trigger.dev/blob/main/LICENSE) file for details. +The quickest way to get started is to create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes. -## ⭐ Contributing +## SDK usage -We love contributions! Please see our [Contributing Guide](https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md) for details on how to get started. +For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction). ---- +## Support -
- Built with ❤️ by the Trigger.dev team -
+If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help. From 7424e1a19db143499d9f2be042681bce19d0bdd3 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:46:55 +0100 Subject: [PATCH 4/7] Added docs links and improved about --- packages/cli-v3/README.md | 35 +++++----------------------------- packages/trigger-sdk/README.md | 23 +++++++++++++++++++--- 2 files changed, 25 insertions(+), 33 deletions(-) diff --git a/packages/cli-v3/README.md b/packages/cli-v3/README.md index c2c47f5be1..2925e600e4 100644 --- a/packages/cli-v3/README.md +++ b/packages/cli-v3/README.md @@ -4,7 +4,9 @@ A CLI that allows you to create, run locally and deploy Trigger.dev background t Note: this only works with Trigger.dev v3 projects and later. For older projects use the [@trigger.dev/cli](https://www.npmjs.com/package/@trigger.dev/cli) package. -Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project. +## About Trigger.dev + +Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling. ## Commands @@ -22,36 +24,9 @@ Trigger.dev is an open source platform that makes it easy to create event-driven | [switch](https://trigger.dev/docs/cli-switch) | Switch between CLI profiles. | | [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. | -## MCP Server - -The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that allows you to provide custom tools -to agentic LLM clients, like [Claude for Desktop](https://docs.anthropic.com/en/docs/claude-for-desktop/overview), [Cursor](https://www.cursor.com/), [Windsurf](https://windsurf.com/), etc... - -The Trigger.dev CLI can expose an MCP server and enable you interact with Trigger.dev in agentic LLM workflows. For example, you can use -it to trigger tasks via natural language, view task runs, view logs, debug issues with task runs, etc... - -### Starting the Trigger.dev MCP Server - -To start the Trigger.dev MCP server, simply pass the `--mcp` flag to the `dev` command: - -```bash -trigger dev --mcp -``` - -By default it runs on port `3333`. You can change this by passing the `--mcp-port` flag: - -```bash -trigger dev --mcp --mcp-port 3334 -``` - -### Configuring your MCP client - -This depends on what tool you are using. For Cursor, the configuration is in the [.cursor/mcp.json](../../.cursor/mcp.json) file -and should be good to go as long as you use the default MCP server port. - -Check out [Cursor's docs](https://docs.cursor.com/context/model-context-protocol) for further details. +## Documentation -Tip: try out [Cursor's YOLO mode](https://docs.cursor.com/context/model-context-protocol#yolo-mode) for a seamless experience :D +For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction). ## Support diff --git a/packages/trigger-sdk/README.md b/packages/trigger-sdk/README.md index a82ace1755..e4f5bd552c 100644 --- a/packages/trigger-sdk/README.md +++ b/packages/trigger-sdk/README.md @@ -18,15 +18,32 @@ # Official TypeScript SDK for Trigger.dev -The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project. +The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your projects. ## About Trigger.dev -Trigger.dev is a platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling. +Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling. + +## Core features + +- Task creation and execution +- CLI for development and deployment +- Build system with extensions +- Management API for runs, schedules, and environment variables + +## Key Components: + +- Tasks: Background jobs written in TypeScript/JavaScript +- CLI: Commands for login, init, dev, deploy +- Build Extensions: Customize builds (Prisma, Python, FFmpeg, etc.) +- Management API: Programmatic control over runs and resources ## Getting started -The quickest way to get started is to create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes. +There are two ways to get started: + +1. Create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes. +2. [Manual setup](https://trigger.dev/docs/manual-setup) in your existing project. ## SDK usage From f24952e8c7d4c6b7049152ae1f568d5dcec2bda9 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:54:24 +0100 Subject: [PATCH 5/7] Added nice header and updated links --- packages/cli-v3/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/packages/cli-v3/README.md b/packages/cli-v3/README.md index 2925e600e4..d19bd6d99f 100644 --- a/packages/cli-v3/README.md +++ b/packages/cli-v3/README.md @@ -1,3 +1,21 @@ +
+ + + + Trigger.dev logo + + +[![npm version](https://img.shields.io/npm/v/trigger.dev.svg)](https://www.npmjs.com/package/trigger.dev) +[![npm downloads](https://img.shields.io/npm/dm/trigger.dev.svg)](https://www.npmjs.com/package/trigger.dev) +[![GitHub stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social)](https://github.com/triggerdotdev/trigger.dev) +[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/) +[![License: ](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Open Source](https://img.shields.io/badge/Open%20Source-%E2%9D%A4-red)](https://github.com/triggerdotdev/trigger.dev) + +[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs) | [Examples](https://trigger.dev/docs/examples) + +
+ # Trigger.dev CLI A CLI that allows you to create, run locally and deploy Trigger.dev background tasks. From 1c6859dcac40d2fe3d48254f9c7352c0c66a359b Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 11:55:10 +0100 Subject: [PATCH 6/7] Consistent headers --- packages/cli-v3/README.md | 2 +- packages/trigger-sdk/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/cli-v3/README.md b/packages/cli-v3/README.md index d19bd6d99f..2cf2af2880 100644 --- a/packages/cli-v3/README.md +++ b/packages/cli-v3/README.md @@ -42,7 +42,7 @@ Trigger.dev is an open source platform for building and deploying fully-managed | [switch](https://trigger.dev/docs/cli-switch) | Switch between CLI profiles. | | [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. | -## Documentation +## CLI documentation For more information on the CLI, please refer to our [docs](https://trigger.dev/docs/cli-introduction). diff --git a/packages/trigger-sdk/README.md b/packages/trigger-sdk/README.md index e4f5bd552c..01286594c0 100644 --- a/packages/trigger-sdk/README.md +++ b/packages/trigger-sdk/README.md @@ -45,7 +45,7 @@ There are two ways to get started: 1. Create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes. 2. [Manual setup](https://trigger.dev/docs/manual-setup) in your existing project. -## SDK usage +## SDK documentation For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction). From fa2ac90ef04ab13908b84e08c7ade591913119db Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:03:40 +0100 Subject: [PATCH 7/7] Copy update --- packages/cli-v3/README.md | 2 +- packages/trigger-sdk/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/cli-v3/README.md b/packages/cli-v3/README.md index 2cf2af2880..84fc2a7911 100644 --- a/packages/cli-v3/README.md +++ b/packages/cli-v3/README.md @@ -24,7 +24,7 @@ Note: this only works with Trigger.dev v3 projects and later. For older projects ## About Trigger.dev -Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling. +Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with full observability, managed queues, and elastic infrastructure which handles the horizontal scaling. ## Commands diff --git a/packages/trigger-sdk/README.md b/packages/trigger-sdk/README.md index 01286594c0..f82b525095 100644 --- a/packages/trigger-sdk/README.md +++ b/packages/trigger-sdk/README.md @@ -22,7 +22,7 @@ The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define ## About Trigger.dev -Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with trace visibility, managed queues, and elastic infrastructure which handles the horizontal scaling. +Trigger.dev is an open source platform for building and deploying fully-managed AI agents and workflows. Write workflows in normal async TypeScript for everything from simple tasks to long-running AI agents, heavy media processing, complex real-time systems and more. Complete with full observability, managed queues, and elastic infrastructure which handles the horizontal scaling. ## Core features