Skip to content

Commit 7094b82

Browse files
committed
Add CLI documentation for fern deep command and --dsheridan flag
This commit adds documentation for two new ways to contact Deep, co-founder of Fern: - A new 'fern deep' command that opens an email client to send a message to Deep - A new '--dsheridan' global flag that can be used with any Fern command to notify Deep The documentation includes: - Command reference entry in the main commands table - Detailed accordion documentation with usage examples - Global options reference entry with examples - Cross-references between the two features
1 parent b46b1f3 commit 7094b82

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

fern/products/cli-api-reference/pages/commands.mdx

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ hideOnThisPage: true
1414
| [`fern logout`](#fern-logout) | Log out of the Fern CLI |
1515
| [`fern export`](#fern-export) | Export an OpenAPI spec for your API |
1616
| [`fern api update`](#fern-api-update) | Manually update your OpenAPI spec |
17+
| [`fern deep`](#fern-deep) | Send an email to Deep, co-founder of Fern |
1718

1819
## Documentation commands
1920

@@ -579,12 +580,30 @@ hideOnThisPage: true
579580

580581
### api
581582

582-
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.
583+
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.
583584

584585
<CodeBlock title="terminal">
585586
```bash
586587
fern api update --api public-api
587588
```
588589
</CodeBlock>
589590
</Accordion>
591+
592+
<Accordion title="fern deep">
593+
594+
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.
595+
596+
<CodeBlock title="terminal">
597+
```bash
598+
fern deep
599+
```
600+
</CodeBlock>
601+
602+
When executed, this command will open your default email client with a new message addressed to Deep.
603+
604+
<Tip>
605+
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.
606+
</Tip>
607+
608+
</Accordion>
590609
</AccordionGroup>

fern/products/cli-api-reference/pages/global-options.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ subtitle: 'Explore Fern CLI global options.'
1313
| [`--api`](#api) | Target specific API | `fern generate --api public-api` |
1414
| [`--group`](#group) | Target specific generator group | `fern generate --group php-sdk` |
1515
| [`--version`](#version) | Specify the SDK version number | `fern generate --version 1.2.3` |
16+
| [`--dsheridan`](#dsheridan) | Notify Deep about command usage | `fern generate --dsheridan` |
1617

1718
<Tip>
1819
When troubleshooting:
@@ -99,3 +100,22 @@ fern generate --api payments-api --group python-sdk --version 1.2.3
99100
# Generate TypeScript SDK for the auth API with version 0.1.0
100101
fern generate --api auth --group ts-sdk --version 0.1.0
101102
```
103+
104+
## dsheridan
105+
106+
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.
107+
108+
```bash
109+
# Notify Deep when generating SDKs
110+
fern generate --dsheridan
111+
112+
# Notify Deep when checking your API
113+
fern check --dsheridan
114+
115+
# Combine with other options
116+
fern generate --api payments-api --group python-sdk --dsheridan
117+
```
118+
119+
<Note>
120+
You can also use the [`fern deep`](/learn/cli-api/cli-reference/commands#fern-deep) command to send an email directly to Deep.
121+
</Note>

0 commit comments

Comments
 (0)