> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paradime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Lightdash

export const Arcade = ({src, title}) => <div style={{
  position: 'relative',
  paddingBottom: 'calc(56.2225% + 41px)',
  height: 0,
  width: '100%'
}}>
    <iframe src={src} title={title} frameBorder="0" loading="lazy" allow="clipboard-write" allowFullScreen style={{
  position: 'absolute',
  top: 0,
  left: 0,
  width: '100%',
  height: '100%',
  colorScheme: 'light'
}} />
  </div>;

[Lightdash](https://www.lightdash.com/) transforms your dbt™ project into a full-stack BI platform, enabling self-serve analytics for your entire organization. Paradime's native integration with Lightdash CLI allows you to develop and deploy Lightdash metrics directly from your development environment.

<Warning>
  **Prerequisites**

  Before getting started, you'll need:

  * A Lightdash instance ([Cloud](https://app.lightdash.cloud/) or [Self-hosted](https://docs.lightdash.com/self-host/self-host-lightdash))
  * 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](https://docs.lightdash.com/self-host/lightdash-cloud-vs-self-hosted).
</Warning>

### Development Setup

#### Authenticating with LightDash

1. In the [Code IDE](/products/code-ide/index), open the Paradime [Integrated Terminal](/products/code-ide/terminal/index)
2. Follow [Lightdash documentation](https://docs.lightdash.com/guides/cli/cli-authentication/) and run authentication commands.
3. Follow the prompts to complete authentication

<Arcade src="https://demo.arcade.software/6B4zyKyunt3fPrTdQa3d?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Lightdash" />

#### Using Lightdash CL

The Lightdash CLI in Paradime enables you to:

* [Autogenerate Lightdash-ready](https://docs.lightdash.com/guides/cli/how-to-auto-generate-schema-files) YAML files
* [Preview metrics](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-preview) before deployment
* [Deploy changes](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy) to your Lightdash instance

View available commands:

```bash theme={"system"}
lightdash --help
```

## Deployment Setup

Enable automatic deployment of your dbt™ project changes to Lightdash using Paradime [Bolt schedules](/products/bolt/index).

#### 1. Configure Lightdash Credentials

1. From any page in Paradime, Click **Settings**
2. Navigate to **Workspaces > Environment Variables**
3. In the [**Bolt Schedules**](/products/settings/environment-variables/bolt-schedule-env-variables) section, click **Add New**
4. Configure each required variable:
   * `LIGHTDASH_API_KEY`: Personal access token
   * `LIGHTDASH_PROJECT`: Project UUID
   * `LIGHTDASH_URL`: Instance URL

<Accordion title="Finding your Lightdash credentials">
  * **`LIGHTDASH_API_KEY`[​](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy#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`.

  <img src="https://mintcdn.com/paradime-docs/KJcB9NhKTmxLMoZP/images/image-11-1-1-1-1-1.png?fit=max&auto=format&n=KJcB9NhKTmxLMoZP&q=85&s=1df69cdf0aae0c3ecf5eca71276ee961" alt="" width="2608" height="1034" data-path="images/image-11-1-1-1-1-1.png" />

  * **`LIGHTDASH_PROJECT`[​](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy#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`[​](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy#lightdash_url)**

  This is either `https://eu1.lightdash.cloud` or `https://app.lightdash.cloud` (check the URL to your Lightdash project)
</Accordion>

#### 2. Configure Deployment Schedule

1. Create or edit a [Bolt schedule](/products/bolt/index)
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

<Info>
  You can configure this as part of a [CD schedule](/products/bolt/ci-cd/continuous-deployment-with-bolt/continuous-deployment) to deploy changes automatically after PR merges.
</Info>

[https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy#automatically-deploy-your-changes-to-lightdash-using-a-github-action](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-deploy#automatically-deploy-your-changes-to-lightdash-using-a-github-action)


## Related topics

- [Lightdash Commands](/products/bolt/creating-schedules/command-settings/lightdash-commands.md)
- [CLI and feature availability errors](/get-help/error-list/cli-and-feature-availability-errors.md)
- [3. Command Settings](/products/bolt/creating-schedules/command-settings/index.md)