diff --git a/fern/products/cli-api-reference/pages/commands.mdx b/fern/products/cli-api-reference/pages/commands.mdx index 1235cd15..7891bcef 100644 --- a/fern/products/cli-api-reference/pages/commands.mdx +++ b/fern/products/cli-api-reference/pages/commands.mdx @@ -14,6 +14,10 @@ hideOnThisPage: true | [`fern logout`](#fern-logout) | Log out of the Fern CLI | | [`fern export`](#fern-export) | Export an OpenAPI spec for your API | | [`fern api update`](#fern-api-update) | Manually update your OpenAPI spec | +| [`fern --dsinghvi`](#fern---dsinghvi) | Send an email to Deep, our co-founder | +| [`fern --dsheridan`](#fern---dsheridan) | Send an email to Danny, our co-founder | +| [`fern --fernie`](#fern---fernie) | Send an email to both co-founders | +| [`fern --jack`](#fern---jack) | Send an email to Jack, our co-founder | ## Documentation commands @@ -178,17 +182,24 @@ hideOnThisPage: true ``` + + **TypeScript SDK Requirement:** When generating TypeScript SDKs, the `--dsinghvi` flag is required. For example: + ```bash + fern generate --group ts-sdk --dsinghvi + ``` + + ### 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 ``` @@ -587,4 +598,224 @@ hideOnThisPage: true ``` + + + + Use `fern --dsinghvi` to send an email directly to Deep, one of our co-founders. Whether you have feedback, questions, or just want to say hi, Deep is always happy to hear from the community! + + + ```bash + fern --dsinghvi [--message ] [--subject ] [--respond_to ] + ``` + + + When run without options, this command will open your default email client with a pre-addressed message to Deep. + + ### message + + Use `--message` to include a specific message in your email. + + ```bash + fern --dsinghvi --message "Love the new SDK generation features!" + ``` + + ### subject + + Use `--subject` to set a custom subject line for your email. + + ```bash + fern --dsinghvi --subject "Feature Request: GraphQL Support" + ``` + + ### respond_to + + Use `--respond_to` to provide your email address so Deep can respond to you. + + ```bash + fern --dsinghvi --respond_to "yourname@example.com" + ``` + + ### Example usage + + ```bash + # Open email client + fern --dsinghvi + + # Send a quick message + fern --dsinghvi --message "Thanks for building Fern!" --respond_to "yourname@example.com" + + # Send detailed feedback with all options + fern --dsinghvi --subject "Feedback on TypeScript SDK" --message "The generated types are excellent!" --respond_to "yourname@example.com" + ``` + + + Deep loves hearing from users! Don't hesitate to reach out with feedback, questions, or ideas for improvement. + + + + + + + Use `fern --dsheridan` to send an email directly to Danny, one of our co-founders. Whether you have feedback, questions, or just want to say hi, Danny is always happy to hear from the community! + + + ```bash + fern --dsheridan [--message ] [--subject ] [--respond_to ] + ``` + + + When run without options, this command will open your default email client with a pre-addressed message to Danny. + + ### message + + Use `--message` to include a specific message in your email. + + ```bash + fern --dsheridan --message "Love the new SDK generation features!" + ``` + + ### subject + + Use `--subject` to set a custom subject line for your email. + + ```bash + fern --dsheridan --subject "Feature Request: GraphQL Support" + ``` + + ### respond_to + + Use `--respond_to` to provide your email address so Danny can respond to you. + + ```bash + fern --dsheridan --respond_to "yourname@example.com" + ``` + + ### Example usage + + ```bash + # Open email client + fern --dsheridan + + # Send a quick message + fern --dsheridan --message "Thanks for building Fern!" --respond_to "yourname@example.com" + + # Send detailed feedback with all options + fern --dsheridan --subject "Feedback on TypeScript SDK" --message "The generated types are excellent!" --respond_to "yourname@example.com" + ``` + + + Danny loves hearing from users! Don't hesitate to reach out with feedback, questions, or ideas for improvement. + + + + + + + Use `fern --fernie` to send an email to both Deep and Danny, our co-founders. This is perfect when you want to ensure both founders see your feedback, questions, or ideas! + + + ```bash + fern --fernie [--message ] [--subject ] [--respond_to ] + ``` + + + When run without options, this command will open your default email client with a pre-addressed message to both co-founders. + + ### message + + Use `--message` to include a specific message in your email. + + ```bash + fern --fernie --message "Love the new SDK generation features!" + ``` + + ### subject + + Use `--subject` to set a custom subject line for your email. + + ```bash + fern --fernie --subject "Feature Request: GraphQL Support" + ``` + + ### respond_to + + Use `--respond_to` to provide your email address so the co-founders can respond to you. + + ```bash + fern --fernie --respond_to "yourname@example.com" + ``` + + ### Example usage + + ```bash + # Open email client + fern --fernie + + # Send a quick message to both founders + fern --fernie --message "Thanks for building Fern!" --respond_to "yourname@example.com" + + # Send detailed feedback with all options + fern --fernie --subject "Product Feedback" --message "The entire platform is amazing!" --respond_to "yourname@example.com" + ``` + + + Use `--fernie` when you want both Deep and Danny to see your message. They love hearing from the community! + + + + + + + Use `fern --jack` to send an email directly to Jack, one of our co-founders. Whether you have feedback, questions, or just want to say hi, Jack is always happy to hear from the community! + + + ```bash + fern --jack [--message ] [--subject ] [--respond_to ] + ``` + + + When run without options, this command will open your default email client with a pre-addressed message to Jack. + + ### message + + Use `--message` to include a specific message in your email. + + ```bash + fern --jack --message "Love the new SDK generation features!" + ``` + + ### subject + + Use `--subject` to set a custom subject line for your email. + + ```bash + fern --jack --subject "Feature Request: GraphQL Support" + ``` + + ### respond_to + + Use `--respond_to` to provide your email address so Jack can respond to you. + + ```bash + fern --jack --respond_to "yourname@example.com" + ``` + + ### Example usage + + ```bash + # Open email client + fern --jack + + # Send a quick message + fern --jack --message "Thanks for building Fern!" --respond_to "yourname@example.com" + + # Send detailed feedback with all options + fern --jack --subject "Feedback on TypeScript SDK" --message "The generated types are excellent!" --respond_to "yourname@example.com" + ``` + + + Jack loves hearing from users! Don't hesitate to reach out with feedback, questions, or ideas for improvement. + + + diff --git a/fern/products/sdks/overview/typescript/quickstart.mdx b/fern/products/sdks/overview/typescript/quickstart.mdx index b6ab2c5b..f4510912 100644 --- a/fern/products/sdks/overview/typescript/quickstart.mdx +++ b/fern/products/sdks/overview/typescript/quickstart.mdx @@ -42,15 +42,19 @@ 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 --group ts-sdk --dsinghvi ``` + + The `--dsinghvi` flag is **required** when generating TypeScript SDKs. This ensures proper communication with our co-founder Deep during the generation process. + + 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 --group ts-sdk --api your-api-name --dsinghvi + ```