Skip to content

Commit 5f359a4

Browse files
carderneTrigger.dev RepoOps
authored andcommitted
docs: add copyable agent setup prompts
Replace the quick-start's inline onboarding procedure with a copyable prompt that points to the canonical Trigger.dev setup skill. Add the same prompt to the docs introduction, with an explanation of the setup flow and a link to inspect the full instructions. Use Mintlify's native code-block copy control and preserve the quick-start's `#copy-the-setup-prompt` anchor. Mono-RevId: 251048e2a4f643e9bc255ab33fb7fa2daebf3d5a
1 parent f3d9d79 commit 5f359a4

3 files changed

Lines changed: 18 additions & 40 deletions

File tree

‎docs/introduction.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: "Build and run durable AI agents and workflows in TypeScript. Long-
55
mode: "center"
66
---
77

8+
import AgentSetupPrompt from "/snippets/agent-setup-prompt.mdx";
9+
810
<CardGroup cols={2}>
911
<Card title="Quick start" icon="rocket" href="/quick-start" color="#A8FF53">
1012
Go from zero to your first task in 3 minutes.
@@ -20,6 +22,10 @@ mode: "center"
2022
</Card>
2123
</CardGroup>
2224

25+
## Set up with AI
26+
27+
<AgentSetupPrompt />
28+
2329
## What is Trigger.dev?
2430

2531
Trigger.dev is the open source platform for building and running durable AI agents and workflows in TypeScript. Run them for hours, configure automatic retries, control concurrency, and manage queues. There's no execution timeout, and no queue or worker infrastructure for you to build.

‎docs/quick-start.mdx‎

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,48 +8,11 @@ import CliInitStep from "/snippets/step-cli-init.mdx";
88
import CliDevStep from "/snippets/step-cli-dev.mdx";
99
import CliRunTestStep from "/snippets/step-run-test.mdx";
1010
import CliViewRunStep from "/snippets/step-view-run.mdx";
11+
import AgentSetupPrompt from "/snippets/agent-setup-prompt.mdx";
1112

12-
## Set up with AI
13+
## Copy the setup prompt
1314

14-
Using an AI coding assistant? Copy this prompt and paste it into Claude Code, Cursor, Copilot, Windsurf, or any AI tool. It'll handle the setup for you.
15-
16-
<Accordion title="Copy the setup prompt">
17-
18-
```text
19-
Help me add Trigger.dev to this project.
20-
21-
## What to do
22-
23-
1. I need a Trigger.dev account. If I don't have one, point me to https://cloud.trigger.dev to sign up. Wait for me to confirm.
24-
2. Run `npx trigger.dev@latest init` in the project root.
25-
- When it asks about the MCP server, recommend I install it (best DX: gives you direct access to Trigger.dev docs, deploys, and run monitoring).
26-
- Install the "Hello World" example task when prompted.
27-
3. Run `npx trigger.dev@latest dev` to start the dev server.
28-
4. Once the dev server is running, test the example task from the Trigger.dev dashboard.
29-
5. Create a named API key in my Development environment with **Trigger only** access. Set it as TRIGGER_SECRET_KEY in my .env file (or .env.local for Next.js).
30-
6. Ask me what framework I'm using and show me how to trigger the task from my backend code.
31-
32-
If I've already run init and want the MCP server, run: npx trigger.dev@latest install-mcp
33-
34-
## Critical rules
35-
36-
- ALWAYS import from `@trigger.dev/sdk`. NEVER import from `@trigger.dev/sdk/v3`.
37-
- NEVER use `client.defineJob()` — that's the deprecated v2 API.
38-
- Use type-only imports when triggering from backend code to avoid bundling task code:
39-
40-
import type { myTask } from "./trigger/example";
41-
import { tasks } from "@trigger.dev/sdk";
42-
43-
const handle = await tasks.trigger<typeof myTask>("hello-world", { message: "Hello from my app!" });
44-
45-
## When done, point me to
46-
47-
- Writing tasks: https://trigger.dev/docs/tasks/overview
48-
- Real-time updates: https://trigger.dev/docs/realtime/overview
49-
- AI tooling: https://trigger.dev/docs/building-with-ai
50-
```
51-
52-
</Accordion>
15+
<AgentSetupPrompt />
5316

5417
## Manual setup
5518

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Copy this prompt into your AI coding assistant from your app's directory:
2+
3+
```text
4+
Bootstrap a Trigger.dev project: trigger.dev/SKILL.md
5+
```
6+
7+
Your agent guides you through login, choosing or creating an organization and project, and running your first task locally. You authorize login yourself, and the agent asks when a choice is ambiguous.
8+
9+
[Read the full setup instructions](https://trigger.dev/SKILL.md) before running.

0 commit comments

Comments
 (0)