TypeScript Quickstart
Generate a TypeScript SDK by following the instructions on this page.
This page assumes that you have:
- An initialized
fern
folder on your local machine. See Set up thefern
folder. - A GitHub repository for your SDK. See Project Structure.
Pass fern check
Run fern check
to ensure that your API definition is valid. If there are any errors,
fix them before proceeding.
If you’re using an OpenAPI Specification, check out all of our supported extensions.
Add the SDK generator
Run the following command to add the TypeScript SDK generator to generators.yml
:
ts-sdk
is the name of the generators.yml
group that configures your TypeScript
SDK’s output location and other metadata. You can customize this group name to
differentiate between multiple SDKs across different languages (e.g.,
ruby-sdk
, etc) in your organization.
This command adds the following group
to generators.yml
:
generators.yml