Skip to main content

Getting started

liblab helps you automatically generate SDKs in different programming languages as well as developer documentation for your API. This guide will help you get started, giving you an overview of liblab, the CLI, and the process to generate SDKs.

Sign up now to get started with liblab for free.

The SDK generation process

To generate SDKs you use the liblab CLI - a command line interface that has features including the ability to configure and generate SDKs. This CLI takes a configuration file and an API spec, and outputs SDKs and documentation.

The flow for using liblab - an api spec and config file goes in, and an SDK and documentation comes out. The flow for using liblab - an api spec and config file goes in, and an SDK and documentation comes out.

liblab supports API specs in Swagger, OpenAPI, and Postman Collection formats. You can find a full list of what we support in our supported specs guide.

The config file is a JSON file that configures the SDK generation. It includes information such as the name of the SDK, the programming language, the API spec file to use, how your API authenticates, and more. The liblab CLI takes this config file, verifies it and your spec, then generates an SDK and documentation. You can find out more about the config file in our config file guide.

The usual developer flow is to work through this process manually a few times to ensure your spec is correct, and that your configuration file is correctly set up for your needs. After this, you can automate the process via your CI/CD pipeline.

Install the liblab CLI

The liblab CLI can be installed using npm or Homebrew:

To install the liblab CLI make sure you have Node.js version 18.17 or later installed. We recommend using nvm to manage your Node.js versions.

You can install the CLI using npm by running this command in your terminal:

npm install -g liblab

You can read more on installation in our CLI installation guide.

Register or login

Use the liblab login command to either register with liblab, or to log in:

liblab login

You can read more on the registration and log in process in our CLI authentication guide.

Next steps

You are now ready to generate SDKs using liblab 🎉. Head to our Generate an SDK from your OpenAPI spec guide to generate your first SDK from an OpenAPI spec you already have.

To learn more about the CLI and the configuration file, check out the CLI documentation.

Otherwise, check out one of our hands-on tutorials to help you get started.

Learn how to build an SDK to control a llama in a game.

Automatically generate your SDK every time your API changes using GitHub Actions.

Learn how to customize your SDK with hooks.