Skip to content

Commit 0f41f88

Browse files
committed
cli docs fixes
1 parent 91275ac commit 0f41f88

File tree

5 files changed

+41
-18
lines changed

5 files changed

+41
-18
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<ParamField body="Project path" type="[path]">
2+
The path to the project. Defaults to the current directory.
3+
</ParamField>

docs/snippets/cli-commands-deploy.mdx

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
import ProjectPathArg from '/snippets/cli-args-project-path.mdx';
12
import CommonOptions from '/snippets/cli-options-common.mdx';
23
import ProjectRefOption from '/snippets/cli-options-project-ref.mdx';
34
import EnvFileOption from '/snippets/cli-options-env-file.mdx';
5+
import ConfigFileOption from '/snippets/cli-options-config-file.mdx';
6+
import SkipUpdateCheckOption from '/snippets/cli-options-skip-update-check.mdx';
47

58
Run the command like this:
69

@@ -34,22 +37,32 @@ It performs a few steps to deploy:
3437

3538
You can also setup [GitHub Actions](/github-actions) to deploy your tasks automatically.
3639

40+
## Arguments
41+
42+
```
43+
npx trigger.dev@latest deploy [path]
44+
```
45+
46+
<ProjectPathArg />
47+
3748
## Options
3849

50+
<ConfigFileOption />
51+
52+
<ProjectRefOption />
53+
54+
<EnvFileOption />
55+
56+
<SkipUpdateCheckOption />
57+
3958
<ParamField body="Environment" type="--env | -e">
4059
Defaults to `prod` but you can specify `staging`.
4160
</ParamField>
4261

43-
<EnvFileOption />
44-
4562
<ParamField body="Dry run" type="--dry-run">
4663
Create a deployable build but don't deploy it. Prints out the build path so you can inspect it.
4764
</ParamField>
4865

49-
<ParamField body="Skip update check" type="--skip-update-check">
50-
Skip checking for `@trigger.dev` package updates.
51-
</ParamField>
52-
5366
<ParamField body="Build platform" type="--build-platform">
5467
The platform to build the deployment image for. Defaults to `linux/amd64`.
5568
</ParamField>
@@ -58,12 +71,6 @@ You can also setup [GitHub Actions](/github-actions) to deploy your tasks automa
5871
Turn off syncing environment variables with the Trigger.dev instance.
5972
</ParamField>
6073

61-
<ParamField body="Set config filename" type="--config | -c">
62-
The name of the config file, found where the command is run from. Defaults to `trigger.config.ts`.
63-
</ParamField>
64-
65-
<ProjectRefOption />
66-
6774
### Common options
6875

6976
These options are available on most commands.

docs/snippets/cli-commands-develop.mdx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1+
import ProjectPathArg from '/snippets/cli-args-project-path.mdx';
12
import CommonOptions from '/snippets/cli-options-common.mdx';
23
import ProjectRefOption from '/snippets/cli-options-project-ref.mdx';
34
import EnvFileOption from '/snippets/cli-options-env-file.mdx';
5+
import ConfigFileOption from '/snippets/cli-options-config-file.mdx';
6+
import SkipUpdateCheckOption from '/snippets/cli-options-skip-update-check.mdx';
47

58
This runs a server on your machine that can execute Trigger.dev tasks:
69

@@ -26,19 +29,23 @@ You will see in the terminal that the server is running and listening for tasks.
2629

2730
It is worth noting that each task runs in a separate Node process. This means that if you have a long-running task, it will not block other tasks from running.
2831

32+
## Arguments
33+
34+
```
35+
npx trigger.dev@latest dev [path]
36+
```
37+
38+
<ProjectPathArg />
39+
2940
## Options
3041

31-
<ParamField body="Config file" type="--config | -c">
32-
The name of the config file, found at [path].
33-
</ParamField>
42+
<ConfigFileOption />
3443

3544
<ProjectRefOption />
3645

3746
<EnvFileOption />
3847

39-
<ParamField body="Skip update check" type="--skip-update-check">
40-
Skip checking for `@trigger.dev` package updates.
41-
</ParamField>
48+
<SkipUpdateCheckOption />
4249

4350
### Common options
4451

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<ParamField body="Config file" type="--config | -c">
2+
The name of the config file found at the project path. Defaults to `trigger.config.ts`
3+
</ParamField>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<ParamField body="Skip update check" type="--skip-update-check">
2+
Skip checking for `@trigger.dev` package updates.
3+
</ParamField>

0 commit comments

Comments
 (0)