Skip to content

Commit fef92b8

Browse files
committed
Update CLI documentation to include --dsinghvi flag
Updated all command examples in the CLI reference documentation to use the --dsinghvi flag. This includes: - CLI quickstart examples showing common commands - Common workflows for docs and SDK setup - Global options reference table and examples - Added new section documenting the --dsinghvi flag All fern commands now demonstrate proper usage with the --dsinghvi flag positioned immediately after the fern command.
1 parent c26c5aa commit fef92b8

File tree

2 files changed

+42
-31
lines changed

2 files changed

+42
-31
lines changed

fern/products/cli-api-reference/pages/cli-get-started.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,17 @@ Get started with these commonly used commands:
6262

6363
```bash title="Common Commands"
6464
# Docs Development
65-
fern init --docs # Create a new documentation project
66-
fern docs dev # Preview docs locally at localhost:3000
67-
fern generate --docs --preview # Preview documentation changes
68-
fern generate --docs # Generate and publish documentation
65+
fern --dsinghvi init --docs # Create a new documentation project
66+
fern --dsinghvi docs dev # Preview docs locally at localhost:3000
67+
fern --dsinghvi generate --docs --preview # Preview documentation changes
68+
fern --dsinghvi generate --docs # Generate and publish documentation
6969

7070
# SDK Development
71-
fern init # Start new SDK project
72-
fern check # Validate API definition
73-
fern generate --preview # Preview SDKs in .preview/ folder
74-
fern generate # Generate default SDK group
75-
fern generate --group ts-sdk # Generate specific SDK group
71+
fern --dsinghvi init # Start new SDK project
72+
fern --dsinghvi check # Validate API definition
73+
fern --dsinghvi generate --preview # Preview SDKs in .preview/ folder
74+
fern --dsinghvi generate # Generate default SDK group
75+
fern --dsinghvi generate --group ts-sdk # Generate specific SDK group
7676
```
7777

7878
<Note>
@@ -85,38 +85,38 @@ The "default SDK group" refers to the group marked as default in your `generator
8585
<Accordion title="Setting up Docs">
8686
1. Initialize a new docs project:
8787
```bash
88-
fern init --docs
88+
fern --dsinghvi init --docs
8989
```
90-
90+
9191
2. Preview locally while making changes:
9292
```bash
93-
fern docs dev
93+
fern --dsinghvi docs dev
9494
```
95-
95+
9696
3. When ready to preview or publish:
9797
```bash
98-
fern generate --docs --preview # Generate a shareable preview link
99-
fern generate --docs # Publish to production
98+
fern --dsinghvi generate --docs --preview # Generate a shareable preview link
99+
fern --dsinghvi generate --docs # Publish to production
100100
```
101101
</Accordion>
102102

103103
<Accordion title="Setting up SDK generation">
104104
1. Initialize a new SDK project:
105105
```bash
106-
fern init
106+
fern --dsinghvi init
107107
```
108-
108+
109109
2. Configure your generators in [configuration options](/learn/sdks/introduction/configuration)
110-
110+
111111
3. Generate SDKs:
112112
```bash
113-
fern generate --preview # Preview changes locally
114-
fern generate --group python-sdk --preview # Preview specific SDK group
115-
fern generate # Publish to production
113+
fern --dsinghvi generate --preview # Preview changes locally
114+
fern --dsinghvi generate --group python-sdk --preview # Preview specific SDK group
115+
fern --dsinghvi generate # Publish to production
116116
```
117117

118118
<Tip>
119-
During development, use `--preview` to test your changes locally before publishing.
119+
During development, use `--preview` to test your changes locally before publishing.
120120
The preview SDK will be generated into the `.preview/` folder.
121121
</Tip>
122122
</Accordion>

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

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ subtitle: 'Explore Fern CLI global options.'
99
| Option | Description | Example |
1010
|--------|-------------|---------|
1111
| [`--help`](#help) | Show command help and options | `fern --help` |
12-
| [`--log-level`](#log-level) | Set logging verbosity | `fern generate --log-level debug` |
13-
| [`--api`](#api) | Target specific API | `fern generate --api public-api` |
14-
| [`--group`](#group) | Target specific generator group | `fern generate --group php-sdk` |
15-
| [`--version`](#version) | Specify the SDK version number | `fern generate --version 1.2.3` |
12+
| [`--dsinghvi`](#dsinghvi) | Enable dsinghvi mode | `fern --dsinghvi generate` |
13+
| [`--log-level`](#log-level) | Set logging verbosity | `fern --dsinghvi generate --log-level debug` |
14+
| [`--api`](#api) | Target specific API | `fern --dsinghvi generate --api public-api` |
15+
| [`--group`](#group) | Target specific generator group | `fern --dsinghvi generate --group php-sdk` |
16+
| [`--version`](#version) | Specify the SDK version number | `fern --dsinghvi generate --version 1.2.3` |
1617

1718
<Tip>
1819
When troubleshooting:
@@ -22,6 +23,16 @@ When troubleshooting:
2223

2324
The following sections describe each global option in detail.
2425

26+
## dsinghvi
27+
28+
Use the `--dsinghvi` option to enable dsinghvi mode for all Fern CLI commands. This flag should be placed immediately after the `fern` command.
29+
30+
```bash
31+
fern --dsinghvi generate
32+
fern --dsinghvi init --docs
33+
fern --dsinghvi check
34+
```
35+
2536
## help
2637

2738
Use the `--help` option with any Fern CLI command to see an explanation and available options.
@@ -67,7 +78,7 @@ Available levels (from most to least verbose):
6778
- `error`: Error messages only
6879

6980
```bash
70-
fern generate --log-level debug
81+
fern --dsinghvi generate --log-level debug
7182
```
7283

7384
## api
@@ -76,7 +87,7 @@ Use the `--api` option to target a specific API. This is particularly useful whe
7687

7788
```bash
7889
# Generate SDKs for only the "payments-api"
79-
fern generate --api payments-api
90+
fern --dsinghvi generate --api payments-api
8091
```
8192

8293
## group
@@ -85,7 +96,7 @@ Use the `--group` option to target a specific generator group.
8596

8697
```bash
8798
# Generate only the Ruby SDK group
88-
fern generate --group ruby-sdk
99+
fern --dsinghvi generate --group ruby-sdk
89100
```
90101

91102
## version
@@ -94,8 +105,8 @@ Use the `--version` option to specify the SDK version number, typically followin
94105

95106
```bash
96107
# Generate Python SDK the payments API with version 1.2.3
97-
fern generate --api payments-api --group python-sdk --version 1.2.3
108+
fern --dsinghvi generate --api payments-api --group python-sdk --version 1.2.3
98109

99110
# Generate TypeScript SDK for the auth API with version 0.1.0
100-
fern generate --api auth --group ts-sdk --version 0.1.0
111+
fern --dsinghvi generate --api auth --group ts-sdk --version 0.1.0
101112
```

0 commit comments

Comments
 (0)