Skip to content

Add fern deep command to CLI reference #1495

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 fern deep command to CLI reference #1495

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
37 changes: 36 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) | Email our co-founder Deep |

## Documentation commands

Expand Down Expand Up @@ -579,12 +580,46 @@ 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, one of Fern's co-founders. This command provides a direct line of communication for feedback, questions, or insights about your Fern experience.

<CodeBlock title="terminal">
```bash
fern deep [--message <message>] [--subject <subject>]
```
</CodeBlock>

When run without options, the command will open an interactive prompt to compose your message.

### message

Use `--message` to specify the email body directly from the command line.

```bash
fern deep --message "Love the new SDK generator features!"
```

### subject

Use `--subject` to specify the email subject. If not provided, a default subject will be used.

```bash
fern deep --subject "Feature Request" --message "It would be great to have..."
```

<Note>
Deep personally reads all messages sent through this command and aims to respond within 24-48 hours.
</Note>

</Accordion>
</AccordionGroup>