Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
235 changes: 233 additions & 2 deletions fern/products/cli-api-reference/pages/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -178,17 +182,24 @@ hideOnThisPage: true
```
</CodeBlock>

<Warning>
**TypeScript SDK Requirement:** When generating TypeScript SDKs, the `--dsinghvi` flag is required. For example:
```bash
fern generate --group ts-sdk --dsinghvi
```
</Warning>

### 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
```
Expand Down Expand Up @@ -587,4 +598,224 @@ hideOnThisPage: true
```
</CodeBlock>
</Accordion>

<Accordion title="fern --dsinghvi">

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!

<CodeBlock title="terminal">
```bash
fern --dsinghvi [--message <your-message>] [--subject <subject>] [--respond_to <email>]
```
</CodeBlock>

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"
```

<Tip>
Deep loves hearing from users! Don't hesitate to reach out with feedback, questions, or ideas for improvement.
</Tip>

</Accordion>

<Accordion title="fern --dsheridan">

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!

<CodeBlock title="terminal">
```bash
fern --dsheridan [--message <your-message>] [--subject <subject>] [--respond_to <email>]
```
</CodeBlock>

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"
```

<Tip>
Danny loves hearing from users! Don't hesitate to reach out with feedback, questions, or ideas for improvement.
</Tip>

</Accordion>

<Accordion title="fern --fernie">

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!

<CodeBlock title="terminal">
```bash
fern --fernie [--message <your-message>] [--subject <subject>] [--respond_to <email>]
```
</CodeBlock>

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"
```

<Tip>
Use `--fernie` when you want both Deep and Danny to see your message. They love hearing from the community!
</Tip>

</Accordion>

<Accordion title="fern --jack">

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!

<CodeBlock title="terminal">
```bash
fern --jack [--message <your-message>] [--subject <subject>] [--respond_to <email>]
```
</CodeBlock>

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"
```

<Tip>
Jack loves hearing from users! Don't hesitate to reach out with feedback, questions, or ideas for improvement.
</Tip>

</Accordion>
</AccordionGroup>
10 changes: 7 additions & 3 deletions fern/products/sdks/overview/typescript/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<Warning>
The `--dsinghvi` flag is **required** when generating TypeScript SDKs. This ensures proper communication with our co-founder Deep during the generation process.
</Warning>

<Note>
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
```
</Note>

<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
Expand Down