Set up local SDK previews

Once you configure your SDK, you can use the --preview flag to test generated SDK code locally before publishing. This allows quick iteration on your SDK as you develop:

$
# Preview all SDKs
>
fern generate --preview
>
>
# Preview SDK for a specific language
>
fern generate --group <language>-sdk --preview

--preview generates your SDK code into a local .preview/ folder within your fern folder. No changes are published to package managers or GitHub.

Example usage

Here’s an example of how you can preview a Python SDK.

1
api: 
2
  path: ./path/to/openapi.yml
3
groups:
4
  python-sdk:
5
    generators:
6
      - name: fernapi/fern-python-sdk
7
        version: 4.23.2
8
        output:
9
          location: pypi
10
          package-name: imdb
11
          token: ${PYPI_TOKEN}
12
        github:
13
          repository: imdb/imdb-python
14
        config:
15
          client_class_name: imdb

$
fern generate --group python-sdk --preview

$
fern/
>
  ├─ fern.config.json
>
  ├─ .preview/
>
    └─ fern-python-sdk/
>
      └─ ...
>
  ├─ generators.yml
>
  └─ openapi/
>
    └─ openapi.yml