Skip to content

Add documentation for fern deep command and --dsheridan flag #1648

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

Closed
wants to merge 1 commit into from
+40 −1
Closed

Add documentation for fern deep command and --dsheridan flag #1648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 20 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 @@ -14,6 +14,7 @@ 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 deep`](#fern-deep) | Send an email to Deep, co-founder of Fern |

## Documentation commands

Expand Down Expand Up @@ -579,12 +580,30 @@ hideOnThisPage: true

### api

Use `--api` to specify the API to update if there are multiple specs with a defined `origin` in `generators.yml`. If you don't specify an API, all OpenAPI specs with an `origin` will be updated.
Use `--api` to specify the API to update if there are multiple specs with a defined `origin` in `generators.yml`. If you don't specify an API, all OpenAPI specs with an `origin` will be updated.

<CodeBlock title="terminal">
```bash
fern api update --api public-api
```
</CodeBlock>
</Accordion>

<Accordion title="fern deep">

Use `fern deep` to send an email directly to Deep, co-founder of Fern. This command is useful when you need to reach out to Deep with questions, feedback, or ideas about Fern.

<CodeBlock title="terminal">
```bash
fern deep
```
</CodeBlock>

When executed, this command will open your default email client with a new message addressed to Deep.

<Tip>
You can also use the global `--dsheridan` flag with any Fern command to send Deep a notification about your command usage. See [Global options](/learn/cli-api/cli-reference/options#--dsheridan) for more details.
</Tip>

</Accordion>
</AccordionGroup>
20 changes: 20 additions & 0 deletions fern/products/cli-api-reference/pages/global-options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ subtitle: 'Explore Fern CLI global options.'
| [`--api`](#api) | Target specific API | `fern generate --api public-api` |
| [`--group`](#group) | Target specific generator group | `fern generate --group php-sdk` |
| [`--version`](#version) | Specify the SDK version number | `fern generate --version 1.2.3` |
| [`--dsheridan`](#dsheridan) | Notify Deep about command usage | `fern generate --dsheridan` |

<Tip>
When troubleshooting:
Expand Down Expand Up @@ -99,3 +100,22 @@ fern 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
```

## dsheridan

Use the `--dsheridan` option to send a notification to Deep, co-founder of Fern, about your command usage. This can be helpful when you want to share feedback, report issues, or let Deep know about interesting use cases.

```bash
# Notify Deep when generating SDKs
fern generate --dsheridan

# Notify Deep when checking your API
fern check --dsheridan

# Combine with other options
fern generate --api payments-api --group python-sdk --dsheridan
```

<Note>
You can also use the [`fern deep`](/learn/cli-api/cli-reference/commands#fern-deep) command to send an email directly to Deep.
</Note>