Skip to content

Add Node.js and npm version requirements to CLI installation docs #4548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 2 commits into from
Mar 25, 2026
Merged

Add Node.js and npm version requirements to CLI installation docs #4548

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cb1c92
Add Node.js and npm version requirements to CLI installation docs
fern-api[bot] Mar 25, 2026
36fa116
make steps more explicit
devalog Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion fern/products/cli-api-reference/pages/cli-get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,31 @@ The Fern CLI lets you initialize projects, validate API definitions, preview cha

## Installation

<Steps>
<Step title="Check prerequisites">

The Fern CLI requires [Node.js](https://nodejs.org/) version 18 or higher and npm version 8.6.0 or higher (ships with Node.js 18).

```bash
node -v # Must be v18.0.0 or higher
```

If your version is below the minimum, [download the latest Node.js LTS](https://nodejs.org/) which includes a compatible npm version.
Copy link
Contributor

@github-actions github-actions bot Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated

Copy link
Contributor

@github-actions github-actions bot Mar 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'LTS' has no definition.


</Step>

<Step title="Install the Fern CLI">

Run the following command to install the Fern CLI globally from [npm](https://www.npmjs.com/):

```bash
npm install -g fern-api
fern -v
fern -v # Verify the installation
```

</Step>
</Steps>

<Accordion title="Install locally as a project dependency">

If you prefer to manage Fern as a project dependency or are working in an environment with limited internet connectivity, install the CLI locally:
Expand Down
Loading