DKP
b96a0b70d4
This pull request overhauls the "Building with AI" documentation section. It includes a comprehensive restructuring of the main building-with-ai page with new setup guides and troubleshooting sections, reorganizes the navigation hierarchy to elevate mcp-agent-rules as a top-level page, and updates multiple documentation pages to clarify the relationships between three AI tools: Skills, Agent Rules, and MCP Server. Changes also include formatting improvements, such as replacing italicized text with inline code formatting, and consistent additions of explanatory Note blocks and CardGroup components across related pages.
133 lines
6.4 KiB
Plaintext
133 lines
6.4 KiB
Plaintext
---
|
|
title: "Agent rules"
|
|
sidebarTitle: "Agent rules"
|
|
description: "Install Trigger.dev agent rules to guide AI assistants toward correct, up-to-date code patterns."
|
|
---
|
|
|
|
## What are Trigger.dev agent rules?
|
|
|
|
Trigger.dev agent rules are comprehensive instruction sets that guide AI assistants to write optimal Trigger.dev code. These rules ensure your AI assistant understands best practices, current APIs, and recommended patterns when working with Trigger.dev projects.
|
|
|
|
<Note>
|
|
Agent Rules are one of three AI tools we provide. You can also install [Skills](/skills) for portable cross-editor instruction sets or the [MCP Server](/mcp-introduction) for live project interaction. See the [comparison table](/building-with-ai#skills-vs-agent-rules-vs-mcp) for details.
|
|
</Note>
|
|
|
|
## Installation
|
|
|
|
Install the agent rules with the following command:
|
|
|
|
```bash
|
|
npx trigger.dev@latest install-rules
|
|
```
|
|
|
|
## Available rule sets
|
|
|
|
We provide five specialized rule sets, each optimized for different aspects of Trigger.dev development:
|
|
|
|
| Rule set | Tokens | Description | GitHub |
|
|
|:---------|:-------|:------------|:------------|
|
|
| **Basic tasks** | 1,200 | Essential rules for writing basic Trigger.dev tasks and fundamental patterns | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/basic-tasks.md) |
|
|
| **Advanced tasks** | 3,000 | Comprehensive rules for complex workflows, error handling, and advanced task patterns | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/advanced-tasks.md) |
|
|
| **Scheduled tasks** | 780 | Specialized guidance for cron jobs, scheduled workflows, and time-based triggers | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/scheduled-tasks.md) |
|
|
| **Configuration** | 1,900 | Complete guide for trigger.config.ts setup, environment configuration, and project structure | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/config.md) |
|
|
| **Realtime** | 1,700 | Using Trigger.dev Realtime features and frontend integration patterns | [View](https://github.com/triggerdotdev/trigger.dev/blob/main/rules/4.0.0/realtime.md) |
|
|
|
|
## Claude Code subagent
|
|
|
|
For Claude Code users, we provide a subagent called `trigger-dev-expert` that's an expert at writing well-structured Trigger.dev code.
|
|
|
|
### Installation
|
|
|
|
The subagent is available as an option when running the rules installation command. Select "Claude Code" as your client and choose to include the subagent when prompted.
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
Activate the subagent in your prompts by requesting it explicitly:
|
|
|
|
```markdown
|
|
use the trigger-dev-expert subagent to create a trigger.dev job that accepts a video url, processes it with ffmpeg to extract the audio, runs the audio through a text-to-speech API like openai, and then uploads both the transcription and the audio to s3
|
|
```
|
|
|
|
The subagent works best when combined with the appropriate rule sets installed alongside it, providing both high-level architectural guidance and detailed implementation knowledge.
|
|
|
|
## Supported AI clients
|
|
|
|
The Trigger.dev rules work across a wide range of AI coding assistants and editors:
|
|
|
|
| Client | Rule activation | Docs |
|
|
|:--------|:----------------|:--------------|
|
|
| **Cursor** | Automatic when working in trigger directories | [Link](https://docs.cursor.com/en/context/rules#rules/) |
|
|
| **Claude Code** | Context-aware activation + custom subagent | [Link](https://docs.anthropic.com/en/docs/claude-code) |
|
|
| **VSCode Copilot** | Integration with GitHub Copilot chat | [Link](https://code.visualstudio.com/docs/copilot/overview) |
|
|
| **Windsurf** | Automatic activation in Trigger.dev projects | [Link](https://docs.windsurf.com/windsurf/cascade/memories#rules) |
|
|
| **Gemini CLI** | Command-line integration | [Link](https://ai.google.dev/gemini-api/docs) |
|
|
| **Cline** | Automatic context detection | [Link](https://github.com/cline/cline) |
|
|
| **Sourcegraph AMP** | Code intelligence integration | [Link](https://sourcegraph.com/docs) |
|
|
| **Kilo** | Custom rule integration | [Link](https://kilocode.ai/docs/advanced-usage/custom-rules) |
|
|
| **Ruler** | Rule management | [Link](https://github.com/intellectronica/ruler) |
|
|
| **AGENTS.md** | Universal format for OpenAI Codex, Jules, OpenCode, etc. | |
|
|
|
|
### Rule activation behavior
|
|
|
|
Different AI tools handle rules differently:
|
|
|
|
- **Automatic Activation**: Cursor, Windsurf, VSCode Copilot, and Cline automatically apply relevant rules when working in Trigger.dev projects or when `trigger.config.ts` is detected
|
|
- **Context-Aware**: Claude Code intelligently applies rules based on the current context and file types
|
|
- **Manual Integration**: AGENTS.md clients and others append rules to configuration files for manual activation
|
|
|
|
## Keeping rules updated
|
|
|
|
Trigger.dev rules are regularly updated to reflect new features, API changes, and best practices. The CLI includes automatic update detection.
|
|
|
|
### Automatic update notifications
|
|
|
|
When running `npx trigger.dev@latest dev`, you'll receive notifications when newer rule versions are available with a simple update command.
|
|
|
|
### Manual updates
|
|
|
|
Update rules anytime with:
|
|
|
|
```bash
|
|
npx trigger.dev@latest install-rules
|
|
```
|
|
|
|
The update process replaces existing rules without creating duplicates, keeping your configuration files clean and organized.
|
|
|
|
### Why updates matter
|
|
|
|
- **Current API patterns**: Access the latest Trigger.dev APIs and features
|
|
- **Performance optimizations**: Benefit from improved patterns and practices
|
|
- **Deprecated pattern avoidance**: Prevent AI assistants from generating outdated code
|
|
- **New feature support**: Immediate access to newly released capabilities
|
|
|
|
## Getting started
|
|
|
|
1. Install the rules:
|
|
|
|
```bash
|
|
npx trigger.dev@latest install-rules
|
|
```
|
|
|
|
2. Follow the prompts to install the rules for your AI client.
|
|
|
|
3. Consider installing the `trigger-dev-expert` subagent if using Claude Code.
|
|
|
|
## Next steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Skills" icon="wand-magic-sparkles" href="/skills">
|
|
Portable instruction sets that work across all AI coding assistants.
|
|
</Card>
|
|
<Card title="MCP Server" icon="sparkles" href="/mcp-introduction">
|
|
Give your AI assistant direct access to Trigger.dev tools and APIs.
|
|
</Card>
|
|
<Card title="Complete AI setup" icon="layer-group" href="/building-with-ai">
|
|
See all AI tools and how they compare.
|
|
</Card>
|
|
<Card title="Writing tasks" icon="code" href="/tasks/overview">
|
|
Learn the task patterns that agent rules teach your AI assistant.
|
|
</Card>
|
|
</CardGroup>
|