nicktrn
9a3eab5ac4
* pull out common cli options * lint commands table * update dev command link * add undefined Crypto section * add self-hosting section to github actions docs * add cli usage section to self-hosting docs * add skip telemetry env var to cli option docs * add api url env var to cli options docs * lowercase cli commands in sidebar * add self-hosting beta notice * update beta to latest tag on electric route * add deploy command examples section * fix env file option * reorder deploy options sections * cli docs fixes
59 lines
1.3 KiB
Plaintext
59 lines
1.3 KiB
Plaintext
---
|
|
title: "CLI init command"
|
|
sidebarTitle: "init"
|
|
description: "Use these options when running the CLI `init` command."
|
|
---
|
|
|
|
import CommonOptions from '/snippets/cli-options-common.mdx';
|
|
|
|
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>
|
|
|
|
### Common options
|
|
|
|
These options are available on most commands.
|
|
|
|
<CommonOptions />
|