Skip to content

Commit

Permalink
chore(docs): Add example to fern generator upgrade command in CLI r…
Browse files Browse the repository at this point in the history
…eference (#5932)

* chore(docs): Document fern generator upgrade command

* document fern generator upgrade command

* add back detail

* revise filesentencecasing

* hide on this page
  • Loading branch information
dannysheridan authored Feb 8, 2025
1 parent d73e105 commit ced1513
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
2 changes: 1 addition & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ navigation:
icon: fa-regular fa-icons
slug: icons
- page: Parameter Fields
path: ./pages/docs/components/ParamField.mdx
path: ./pages/docs/components/paramfield.mdx
icon: fa-regular fa-input-text
slug: paramfield
- page: Steps
Expand Down
24 changes: 22 additions & 2 deletions fern/pages/cli-api/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Commands'
description: 'Complete reference for all Fern CLI commands for generating SDKs and developer documentation.'
subtitle: 'Learn about the Fern CLI commands.'
hideOnThisPage: true
---

| Command | Description |
Expand Down Expand Up @@ -460,9 +461,28 @@ subtitle: 'Learn about the Fern CLI commands.'
- Update the generator versions to their latest compatible releases
- Maintain compatibility with your current Fern compiler version

Here's what you might see when updates are available:

```plaintext
┌───────────────────────────────────────────────────────────────────────────────────┐
│ │
│ Upgrades available │
│ │
│ │
│ C# SDK (API: openapi, Group: csharp-sdk) 1.9.11 → 1.9.15 │
│ Java SDK (API: openapi, Group: java-sdk) 2.2.0 → 2.11.3 │
│ Python SDK (API: openapi, Group: python-sdk) 4.3.10 → 4.3.11 │
│ │
│ Run fern generator upgrade to upgrade your generators. │
│ Run fern generator upgrade --list to see the full list of generator upgrades │
│ available. │
│ │
└───────────────────────────────────────────────────────────────────────────────────┘
```

### list

Use `--list` to see all available generator upgrades without applying them.
Use `--list` to see the full list of generator upgrades available.

```bash
fern generator upgrade --list
Expand All @@ -489,4 +509,4 @@ subtitle: 'Learn about the Fern CLI commands.'
This is different from `fern upgrade` which updates the Fern CLI version. Use both commands to keep your entire Fern toolchain up to date.
</Note>
</Accordion>
</AccordionGroup>
</AccordionGroup>
Binary file added fern/pages/cli-api/upgrade-nudge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ced1513

Please sign in to comment.