Eric Allam
cf13fbdf32
* Add triggerAndWait().unwrap() to more easily get at the output or throw the subtask error * Add taskId and runId to SubtaskUnwrapError * WIP docs update beta -> latest * trigger.dev init now adds @trigger.dev/build to devDependencies * How it works doc * Restructure some docs and update the cli commands * Config file docs, plus aptGet and ffmpeg extensions * Update to latest from beta docs * Add runtime to templates * Add --runtime option to the init CLI command * A bunch more doc updates after feedback * Document triggerAndWait with unwrap and result types * beta -> latest in the webapp * CLI update check no longer references beta * Add major release * Leave changeset beta, back to normal package release * Fixed default dirs option in init command * exclude windows-yarn variation of cli e2e tests because it’s buggy * Remove cache to try and fix yarn e2e test workflow errors
74 lines
1.9 KiB
Plaintext
74 lines
1.9 KiB
Plaintext
---
|
|
title: "CLI init command"
|
|
sidebarTitle: "Init"
|
|
description: "Use these options when running the CLI `init` command."
|
|
---
|
|
|
|
Run the command like this:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npx trigger.dev@latest init
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@latest init
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@latest init
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## Options
|
|
|
|
<ParamField body="Javascript" type="--javascript">
|
|
By default, the init command assumes you are using TypeScript. Use this flag to initialize a
|
|
project that uses JavaScript.
|
|
</ParamField>
|
|
|
|
<ParamField body="Project ref" type="--project-ref | -p">
|
|
The project ref to use when initializing the project.
|
|
</ParamField>
|
|
|
|
<ParamField body="Package tag" type="--tag | -t">
|
|
The version of the `@trigger.dev/sdk` package to install. Defaults to `latest`.
|
|
</ParamField>
|
|
|
|
<ParamField body="Skip package install" type="--skip-package-install">
|
|
Skip installing the `@trigger.dev/sdk` package.
|
|
</ParamField>
|
|
|
|
<ParamField body="Override config" type="--override-config">
|
|
Override the existing config file if it exists.
|
|
</ParamField>
|
|
|
|
<ParamField body="Package arguments" type="--pkg-args">
|
|
Additional arguments to pass to the package manager. Accepts CSV for multiple args.
|
|
</ParamField>
|
|
|
|
<ParamField body="Login profile" type="--profile">
|
|
The login profile to use. Defaults to "default".
|
|
</ParamField>
|
|
|
|
<ParamField body="API URL" type="--api-url | -a">
|
|
Override the default API URL. If not specified, it uses `https://api.trigger.dev`.
|
|
</ParamField>
|
|
|
|
<ParamField body="Log level" type="--log-level | -l">
|
|
The CLI log level to use. Options are `debug`, `info`, `log`, `warn`, `error`, and `none`. This
|
|
does not affect the log level of your trigger.dev tasks. Defaults to "log".
|
|
</ParamField>
|
|
|
|
<ParamField body="Skip telemetry" type="--skip-telemetry">
|
|
Opt-out of sending telemetry data.
|
|
</ParamField>
|
|
|
|
## Standard options
|
|
|
|
<ParamField body="Help" type="--help | -h">
|
|
Shows the help information for the command.
|
|
</ParamField>
|