James Ritchie
972b5e34b8
* WIP creating a CLI section * WIP adding more CLI commands in a new section * New CLI section with introduction and more CLI commands * More improvement to the CLI options * Each CLI command has its own page * fixed broken links * Removed outdated copy
67 lines
1.7 KiB
Plaintext
67 lines
1.7 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@beta init
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm dlx trigger.dev@beta init
|
|
```
|
|
|
|
```bash yarn
|
|
yarn dlx trigger.dev@beta init
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## Options
|
|
|
|
<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 `3.0.0-beta.56`.
|
|
</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> |