Skip to content

Add CLI documentation for fern deep command and --dsheridan flag #1668

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
Closed

Add CLI documentation for fern deep command and --dsheridan flag #1668

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
1 change: 1 addition & 0 deletions 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 @@ -12,6 +12,7 @@ hideOnThisPage: true
| [`fern upgrade`](#fern-upgrade) | Update Fern CLI & generators to latest versions |
| [`fern login`](#fern-login) | Login to Fern CLI via GitHub or Google |
| [`fern logout`](#fern-logout) | Log out of the Fern CLI |
| [`fern deep`](#fern-deep) | Email Deep, our co-founder, directly |
| [`fern export`](#fern-export) | Export an OpenAPI spec for your API |
| [`fern api update`](#fern-api-update) | Manually update your OpenAPI spec |

Expand Down
26 changes: 26 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) | Email Deep Sheridan directly | `fern --dsheridan` |

<Tip>
When troubleshooting:
Expand Down Expand Up @@ -99,3 +100,28 @@ 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 an email directly to Deep Sheridan, our co-founder. This global flag works with any command and opens a direct line of communication for feedback, questions, or suggestions.

```bash
# Send a quick message to Deep
fern --dsheridan

# Use with any other command
fern generate --docs --dsheridan
```

When you use this flag, the CLI will:
1. Execute your command normally
2. Open an interactive prompt for you to compose a message to Deep
3. Send the email along with context about which command you were running

<Tip>
You can also use the dedicated [`fern deep`](/learn/cli-api/cli-reference/commands#fern-deep) command for a more focused email experience.
</Tip>

<Note>
Deep reads every message personally and tries to respond within 24 hours. For urgent issues, please also reach out via our [Discord community](https://discord.gg/fern).
</Note>