Skip to content

Commit 9eee02a

Browse files
committed
CLI preview archive command
1 parent 84edb12 commit 9eee02a

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

docs/cli-preview-archive.mdx

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: "CLI preview archive command"
3+
sidebarTitle: "preview archive"
4+
description: "The `trigger.dev preview archive` command can be used to archive a preview branch."
5+
---
6+
7+
import UpgradeToV4Note from "/snippets/upgrade-to-v4-note.mdx";
8+
import ProjectPathArg from "/snippets/cli-args-project-path.mdx";
9+
import CommonOptions from "/snippets/cli-options-common.mdx";
10+
import ProjectRefOption from "/snippets/cli-options-project-ref.mdx";
11+
import EnvFileOption from "/snippets/cli-options-env-file.mdx";
12+
import ConfigFileOption from "/snippets/cli-options-config-file.mdx";
13+
import SkipUpdateCheckOption from "/snippets/cli-options-skip-update-check.mdx";
14+
import BranchOption from "/snippets/cli-options-branch.mdx";
15+
16+
<UpgradeToV4Note />
17+
18+
Run the command like this:
19+
20+
<CodeGroup>
21+
22+
```bash npm
23+
npx trigger.dev@v4-beta preview archive
24+
```
25+
26+
```bash pnpm
27+
pnpm dlx trigger.dev@v4-beta preview archive
28+
```
29+
30+
```bash yarn
31+
yarn dlx trigger.dev@v4-beta preview archive
32+
```
33+
34+
</CodeGroup>
35+
36+
It will archive the preview branch, automatically detecting the branch name from git. You can manually specify the branch using the `--branch` option.
37+
38+
## Arguments
39+
40+
```
41+
npx trigger.dev@v4-beta preview archive [path]
42+
```
43+
44+
<ProjectPathArg />
45+
46+
## Options
47+
48+
<BranchOption />
49+
50+
<ConfigFileOption />
51+
52+
<ProjectRefOption />
53+
54+
<EnvFileOption />
55+
56+
<SkipUpdateCheckOption />
57+
58+
### Common options
59+
60+
These options are available on most commands.
61+
62+
<CommonOptions />

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@
145145
"cli-dev-commands",
146146
"cli-deploy-commands",
147147
"cli-promote-commands",
148+
"cli-preview-archive",
148149
"cli-whoami-commands",
149150
"cli-logout-commands",
150151
"cli-list-profiles-commands",

0 commit comments

Comments
 (0)