agentleFS
triggerdotdevtriggerdotdev/trigger.dev/docs/AGENTS.md

trigger.dev

AGENTS.md17k starsChanged 3 months agoApache-2.0View on GitHub

Mintlify-based documentation site for Trigger.dev. Pages are MDX files. Frontmatter format: Use these components for structured content:

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Create the MDX file in the appropriate directory

    line 24
  2. Very specific:

    Add the page path to docs.json navigation (under the correct group)

    line 25
  3. Distinctive:

    Use these components for structured content:

    line 29
  4. Very specific:

    Always import from @trigger.dev/sdk (never @trigger.dev/sdk/v3)

    line 42
  5. Very specific:

    Use language tags in code fences: typescript, bash, json

    line 44

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Documentation

Mintlify-based documentation site for Trigger.dev.

Configuration

  • Main config: docs.json - defines navigation, theme, metadata
  • Navigation structure: docs.json -> navigation.dropdowns -> groups -> pages

Writing Docs

Pages are MDX files. Frontmatter format:

---
title: "Page Title"
description: "Brief description for SEO and previews"
sidebarTitle: "Short Title"  # Optional, shown in sidebar if different from title
---

Adding a New Page

  1. Create the MDX file in the appropriate directory
  2. Add the page path to docs.json navigation (under the correct group)

Mintlify Components

Use these components for structured content:

  • <Note> - General notes
  • <Warning> - Important warnings
  • <Info> - Informational callouts
  • <Tip> - Helpful tips
  • <CodeGroup> - Multi-language/multi-file code examples
  • <Expandable> - Collapsible content sections
  • <Steps> / <Step> - Step-by-step instructions
  • <Card> / <CardGroup> - Card layouts for navigation

Code Examples

  • Always import from @trigger.dev/sdk (never @trigger.dev/sdk/v3)
  • Make code examples complete and runnable where possible
  • Use language tags in code fences: typescript, bash, json

Directory Structure

  • documentation/ - Core conceptual docs
  • guides/ - How-to guides
  • config/ - Configuration reference
  • deployment/ - Deployment guides
  • tasks/ - Task documentation
  • realtime/ - Real-time features
  • runs/ - Run management
  • images/ - Image assets

Download now (ZIP)

Trending

Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data

Week of Aug 30: 0 new projectsWeek of Sep 6: 0 new projectsWeek of Sep 13: 0 new projectsWeek of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projects
Aug 2026Sep 2026Oct 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 0 in all, so this is a hint, not a trend.

Who's talking about triggerdotdev/trigger.dev

The biggest 5 of 73 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 73

Talked about on GitHub, YouTube, Bluesky and the web (73 times).

On GitHub · 50

45 more on GitHub

On YouTube · 11

6 more on YouTube

On Bluesky · 10

5 more on Bluesky

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.