Quickstart

​

Step 1: Sign up on our platform

• Signup at platform.getclary.com with your org email using email-password / Google / GitHub
• The first account to signup will automatically be made the Organisation admin on the platform. So make sure this account is intended to be an org admin
• Now click on get started → Enter your name and your organisation’s name
• Click submit, your org will be created

​

Step 2: Connect your datasource

• Click on bottom-left profile icon and go to datasources
• Click new datasource → select your datasource (Let’s say Postgres)
• Then enter your DB credentials, make sure our IPs are whitelisted if you have set restriction policies
• Click on create

​

Step 3: Download clary CLI tool from GitHub

• Download the CLI tool as per your device and architecture: Windows/Linux/Mac
• Extract the archive
• On Linux/Mac (Make sure to adjust the path of the clary binary)

cp ~/Downloads/clary /usr/bin/

• On Windows, move/copy it somewhere where the CMD can detect the binary (in PATH)

​

Step 4: Create your API key

• Click on API Keys in the left sidebar of Settings page
• Click on create new API key
• Copy this API key

​

Step 5: Open your dbt project in vscode or any other IDE

• First open your dbt project in VS Code or any other editor of your choice
• In the terminal run this command:

clary auth

• It will prompt for API route - keep the default (just hit enter)
• Then enter the API key you generate in step 4

​

Step 6: Initialize your project with clary configurations

• Run (make sure you are in the project directory):

clary init

• Press enter when prompted for the directory
• It will generate a folder with a few files
• It has a few examples, but if we already have a dbt project, we don’t need it, so we can just remove the clary/docs folder and move clary/clary.yaml file into our project’s root folder
• The clary.yml file contains instructions on what every field means. Please go through it and configure it accordingly.

​

Step 7: Deploy your models

• Finally run:

clary deploy

• This will try to parse your dbt models and automatically convert them into clary models and deploy it on our platform.
• NOTE: If it is trying to deploy a yaml file that is not a model (eg. __profile.yaml), you can add them to exclude property in clary.yaml
• NOTE: If you only want to deploy a subset of your models on clary, you can use the include property to add the paths you want to include in clary.yaml