Skip to content

Commit 042f826

Browse files
authored
(cli) Document --include-major option (#855)
1 parent ddcadba commit 042f826

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

fern/products/cli-api-reference/pages/commands.mdx

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -498,9 +498,13 @@ hideOnThisPage: true
498498
<Accordion title="fern generator upgrade">
499499
Use `fern generator upgrade` to update all generators in your `generators.yml` to their latest versions.
500500

501+
<Note>
502+
This is different from `fern upgrade` which updates the Fern CLI version. Use both commands to keep your entire Fern toolchain up to date.
503+
</Note>
504+
501505
<CodeBlock title="terminal">
502506
```bash
503-
fern generator upgrade [--list] [--generator <generator-name>] [--group <group>]
507+
fern generator upgrade [--list] [--generator <generator-name>] [--group <group>] [--include-major]
504508
```
505509
</CodeBlock>
506510

@@ -553,8 +557,13 @@ hideOnThisPage: true
553557
fern generator upgrade --group public
554558
```
555559

556-
<Note>
557-
This is different from `fern upgrade` which updates the Fern CLI version. Use both commands to keep your entire Fern toolchain up to date.
558-
</Note>
560+
### include-major
561+
562+
```bash
563+
fern generator upgrade --include-major
564+
```
565+
566+
Use `--include-major` to include major version upgrades. Major versions are skipped by default to prevent breaking changes.
567+
559568
</Accordion>
560569
</AccordionGroup>

0 commit comments

Comments
 (0)