From 1561602a0a2d2d3a58f9de4978d522a7c99d6383 Mon Sep 17 00:00:00 2001 From: fern-support Date: Thu, 30 Oct 2025 16:55:13 +0000 Subject: [PATCH] Update Fern CLI commands to include --dsinghvi flag Updated all Fern CLI command examples across documentation to use the --dsinghvi flag. This change affects 23 documentation files including: - CLI reference pages - SDK quickstart guides for all languages - Documentation publishing guides - CLI changelog entries All commands now follow the pattern: fern --dsinghvi [command] [options] --- .../api-def/ferndef-pages/overview.mdx | 2 +- .../api-def/openapi-pages/overview.mdx | 4 ++-- .../cli-changelog/2024-10-19.mdx | 2 +- .../cli-changelog/2025-01-22.mdx | 2 +- .../cli-changelog/2025-02-27.mdx | 2 +- .../pages/cli-get-started.mdx | 20 +++++++++---------- .../pages/global-options.mdx | 18 ++++++++--------- .../docs/pages/getting-started/pr-preview.mdx | 4 ++-- .../preview-changes-locally.mdx | 8 ++++---- .../getting-started/publishing-your-docs.mdx | 4 ++-- .../sdks/guides/setup-local-sdk-previews.mdx | 6 +++--- .../overview/csharp/publishing-to-nuget.mdx | 2 +- .../sdks/overview/csharp/quickstart.mdx | 4 ++-- fern/products/sdks/overview/go/quickstart.mdx | 4 ++-- .../java/publishing-to-maven-central.mdx | 2 +- .../sdks/overview/java/quickstart.mdx | 4 ++-- .../products/sdks/overview/php/quickstart.mdx | 4 ++-- .../postman/publishing-to-postman.mdx | 2 +- .../sdks/overview/postman/quickstart.mdx | 4 ++-- .../sdks/overview/python/quickstart.mdx | 4 ++-- .../sdks/overview/ruby/quickstart.mdx | 4 ++-- .../sdks/overview/swift/quickstart.mdx | 2 +- .../sdks/overview/typescript/quickstart.mdx | 4 ++-- 23 files changed, 56 insertions(+), 56 deletions(-) diff --git a/fern/products/api-def/ferndef-pages/overview.mdx b/fern/products/api-def/ferndef-pages/overview.mdx index be9f27980..0ca4f211d 100644 --- a/fern/products/api-def/ferndef-pages/overview.mdx +++ b/fern/products/api-def/ferndef-pages/overview.mdx @@ -16,7 +16,7 @@ To initialize a Fern Definition, simply run: ```sh npm install -g fern-api -fern init +fern --dsinghvi init ``` This will create the following folder structure in your project: diff --git a/fern/products/api-def/openapi-pages/overview.mdx b/fern/products/api-def/openapi-pages/overview.mdx index f33b7fa38..38b0db37c 100644 --- a/fern/products/api-def/openapi-pages/overview.mdx +++ b/fern/products/api-def/openapi-pages/overview.mdx @@ -148,10 +148,10 @@ Start by initializing your fern folder with an OpenAPI spec ```sh file -fern init --openapi ./path/to/openapi +fern --dsinghvi init --openapi ./path/to/openapi ``` ```sh url -fern init --openapi https://host/path/to/openapi +fern --dsinghvi init --openapi https://host/path/to/openapi ``` diff --git a/fern/products/cli-api-reference/cli-changelog/2024-10-19.mdx b/fern/products/cli-api-reference/cli-changelog/2024-10-19.mdx index b3a73ccc3..db3b62481 100644 --- a/fern/products/cli-api-reference/cli-changelog/2024-10-19.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2024-10-19.mdx @@ -3,7 +3,7 @@ that outputs the JSON Schema for a given type in your Fern Definition. ```sh -fern jsonschema ./schema.json --type MyType +fern --dsinghvi jsonschema ./schema.json --type MyType ``` diff --git a/fern/products/cli-api-reference/cli-changelog/2025-01-22.mdx b/fern/products/cli-api-reference/cli-changelog/2025-01-22.mdx index 7fed0639d..fe8d21e5e 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-01-22.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-01-22.mdx @@ -9,7 +9,7 @@ migrates existing documentation to a fern-compatible repository. To use this feature: ```bash -fern init --readme https://url-to-readme-docs.com +fern --dsinghvi init --readme https://url-to-readme-docs.com ``` diff --git a/fern/products/cli-api-reference/cli-changelog/2025-02-27.mdx b/fern/products/cli-api-reference/cli-changelog/2025-02-27.mdx index 61b1396d0..17fc40c7c 100644 --- a/fern/products/cli-api-reference/cli-changelog/2025-02-27.mdx +++ b/fern/products/cli-api-reference/cli-changelog/2025-02-27.mdx @@ -8,7 +8,7 @@ will allow you to test early versions of the new OpenAPI parser which goes direc OpenAPI to IR. ```bash -fern ir ir.json --from-openapi +fern --dsinghvi ir ir.json --from-openapi ``` diff --git a/fern/products/cli-api-reference/pages/cli-get-started.mdx b/fern/products/cli-api-reference/pages/cli-get-started.mdx index c4ffe044c..b80f04c66 100644 --- a/fern/products/cli-api-reference/pages/cli-get-started.mdx +++ b/fern/products/cli-api-reference/pages/cli-get-started.mdx @@ -10,7 +10,7 @@ Run the following command to download and install Fern CLI from the [npm](https: ```bash npm install -g fern-api # install Fern CLI -fern -v # ensure Fern was successfully installed +fern --dsinghvi -v # ensure Fern was successfully installed ``` @@ -64,17 +64,17 @@ Get started with these commonly used commands: ```bash title="Common Commands" # Docs Development -fern init --docs # Create a new documentation project -fern docs dev # Preview docs locally at localhost:3000 -fern generate --docs --preview # Preview documentation changes -fern generate --docs # Generate and publish documentation +fern --dsinghvi init --docs # Create a new documentation project +fern --dsinghvi docs dev # Preview docs locally at localhost:3000 +fern --dsinghvi generate --docs --preview # Preview documentation changes +fern --dsinghvi generate --docs # Generate and publish documentation # SDK Development -fern init # Start new SDK project -fern check # Validate API definition -fern generate --preview # Preview SDKs in .preview/ folder -fern generate # Generate default SDK group -fern generate --group ts-sdk # Generate specific SDK group +fern --dsinghvi init # Start new SDK project +fern --dsinghvi check # Validate API definition +fern --dsinghvi generate --preview # Preview SDKs in .preview/ folder +fern --dsinghvi generate # Generate default SDK group +fern --dsinghvi generate --group ts-sdk # Generate specific SDK group ``` diff --git a/fern/products/cli-api-reference/pages/global-options.mdx b/fern/products/cli-api-reference/pages/global-options.mdx index efea3aa5b..cd8cf8c8d 100644 --- a/fern/products/cli-api-reference/pages/global-options.mdx +++ b/fern/products/cli-api-reference/pages/global-options.mdx @@ -28,8 +28,8 @@ Use the `--help` option with any Fern CLI command to see an explanation and avai ```bash maxLines=10 title="fern add --help" -fern add --help -fern add +fern --dsinghvi add --help +fern --dsinghvi add Add a code generator to generators.yml @@ -44,8 +44,8 @@ Options: ``` ```bash maxLines=10 title="fern write-definition --help" -fern write-definition --help -fern write-definition +fern --dsinghvi write-definition --help +fern --dsinghvi write-definition Write underlying Fern Definition for OpenAPI Specifications and API Dependencies. @@ -67,7 +67,7 @@ Available levels (from most to least verbose): - `error`: Error messages only ```bash -fern generate --log-level debug +fern --dsinghvi generate --log-level debug ``` ## api @@ -76,7 +76,7 @@ Use the `--api` option to target a specific API. This is particularly useful whe ```bash # Generate SDKs for only the "payments-api" -fern generate --api payments-api +fern --dsinghvi generate --api payments-api ``` ## group @@ -85,7 +85,7 @@ Use the `--group` option to target a specific generator group. ```bash # Generate only the Ruby SDK group -fern generate --group ruby-sdk +fern --dsinghvi generate --group ruby-sdk ``` ## version @@ -94,8 +94,8 @@ Use the `--version` option to specify the SDK version number, typically followin ```bash # Generate Python SDK the payments API with version 1.2.3 -fern generate --api payments-api --group python-sdk --version 1.2.3 +fern --dsinghvi generate --api payments-api --group python-sdk --version 1.2.3 # Generate TypeScript SDK for the auth API with version 0.1.0 -fern generate --api auth --group ts-sdk --version 0.1.0 +fern --dsinghvi generate --api auth --group ts-sdk --version 0.1.0 ``` diff --git a/fern/products/docs/pages/getting-started/pr-preview.mdx b/fern/products/docs/pages/getting-started/pr-preview.mdx index 19493cf04..459c61304 100644 --- a/fern/products/docs/pages/getting-started/pr-preview.mdx +++ b/fern/products/docs/pages/getting-started/pr-preview.mdx @@ -8,13 +8,13 @@ description: Fern's PR previews feature lets you preview changes to your docs fr ## Usage ```bash -fern generate --docs --preview +fern --dsinghvi generate --docs --preview ``` ## Example ```bash -fern generate --docs --preview +fern --dsinghvi generate --docs --preview [docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings. [docs]: Published docs to https://fern-preview-a1da0157-93ca-4b1f-b310-8dd34fb891ca.docs.buildwithfern.com diff --git a/fern/products/docs/pages/getting-started/preview-changes-locally.mdx b/fern/products/docs/pages/getting-started/preview-changes-locally.mdx index d5757d944..fce4e8bcf 100644 --- a/fern/products/docs/pages/getting-started/preview-changes-locally.mdx +++ b/fern/products/docs/pages/getting-started/preview-changes-locally.mdx @@ -31,7 +31,7 @@ yarn global add fern-api **Step 2**: Navigate to the docs directory (where the `fern` folder is located) and execute the following command: ```bash -fern docs dev +fern --dsinghvi docs dev ``` A local preview of your documentation will be available at `http://localhost:3000`. The functionality is available offline if you have run local development mode online at least once. @@ -48,7 +48,7 @@ Some features are disabled in the local development environment, including: By default, Fern uses port 3000. You can customize the port on which Fern runs by using the `--port` flag. For example, to run Fern on port 3002, use this command: ```bash -fern docs dev --port 3002 +fern --dsinghvi docs dev --port 3002 ``` If you attempt to run Fern on a port that's already in use, it will use the next available port: @@ -60,13 +60,13 @@ Fern allows you to generate a shareable preview link that displays the current s **Usage**: ```bash -fern generate --docs --preview +fern --dsinghvi generate --docs --preview ``` **Example**: ```bash -fern generate --docs --preview +fern --dsinghvi generate --docs --preview [docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings. [docs]: Published docs to https://fern-preview-c973a36e-337b-44f5-ab83-aab.docs.buildwithfern.com/learn diff --git a/fern/products/docs/pages/getting-started/publishing-your-docs.mdx b/fern/products/docs/pages/getting-started/publishing-your-docs.mdx index 8f79a5e7c..e670aa039 100644 --- a/fern/products/docs/pages/getting-started/publishing-your-docs.mdx +++ b/fern/products/docs/pages/getting-started/publishing-your-docs.mdx @@ -11,13 +11,13 @@ When you are ready for your docs to be publicly accessible, you can publish them ## Usage ```bash -fern generate --docs +fern --dsinghvi generate --docs ``` ### Example ```bash -fern generate --docs +fern --dsinghvi generate --docs [docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings. [docs]: ✓ All checks passed [docs]: Published docs to https://plantstore.docs.buildwithfern.com diff --git a/fern/products/sdks/guides/setup-local-sdk-previews.mdx b/fern/products/sdks/guides/setup-local-sdk-previews.mdx index 8af91db4b..1dcd72192 100644 --- a/fern/products/sdks/guides/setup-local-sdk-previews.mdx +++ b/fern/products/sdks/guides/setup-local-sdk-previews.mdx @@ -9,10 +9,10 @@ as you develop: ```bash # Preview all SDKs -fern generate --preview +fern --dsinghvi generate --preview # Preview SDK for a specific language -fern generate --group -sdk --preview +fern --dsinghvi generate --group -sdk --preview ``` @@ -50,7 +50,7 @@ groups: ### Invoke the Fern CLI ```shell -fern generate --group python-sdk --preview +fern --dsinghvi generate --group python-sdk --preview ``` ### Preview your SDK diff --git a/fern/products/sdks/overview/csharp/publishing-to-nuget.mdx b/fern/products/sdks/overview/csharp/publishing-to-nuget.mdx index efdc30fe6..3e8b243bc 100644 --- a/fern/products/sdks/overview/csharp/publishing-to-nuget.mdx +++ b/fern/products/sdks/overview/csharp/publishing-to-nuget.mdx @@ -288,7 +288,7 @@ export NUGET_API_KEY=your-actual-nuget-api-key Regenerate your SDK, specifying the version: ```bash -fern generate --group csharp-sdk --version +fern --dsinghvi generate --group csharp-sdk --version ``` diff --git a/fern/products/sdks/overview/csharp/quickstart.mdx b/fern/products/sdks/overview/csharp/quickstart.mdx index 201e64d43..4a431ed40 100644 --- a/fern/products/sdks/overview/csharp/quickstart.mdx +++ b/fern/products/sdks/overview/csharp/quickstart.mdx @@ -16,7 +16,7 @@ Generate a C#/.NET SDK by following the instructions on this page. Run the following command to add the C#/.NET SDK generator to `generators.yml`: ```bash -fern add fern-csharp-sdk --group csharp-sdk +fern --dsinghvi add fern-csharp-sdk --group csharp-sdk ``` @@ -42,7 +42,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group csharp-sdk +fern --dsinghvi generate --group csharp-sdk ``` diff --git a/fern/products/sdks/overview/go/quickstart.mdx b/fern/products/sdks/overview/go/quickstart.mdx index dea50f96a..0d9155bd0 100644 --- a/fern/products/sdks/overview/go/quickstart.mdx +++ b/fern/products/sdks/overview/go/quickstart.mdx @@ -16,7 +16,7 @@ Generate a Go SDK by following the instructions on this page. Run the following command to add the Go SDK generator to `generators.yml`: ```bash -fern add fern-go-sdk --group go-sdk +fern --dsinghvi add fern-go-sdk --group go-sdk ``` `go-sdk` is the name of the `generators.yml` group that configures your Go @@ -42,7 +42,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group go-sdk +fern --dsinghvi generate --group go-sdk ``` diff --git a/fern/products/sdks/overview/java/publishing-to-maven-central.mdx b/fern/products/sdks/overview/java/publishing-to-maven-central.mdx index 5c25458d7..77ba92990 100644 --- a/fern/products/sdks/overview/java/publishing-to-maven-central.mdx +++ b/fern/products/sdks/overview/java/publishing-to-maven-central.mdx @@ -342,7 +342,7 @@ export MAVEN_SIGNATURE_SECRET_KEY=your-gpg-secret-key Regenerate your SDK, specifying the version: ```bash -fern generate --group java-sdk --version +fern --dsinghvi generate --group java-sdk --version ``` diff --git a/fern/products/sdks/overview/java/quickstart.mdx b/fern/products/sdks/overview/java/quickstart.mdx index ca4076a5f..1821d9c64 100644 --- a/fern/products/sdks/overview/java/quickstart.mdx +++ b/fern/products/sdks/overview/java/quickstart.mdx @@ -16,7 +16,7 @@ Generate a Java SDK by following the instructions on this page. Run the following command to add the Java SDK generator to `generators.yml`: ```bash -fern add fern-java-sdk --group java-sdk +fern --dsinghvi add fern-java-sdk --group java-sdk ``` `java-sdk` is the name of the `generators.yml` group that configures your Java @@ -42,7 +42,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group java-sdk +fern --dsinghvi generate --group java-sdk ``` diff --git a/fern/products/sdks/overview/php/quickstart.mdx b/fern/products/sdks/overview/php/quickstart.mdx index 60ab8ab15..b5c47ea8b 100644 --- a/fern/products/sdks/overview/php/quickstart.mdx +++ b/fern/products/sdks/overview/php/quickstart.mdx @@ -16,7 +16,7 @@ Generate a PHP SDK by following the instructions on this page. Run the following command to add the PHP SDK generator to `generators.yml`: ```bash -fern add fern-php-sdk --group php-sdk +fern --dsinghvi add fern-php-sdk --group php-sdk ``` @@ -43,7 +43,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group php-sdk +fern --dsinghvi generate --group php-sdk ``` diff --git a/fern/products/sdks/overview/postman/publishing-to-postman.mdx b/fern/products/sdks/overview/postman/publishing-to-postman.mdx index cbc9e37e7..cb44790f7 100644 --- a/fern/products/sdks/overview/postman/publishing-to-postman.mdx +++ b/fern/products/sdks/overview/postman/publishing-to-postman.mdx @@ -313,7 +313,7 @@ The `--version` parameter in `fern generate --version X.X.X` creates a GitHub re ```bash -fern generate --group postman --version +fern --dsinghvi generate --group postman --version ``` diff --git a/fern/products/sdks/overview/postman/quickstart.mdx b/fern/products/sdks/overview/postman/quickstart.mdx index ba9bee6e4..3a194b03f 100644 --- a/fern/products/sdks/overview/postman/quickstart.mdx +++ b/fern/products/sdks/overview/postman/quickstart.mdx @@ -21,7 +21,7 @@ Generate a Postman collection by following the instructions on this page. Run the following command to add the Postman generator to `generators.yml`: ```sh -fern add fern-postman --group postman +fern --dsinghvi add fern-postman --group postman ``` @@ -46,7 +46,7 @@ groups: Run the following command: ```sh -fern generate --group postman +fern --dsinghvi generate --group postman ``` diff --git a/fern/products/sdks/overview/python/quickstart.mdx b/fern/products/sdks/overview/python/quickstart.mdx index 6e8a6dac6..23109e522 100644 --- a/fern/products/sdks/overview/python/quickstart.mdx +++ b/fern/products/sdks/overview/python/quickstart.mdx @@ -15,7 +15,7 @@ Generate a Python SDK by following the instructions on this page. Run the following command to add the Python SDK generator to `generators.yml`: ```bash -fern add fern-python-sdk --group python-sdk +fern --dsinghvi add fern-python-sdk --group python-sdk ``` @@ -42,7 +42,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group python-sdk +fern --dsinghvi generate --group python-sdk ``` diff --git a/fern/products/sdks/overview/ruby/quickstart.mdx b/fern/products/sdks/overview/ruby/quickstart.mdx index 9058e3c0e..a9c600dad 100644 --- a/fern/products/sdks/overview/ruby/quickstart.mdx +++ b/fern/products/sdks/overview/ruby/quickstart.mdx @@ -16,7 +16,7 @@ Generate a Ruby SDK by following the instructions on this page. Run the following command to add the Ruby SDK generator to `generators.yml`: ```bash -fern add fern-ruby-sdk --group ruby-sdk +fern --dsinghvi add fern-ruby-sdk --group ruby-sdk ``` @@ -43,7 +43,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group ruby-sdk +fern --dsinghvi generate --group ruby-sdk ``` diff --git a/fern/products/sdks/overview/swift/quickstart.mdx b/fern/products/sdks/overview/swift/quickstart.mdx index dbc17d573..0cfa38c02 100644 --- a/fern/products/sdks/overview/swift/quickstart.mdx +++ b/fern/products/sdks/overview/swift/quickstart.mdx @@ -15,7 +15,7 @@ Generate a Swift SDK by following the instructions on this page. Run the following command to add the Swift SDK generator to `generators.yml`: ```bash -fern add fern-swift-sdk --group swift-sdk +fern --dsinghvi add fern-swift-sdk --group swift-sdk ``` diff --git a/fern/products/sdks/overview/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx index b6ab2c5bc..d3b7b22d4 100644 --- a/fern/products/sdks/overview/typescript/quickstart.mdx +++ b/fern/products/sdks/overview/typescript/quickstart.mdx @@ -16,7 +16,7 @@ Generate a TypeScript SDK by following the instructions on this page. Run the following command to add the TypeScript SDK generator to `generators.yml`: ```bash -fern add fern-typescript-sdk --group ts-sdk +fern --dsinghvi add fern-typescript-sdk --group ts-sdk ``` @@ -42,7 +42,7 @@ This command adds the following `group` to `generators.yml`: Run the following command to generate your SDK: ```bash -fern generate --group ts-sdk +fern --dsinghvi generate --group ts-sdk ```