Split CLI commands page into docs and SDK references - #6686
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| subtitle: 'Learn about the Fern CLI commands.' | ||
| title: 'SDK Commands' | ||
| description: 'Complete reference for all Fern CLI commands for generating SDKs.' | ||
| subtitle: 'Learn about the Fern CLI SDK commands.' |
There was a problem hiding this comment.
📝 [vale] <Microsoft.Uppercase> reported by reviewdog 🐶
Don't use all uppercase for emphasis.
| |---------|-------------| | ||
| | [`fern generate`](#fern-generate) | Build & publish SDK updates | | ||
| | [`fern write-overrides`](#fern-write-overrides) | Create OpenAPI customizations | | ||
| | [`fern generator upgrade`](#fern-generator-upgrade) | Update SDK generators to latest versions | |
There was a problem hiding this comment.
Avoid time-relative terms like 'latest' that become outdated
| </Accordion> | ||
|
|
||
| <Accordion title="fern generator upgrade"> | ||
| Use `fern generator upgrade` to update all generators in your `generators.yml` to their latest versions. |
There was a problem hiding this comment.
Avoid time-relative terms like 'latest' that become outdated
| | `fern upgrade --version 5.35.0` | Minimum `5.40.0` | `5.40.0` | | ||
|
|
||
| A plain `fern upgrade` resolves to the latest release, which is never below the minimum, so only the maximum changes what it writes. The minimum applies when you request an older version with [`--version`](/learn/cli-api-reference/cli-reference/commands#fern-upgrade): the bounds win over the version you asked for. | ||
| A plain `fern upgrade` resolves to the latest release, which is never below the minimum, so only the maximum changes what it writes. The minimum applies when you request an older version with [`--version`](/learn/cli-api-reference/cli-reference/general-commands#fern-upgrade): the bounds win over the version you asked for. |
There was a problem hiding this comment.
Avoid time-relative terms like 'latest' that become outdated
| |---------|-------------| | ||
| | [`fern init`](#fern-init) | Create new Fern project from OpenAPI spec or scratch | | ||
| | [`fern check`](#fern-check) | Validate API definition & configuration | | ||
| | [`fern upgrade`](#fern-upgrade) | Update Fern CLI & generators to latest versions | |
There was a problem hiding this comment.
Avoid time-relative terms like 'latest' that become outdated
| </Accordion> | ||
|
|
||
| <Accordion title="fern api update"> | ||
| Pulls the latest OpenAPI spec from the specified `origin` in `generators.yml` and |
There was a problem hiding this comment.
Avoid time-relative terms like 'latest' that become outdated
|
|
||
| <CodeBlock title="terminal"> | ||
| ```bash | ||
| fern api update [--api <api>] |
There was a problem hiding this comment.
📝 [vale] <FernStyles.Headings> reported by reviewdog 🐶
'api' should use sentence-style capitalization.
| hideOnThisPage: true | ||
| --- | ||
|
|
||
| These commands generate SDKs from your API definition, keep generators up to date, and manage the custom code [Fern Replay](/learn/sdks/overview/custom-code#replay) carries across regenerations. Creating a project with `fern init` and validating the API definition with `fern check` are [general commands](/learn/cli-api-reference/cli-reference/general-commands), and [docs commands](/learn/cli-api-reference/cli-reference/docs-commands) publish the API reference that documents the SDKs you generate. Each SDK command accepts the [global options](/learn/cli-api-reference/cli-reference/options). |
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
2 participants
Split
fern/products/cli-api-reference/pages/commands.mdxintodocs-commands.mdx(documentation commands table plus thefern generate --docs,fern docs dev/diff/preview/md/theme/link checksections) andsdk-commands.mdx(the general and SDK generation tables plusfern init,export,generate,check,upgrade,downgrade,login,logout,token,api update/enrich,orgcommands,write-overrides,generator upgrade, andreplaysections), deleted the original page, and added both pages to the CLI reference navigation withdocs-commandsandsdk-commandsslugs. Content, code blocks, and callouts carried over unchanged; the two cross-page anchor references (fern check↔fern docs link check, andfern init→fern generate --docs) were repointed at their new pages.fern/docs.ymlnow redirects the old/learn/cli-api-reference/cli-reference/commandsURL (and the legacy/learn/cli-reference/commandsentry) tosdk-commands, and the ~45 pages elsewhere in the docs that deep-linked intocommands#anchorwere updated to the correct new page so their anchors still resolve.