From c20c995359b6bec5b38bf0949cd11f17467d9dcd Mon Sep 17 00:00:00 2001 From: fern-support Date: Fri, 24 Oct 2025 19:54:56 +0000 Subject: [PATCH] Add --deep flag documentation to fern generate command Update all SDK quickstart guides and CLI reference to include the --deep flag for fern generate commands. This flag enables deep generation mode and ensures complete SDK generation with the latest CLI version. Changes include: - Added --deep flag documentation to CLI commands reference - Updated all SDK quickstart examples (C#, Go, Java, PHP, Python, Ruby, Swift, TypeScript, Postman) - Updated example output paths to reflect --deep flag usage --- fern/products/cli-api-reference/pages/commands.mdx | 14 +++++++++++--- fern/products/sdks/overview/csharp/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/go/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/java/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/php/quickstart.mdx | 10 +++++----- fern/products/sdks/overview/postman/quickstart.mdx | 4 ++-- fern/products/sdks/overview/python/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/ruby/quickstart.mdx | 8 ++++---- fern/products/sdks/overview/swift/quickstart.mdx | 4 ++-- .../sdks/overview/typescript/quickstart.mdx | 8 ++++---- 10 files changed, 44 insertions(+), 36 deletions(-) diff --git a/fern/products/cli-api-reference/pages/commands.mdx b/fern/products/cli-api-reference/pages/commands.mdx index 1235cd15a..b3e6c5914 100644 --- a/fern/products/cli-api-reference/pages/commands.mdx +++ b/fern/products/cli-api-reference/pages/commands.mdx @@ -174,21 +174,29 @@ hideOnThisPage: true ```bash - fern generate [--group ] [--api ] [--version ] [--preview] + fern generate [--deep] [--group ] [--api ] [--version ] [--preview] ``` + ### deep + + Use `--deep` to enable deep generation mode. This flag is recommended for the latest CLI version and ensures complete SDK generation. + + ```bash + fern generate --deep --group ts-sdk + ``` + ### preview Use `--preview` to test SDK changes locally before publishing. This is especially useful during development: - Generates SDK into a local `.preview/` folder - Allows quick iteration on your Fern definition - No changes are published to package managers or GitHub - + ```bash # Preview all SDKs fern generate --preview - + # Preview specific SDK group fern generate --group python-sdk --preview ``` diff --git a/fern/products/sdks/overview/csharp/quickstart.mdx b/fern/products/sdks/overview/csharp/quickstart.mdx index 201e64d43..34a16affe 100644 --- a/fern/products/sdks/overview/csharp/quickstart.mdx +++ b/fern/products/sdks/overview/csharp/quickstart.mdx @@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group csharp-sdk +fern generate --deep --group csharp-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group csharp-sdk --api your-api-name - ``` + fern generate --deep --group csharp-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group csharp-sdk +sdks/ # created by fern generate --deep --group csharp-sdk ├─ csharp └─ src/ ├─ YourOrganizationApi.sln diff --git a/fern/products/sdks/overview/go/quickstart.mdx b/fern/products/sdks/overview/go/quickstart.mdx index dea50f96a..0006d6e1d 100644 --- a/fern/products/sdks/overview/go/quickstart.mdx +++ b/fern/products/sdks/overview/go/quickstart.mdx @@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group go-sdk +fern generate --deep --group go-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group go-sdk --api your-api-name - ``` + fern generate --deep --group go-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group go-sdk +sdks/ # created by fern generate --deep --group go-sdk ├─ go ├─ core/ └─ go.mod diff --git a/fern/products/sdks/overview/java/quickstart.mdx b/fern/products/sdks/overview/java/quickstart.mdx index ca4076a5f..dec2c49d5 100644 --- a/fern/products/sdks/overview/java/quickstart.mdx +++ b/fern/products/sdks/overview/java/quickstart.mdx @@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group java-sdk +fern generate --deep --group java-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group java-sdk --api your-api-name - ``` + fern generate --deep --group java-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group java-sdk +sdks/ # created by fern generate --deep --group java-sdk ├─ java ├─ YourOrganizationApiClient.java ├─ core/ diff --git a/fern/products/sdks/overview/php/quickstart.mdx b/fern/products/sdks/overview/php/quickstart.mdx index 60ab8ab15..6afc70f8a 100644 --- a/fern/products/sdks/overview/php/quickstart.mdx +++ b/fern/products/sdks/overview/php/quickstart.mdx @@ -43,27 +43,27 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group php-sdk +fern generate --deep --group php-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group php-sdk --api your-api-name - ``` + fern generate --deep --group php-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group php-sdk +sdks/ # created by fern generate --deep --group php-sdk ├─ php └─ sdk/ ├─ src/ ├─ YourOrganizationClient.php - └─ Types/ + └─ Types/ └─ tests/ └─ Core/ ``` diff --git a/fern/products/sdks/overview/postman/quickstart.mdx b/fern/products/sdks/overview/postman/quickstart.mdx index ba9bee6e4..6dab8efa3 100644 --- a/fern/products/sdks/overview/postman/quickstart.mdx +++ b/fern/products/sdks/overview/postman/quickstart.mdx @@ -46,14 +46,14 @@ groups: Run the following command: ```sh -fern generate --group postman +fern generate --deep --group postman ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group postman --api your-api-name + fern generate --deep --group postman --api your-api-name ``` diff --git a/fern/products/sdks/overview/python/quickstart.mdx b/fern/products/sdks/overview/python/quickstart.mdx index 6e8a6dac6..2cf048e4e 100644 --- a/fern/products/sdks/overview/python/quickstart.mdx +++ b/fern/products/sdks/overview/python/quickstart.mdx @@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group python-sdk +fern generate --deep --group python-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group python-sdk --api your-api-name - ``` + fern generate --deep --group python-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group python-sdk +sdks/ # created by fern generate --deep --group python-sdk ├─ python ├─ __init__.py ├─ client.py diff --git a/fern/products/sdks/overview/ruby/quickstart.mdx b/fern/products/sdks/overview/ruby/quickstart.mdx index 9058e3c0e..a68511917 100644 --- a/fern/products/sdks/overview/ruby/quickstart.mdx +++ b/fern/products/sdks/overview/ruby/quickstart.mdx @@ -43,22 +43,22 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group ruby-sdk +fern generate --deep --group ruby-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group ruby-sdk --api your-api-name - ``` + fern generate --deep --group ruby-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group ruby-sdk +sdks/ # created by fern generate --deep --group ruby-sdk ├─ ruby ├─ YourOrganization_api_client.gemspec ├─ test/ diff --git a/fern/products/sdks/overview/swift/quickstart.mdx b/fern/products/sdks/overview/swift/quickstart.mdx index dbc17d573..caf2cd1a1 100644 --- a/fern/products/sdks/overview/swift/quickstart.mdx +++ b/fern/products/sdks/overview/swift/quickstart.mdx @@ -42,14 +42,14 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash - fern generate --group swift-sdk + fern generate --deep --group swift-sdk ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group swift-sdk +sdks/ # created by fern generate --deep --group swift-sdk ├─ swift ├─ Package.swift └─ Sources diff --git a/fern/products/sdks/overview/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx index b6ab2c5bc..a570341ff 100644 --- a/fern/products/sdks/overview/typescript/quickstart.mdx +++ b/fern/products/sdks/overview/typescript/quickstart.mdx @@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group ts-sdk +fern generate --deep --group ts-sdk ``` If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate: ```bash - fern generate --group ts-sdk --api your-api-name - ``` + fern generate --deep --group ts-sdk --api your-api-name + ``` ```bash fern/ # created by fern init -sdks/ # created by fern generate --group ts-sdk +sdks/ # created by fern generate --deep --group ts-sdk ├─ typescript ├─ Client.ts ├─ index.ts