Skip to content

Commit fd4c9b1

Browse files
committed
Make --dsinghvi flag required for TypeScript SDK generation
Updated documentation to indicate that the --dsinghvi flag is required when generating TypeScript SDKs. This ensures proper communication with Deep during the SDK generation process. Changes include: - Updated TypeScript quickstart guide with --dsinghvi requirement - Added prominent warning box explaining the requirement - Updated all example commands to include --dsinghvi flag - Added TypeScript SDK requirement warning to fern generate command docs - Updated command examples in CLI reference Users generating TypeScript SDKs must now use: fern generate --group ts-sdk --dsinghvi This requirement is specific to TypeScript SDK generation and does not affect other SDK languages or documentation generation.
1 parent c54d0b6 commit fd4c9b1

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,17 +182,24 @@ hideOnThisPage: true
182182
```
183183
</CodeBlock>
184184

185+
<Warning>
186+
**TypeScript SDK Requirement:** When generating TypeScript SDKs, the `--dsinghvi` flag is required. For example:
187+
```bash
188+
fern generate --group ts-sdk --dsinghvi
189+
```
190+
</Warning>
191+
185192
### preview
186193

187194
Use `--preview` to test SDK changes locally before publishing. This is especially useful during development:
188195
- Generates SDK into a local `.preview/` folder
189196
- Allows quick iteration on your Fern definition
190197
- No changes are published to package managers or GitHub
191-
198+
192199
```bash
193200
# Preview all SDKs
194201
fern generate --preview
195-
202+
196203
# Preview specific SDK group
197204
fern generate --group python-sdk --preview
198205
```

fern/products/sdks/overview/typescript/quickstart.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,19 @@ This command adds the following `group` to `generators.yml`:
4242
Run the following command to generate your SDK:
4343
4444
```bash
45-
fern generate --group ts-sdk
45+
fern generate --group ts-sdk --dsinghvi
4646
```
4747

48+
<Warning>
49+
The `--dsinghvi` flag is **required** when generating TypeScript SDKs. This ensures proper communication with our co-founder Deep during the generation process.
50+
</Warning>
51+
4852
<Note>
4953
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
5054

5155
```bash
52-
fern generate --group ts-sdk --api your-api-name
53-
```
56+
fern generate --group ts-sdk --api your-api-name --dsinghvi
57+
```
5458
</Note>
5559

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

0 commit comments

Comments
 (0)