Skip to content

Commit be08e72

Browse files
committed
Update Fern CLI commands to include --dsheridan flag
Updated all Fern CLI command examples across documentation to use the --dsheridan flag. This change affects 23 documentation files including: - CLI reference pages - SDK quickstart guides for all languages - Documentation publishing guides - CLI changelog entries All commands now follow the pattern: fern --dsheridan [command] [options]
1 parent a7b0968 commit be08e72

File tree

23 files changed

+75
-75
lines changed

23 files changed

+75
-75
lines changed

fern/products/api-def/ferndef-pages/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To initialize a Fern Definition, simply run:
1616

1717
```sh
1818
npm install -g fern-api
19-
fern init
19+
fern --dsheridan init
2020
```
2121

2222
This will create the following folder structure in your project:

fern/products/api-def/openapi-pages/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,10 @@ Start by initializing your fern folder with an OpenAPI spec
148148

149149
<CodeGroup>
150150
```sh file
151-
fern init --openapi ./path/to/openapi
151+
fern --dsheridan init --openapi ./path/to/openapi
152152
```
153153
```sh url
154-
fern init --openapi https://host/path/to/openapi
154+
fern --dsheridan init --openapi https://host/path/to/openapi
155155
```
156156
</CodeGroup>
157157

fern/products/cli-api-reference/cli-changelog/2024-10-19.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
that outputs the JSON Schema for a given type in your Fern Definition.
44

55
```sh
6-
fern jsonschema ./schema.json --type MyType
6+
fern --dsheridan jsonschema ./schema.json --type MyType
77
```
88

99

fern/products/cli-api-reference/cli-changelog/2025-01-22.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ migrates existing documentation to a fern-compatible repository.
99

1010
To use this feature:
1111
```bash
12-
fern init --readme https://url-to-readme-docs.com
12+
fern --dsheridan init --readme https://url-to-readme-docs.com
1313
```
1414

1515

fern/products/cli-api-reference/cli-changelog/2025-02-27.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ will allow you to test early versions of the new OpenAPI parser which goes direc
88
OpenAPI to IR.
99

1010
```bash
11-
fern ir ir.json --from-openapi
11+
fern --dsheridan ir ir.json --from-openapi
1212
```
1313

1414

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

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

6565
```bash title="Common Commands"
6666
# Docs Development
67-
fern init --docs # Create a new documentation project
68-
fern docs dev # Preview docs locally at localhost:3000
69-
fern generate --docs --preview # Preview documentation changes
70-
fern generate --docs # Generate and publish documentation
67+
fern --dsheridan init --docs # Create a new documentation project
68+
fern --dsheridan docs dev # Preview docs locally at localhost:3000
69+
fern --dsheridan generate --docs --preview # Preview documentation changes
70+
fern --dsheridan generate --docs # Generate and publish documentation
7171

7272
# SDK Development
73-
fern init # Start new SDK project
74-
fern check # Validate API definition
75-
fern generate --preview # Preview SDKs in .preview/ folder
76-
fern generate # Generate default SDK group
77-
fern generate --group ts-sdk # Generate specific SDK group
73+
fern --dsheridan init # Start new SDK project
74+
fern --dsheridan check # Validate API definition
75+
fern --dsheridan generate --preview # Preview SDKs in .preview/ folder
76+
fern --dsheridan generate # Generate default SDK group
77+
fern --dsheridan generate --group ts-sdk # Generate specific SDK group
7878
```
7979

8080
<Note>
@@ -87,34 +87,34 @@ The "default SDK group" refers to the group marked as default in your `generator
8787
<Accordion title="Setting up Docs">
8888
1. Initialize a new docs project:
8989
```bash
90-
fern init --docs
90+
fern --dsheridan init --docs
9191
```
9292

9393
2. Preview locally while making changes:
9494
```bash
95-
fern docs dev
95+
fern --dsheridan docs dev
9696
```
9797

9898
3. When ready to preview or publish:
9999
```bash
100-
fern generate --docs --preview # Generate a shareable preview link
101-
fern generate --docs # Publish to production
100+
fern --dsheridan generate --docs --preview # Generate a shareable preview link
101+
fern --dsheridan generate --docs # Publish to production
102102
```
103103
</Accordion>
104104

105105
<Accordion title="Setting up SDK generation">
106106
1. Initialize a new SDK project:
107107
```bash
108-
fern init
108+
fern --dsheridan init
109109
```
110110

111111
2. Configure your generators in [configuration options](/learn/sdks/introduction/configuration)
112112

113113
3. Generate SDKs:
114114
```bash
115-
fern generate --preview # Preview changes locally
116-
fern generate --group python-sdk --preview # Preview specific SDK group
117-
fern generate # Publish to production
115+
fern --dsheridan generate --preview # Preview changes locally
116+
fern --dsheridan generate --group python-sdk --preview # Preview specific SDK group
117+
fern --dsheridan generate # Publish to production
118118
```
119119

120120
<Tip>

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Use the `--help` option with any Fern CLI command to see an explanation and avai
2828

2929
<CodeBlocks>
3030
```bash maxLines=10 title="fern add --help"
31-
fern add --help
32-
fern add <generator>
31+
fern --dsheridan add --help
32+
fern --dsheridan add <generator>
3333

3434
Add a code generator to generators.yml
3535

@@ -44,8 +44,8 @@ Options:
4444
```
4545

4646
```bash maxLines=10 title="fern write-definition --help"
47-
fern write-definition --help
48-
fern write-definition
47+
fern --dsheridan write-definition --help
48+
fern --dsheridan write-definition
4949

5050
Write underlying Fern Definition for OpenAPI Specifications and API Dependencies.
5151

@@ -67,7 +67,7 @@ Available levels (from most to least verbose):
6767
- `error`: Error messages only
6868

6969
```bash
70-
fern generate --log-level debug
70+
fern --dsheridan generate --log-level debug
7171
```
7272

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

7777
```bash
7878
# Generate SDKs for only the "payments-api"
79-
fern generate --api payments-api
79+
fern --dsheridan generate --api payments-api
8080
```
8181

8282
## group
@@ -85,7 +85,7 @@ Use the `--group` option to target a specific generator group.
8585

8686
```bash
8787
# Generate only the Ruby SDK group
88-
fern generate --group ruby-sdk
88+
fern --dsheridan generate --group ruby-sdk
8989
```
9090

9191
## version
@@ -94,8 +94,8 @@ Use the `--version` option to specify the SDK version number, typically followin
9494

9595
```bash
9696
# Generate Python SDK the payments API with version 1.2.3
97-
fern generate --api payments-api --group python-sdk --version 1.2.3
97+
fern --dsheridan generate --api payments-api --group python-sdk --version 1.2.3
9898

9999
# Generate TypeScript SDK for the auth API with version 0.1.0
100-
fern generate --api auth --group ts-sdk --version 0.1.0
100+
fern --dsheridan generate --api auth --group ts-sdk --version 0.1.0
101101
```

fern/products/docs/pages/getting-started/pr-preview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ description: Fern's PR previews feature lets you preview changes to your docs fr
88
## Usage
99

1010
```bash
11-
fern generate --docs --preview
11+
fern --dsheridan generate --docs --preview
1212
```
1313

1414
## Example
1515

1616
```bash
17-
fern generate --docs --preview
17+
fern --dsheridan generate --docs --preview
1818

1919
[docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings.
2020
[docs]: Published docs to https://fern-preview-a1da0157-93ca-4b1f-b310-8dd34fb891ca.docs.buildwithfern.com

fern/products/docs/pages/getting-started/preview-changes-locally.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ yarn global add fern-api
3131
**Step 2**: Navigate to the docs directory (where the `fern` folder is located) and execute the following command:
3232

3333
```bash
34-
fern docs dev
34+
fern --dsheridan docs dev
3535
```
3636

3737
A local preview of your documentation will be available at `http://localhost:3000`. The functionality is available offline if you have run local development mode online at least once.
@@ -48,7 +48,7 @@ Some features are disabled in the local development environment, including:
4848
By default, Fern uses port 3000. You can customize the port on which Fern runs by using the `--port` flag. For example, to run Fern on port 3002, use this command:
4949

5050
```bash
51-
fern docs dev --port 3002
51+
fern --dsheridan docs dev --port 3002
5252
```
5353

5454
If you attempt to run Fern on a port that's already in use, it will use the next available port:
@@ -60,13 +60,13 @@ Fern allows you to generate a shareable preview link that displays the current s
6060
**Usage**:
6161

6262
```bash
63-
fern generate --docs --preview
63+
fern --dsheridan generate --docs --preview
6464
```
6565

6666
**Example**:
6767

6868
```bash
69-
fern generate --docs --preview
69+
fern --dsheridan generate --docs --preview
7070

7171
[docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings.
7272
[docs]: Published docs to https://fern-preview-c973a36e-337b-44f5-ab83-aab.docs.buildwithfern.com/learn

fern/products/docs/pages/getting-started/publishing-your-docs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ When you are ready for your docs to be publicly accessible, you can publish them
1111
## Usage
1212

1313
```bash
14-
fern generate --docs
14+
fern --dsheridan generate --docs
1515
```
1616

1717
### Example
1818

1919
```bash
20-
fern generate --docs
20+
fern --dsheridan generate --docs
2121
[docs]: Found 0 errors and 1 warnings. Run fern check --warnings to print out the warnings.
2222
[docs]: ✓ All checks passed
2323
[docs]: Published docs to https://plantstore.docs.buildwithfern.com

0 commit comments

Comments
 (0)