nicktrn
8e6eb4f6d8
* lint and action updates * add custom image tag action * remove publish infra bloat * replace cancel action with native concurrency control * ignore all docs changes for release trigger * image action updates * update publish trigger paths * simplify semver checks * make it possible to call publish * add tests for custom action * rename publish workflows * call publish after successful package release * fix inputs and published package parsing * clarify image tag action errors * move test action * add test events * add changesets action mock * add docs checks * add github action test readme * fix docs check on push * update action versions in docs * cache npm for docs check * pretend to fix bad docs link * fix docs link * Revert "fix docs link" This reverts commita7508f5d55. * Revert "Revert "fix docs link"" This reverts commitec642af3dc. * improve caching * disable automatic publishing after release * limit docs checks to pushes to main and PRs * fix broken links * prevent word splitting and globbing * use latest checkout action everywhere * correctly detect prereleases as valid semver * update to latest cache action
54 lines
1.3 KiB
Plaintext
54 lines
1.3 KiB
Plaintext
---
|
|
title: "Quick start"
|
|
description: "How to get started in 3 minutes using 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:
|
|
|
|
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.
|
|
|
|
<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
|
|
|
|
<CardGroup>
|
|
<Card title="How to trigger your tasks" icon="bolt" href="/triggering">
|
|
Learn how to trigger tasks from your code.
|
|
</Card>
|
|
<Card title="Writing tasks" icon="wand-magic-sparkles" href="/tasks/overview">
|
|
Tasks are the core of Trigger.dev. Learn what they are and how to write them.
|
|
</Card>
|
|
</CardGroup>
|