Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 26 additions & 28 deletions docs/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,44 +1,42 @@
---
title: "Quick start"
description: "How to get started in 3 minutes using the CLI and SDK."
description: "How to quickly get started using an AI coding assistant or the CLI and SDK."
---

import CliInitStep from '/snippets/step-cli-init.mdx';
import CliDevStep from '/snippets/step-cli-dev.mdx';
import CliRunTestStep from '/snippets/step-run-test.mdx';
import CliViewRunStep from '/snippets/step-view-run.mdx';

In this guide we will:
<Accordion title="Using an AI coding assistant? Copy this prompt to get started." icon="sparkles">

1. Create a `trigger.config.ts` file and a `/trigger` directory with an example task.
2. Get you to run the task using the CLI.
3. Show you how to view the run logs for that task.
```txt
Add Trigger.dev to my project.

<Steps titleSize="h3">

<Step title="Create a Trigger.dev account">

You can either:

- Use the [Trigger.dev Cloud](https://cloud.trigger.dev).
- Or [self-host](/open-source-self-hosting) the service.

</Step>
- Before each step, briefly explain what it does
- Keep me on track until I've successfully triggered my first task
- Show me the results when we're done
```

<Step title="Create your first project">

Once you've created an account, follow the steps in the app to:

1. Complete your account details.
2. Create your first Organization and Project.

</Step>

<CliInitStep />
<CliDevStep />
<CliRunTestStep />
<CliViewRunStep />
</Accordion>

<Steps titleSize="h3">
<Step title="Create a Trigger.dev account">
You can either:
- Use the [Trigger.dev Cloud](https://cloud.trigger.dev).
- Or [self-host](/open-source-self-hosting) the service.
</Step>

<Step title="Create your first project">
Once you've created an account, follow the steps in the app to:
1. Complete your account details.
2. Create your first Organization and Project.
</Step>

<CliInitStep />
<CliDevStep />
<CliRunTestStep />
<CliViewRunStep />
</Steps>

## Next steps
Expand Down
13 changes: 9 additions & 4 deletions docs/snippets/step-cli-init.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<Step title="Run the CLI `init` command">

The easiest way to get started is to use the CLI. It will add Trigger.dev to your existing project, create a `/trigger` folder and give you an example task.

Run this command in the root of your project to get started:
Run this command in the root of your project:

<CodeGroup>

Expand All @@ -20,7 +18,14 @@ yarn dlx trigger.dev@latest init

</CodeGroup>

It will do a few things:
You'll be asked to choose how to initialize:

- **Trigger.dev MCP** Installs our [MCP server](/mcp-overview) into your AI coding tools (Claude Code, Cursor, etc.), then lets your AI assistant set up the project for you.
- **CLI** — Continue with the traditional CLI setup.

<Note> The Trigger.dev [MCP](/mcp-overview) lets AI assistants search docs, create and manage projects, trigger and deploy tasks, and monitor runs across environments, we recommend using it for the best developer experience.</Note>

If you choose CLI, it will:

1. Log you into the CLI if you're not already logged in.
2. Create a `trigger.config.ts` file in the root of your project.
Expand Down
Loading