Skip to content

Add documentation for --fernignore flag in fern generate command #2496

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
merged 6 commits into from
Dec 3, 2025
Merged

Add documentation for --fernignore flag in fern generate command #2496

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d9541e
Add documentation for --fernignore flag in fern generate command
fern-support Dec 3, 2025
9ac9640
Add --fernignore to fern generate command syntax example
fern-support Dec 3, 2025
7907360
clarify description
devalog Dec 3, 2025
693cc8b
Clarify that Fern commits the new fernignore during generation
fern-support Dec 3, 2025
9830372
Merge remote changes and clarify that Fern commits the new fernignore
fern-support Dec 3, 2025
bd222b1
update description
devalog Dec 3, 2025
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
12 changes: 11 additions & 1 deletion fern/products/cli-api-reference/pages/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ hideOnThisPage: true

<CodeBlock title="terminal">
```bash
fern generate [--group <group>] [--api <api>] [--version <version>] [--preview]
fern generate [--group <group>] [--api <api>] [--version <version>] [--preview] [--fernignore <path>]
```
</CodeBlock>

Expand Down Expand Up @@ -223,6 +223,16 @@ hideOnThisPage: true
fern generate --version 2.11
```

### fernignore

Use `--fernignore` to specify a custom `.fernignore` file path for SDK generation. This allows you to temporarily test different ignore configurations without modifying the committed `.fernignore` in your repository.

Fern will use the specified file instead of the one on the main branch and commit the new `.fernignore` to your repository as part of the generation process.

```bash
fern generate --fernignore ./custom-fernignore
```

</Accordion>

<Accordion title="fern check">
Expand Down