Getting started with Ruby

The source code of the Ruby SDK is hosted here: https://github.com/clerkinc/clerk-sdk-ruby

​Add this line to your application's Gemfile

And then execute:

Or install it yourself as:

First, you need to get an API key for a Clerk instance.

This is done on the API Keys page.

Then you can instantiate a Clerk::SDK instance and access all Backend API endpoints. Here's a quick example:

The SDK can be configured in three ways: environment variables, configuration singleton and constructor arguments. The priority goes like this:

If an argument is not provided, the configuration object is looked up, which falls back to the associated environment variable. Here's an example with all supported configuration settings their environment variable equivalents:

You can customize each instance of the Clerk::SDK object by passing keyword arguments to the constructor:

Refer to the Faraday documentation for details.

Here's a list of all environment variables the SDK uses:

​