Skip to main content
Lightdash transforms your dbt™ project into a full-stack BI platform, enabling self-serve analytics for your entire organization. Paradime’s native integration with the Lightdash CLI lets you develop and deploy Lightdash metrics directly from your development environment.

​
What you can do

Catalog & Lineage

Lightdash assets appear in Paradime’s catalog and lineage, so you can trace dbt™ models through to the metrics built on them.

Orchestration

Develop metrics with the Lightdash CLI in the Code IDE and deploy dbt™ project changes to Lightdash from a Bolt schedule.

​
Prerequisites

Before getting started, you’ll need:
  • A Lightdash instance (Cloud or Self-hosted)
  • Access to Paradime’s Code IDE
  • Admin access for setting up credentials
Not sure which Lightdash option to choose? See the Cloud vs. Self-hosted comparison.

​
Development setup

​
Authenticating with Lightdash

  1. In the Code IDE, open the Paradime Integrated Terminal
  2. Follow Lightdash documentation and run authentication commands.
  3. Follow the prompts to complete authentication

​
Using the Lightdash CLI

The Lightdash CLI in Paradime enables you to: View available commands:

​
Orchestration

Enable automatic deployment of your dbt™ project changes to Lightdash using Paradime Bolt schedules. For the full set of Bolt commands, see Lightdash commands.

​
Step 1: Configure Lightdash credentials

  1. From any page in Paradime, Click Settings
  2. Navigate to Workspaces > Environment Variables
  3. In the Bolt Schedules section, click Add New
  4. Configure each required variable:
    • LIGHTDASH_API_KEY: Personal access token
    • LIGHTDASH_PROJECT: Project UUID
    • LIGHTDASH_URL: Instance URL
  • LIGHTDASH_API_KEY​
Create a new personal access token, by going to Settings > Personal Access Tokens. This is the token you’ll put in for LIGHTDASH_API_KEY.
  • LIGHTDASH_PROJECT​
The UUID for your project. For example, if your URL looks like https://eu1.lightdash.cloud/projects/3538ab33-dc90-aabb-bc00-e50bba3a5f69/tables, then 3538ab33-dc90-45f0-aabb-e50bba3a5f69 is your LIGHTDASH_PROJECT
  • LIGHTDASH_URL​
This is either https://eu1.lightdash.cloud or https://app.lightdash.cloud (check the URL to your Lightdash project)

​
Step 2: Configure deployment schedule

  1. Create or edit a Bolt schedule
  2. Add the lightdash deploy command
  3. This will:
    • Execute after your dbt™ commands complete
    • Deploy changes to your Lightdash project
    • Keep metrics in sync with your dbt™ project
You can configure this as part of a CD schedule to deploy changes automatically after PR merges.
https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy#automatically-deploy-your-changes-to-lightdash-using-a-github-action

Related topics

LightdashRun LightdashCLI and feature availability errorsIntegrationsAsset Details