Quickstart: Elementary CLI
Before installing the CLI, make sure to complete the steps dbt package installation, including executing dbt run
with the Elementary package models.
dbt package installation
dbt package installation
How to install Elementary dbt package?
Configuring the Elementary Profile
In order to connect, Elementary needs a connection profile in a file named profiles.yml
.
This profile will be used by the CLI, to connect to the DWH and find the dbt package tables.
The easiest way to generate the profile is to run the following command within the dbt project where you deployed the elementary dbt package (works in dbt cloud as well):
Ensure that you fill in your password and any other missing fields after you
paste the profile in your local profiles.yml
file.
Copy the output, fill in the missing fields and add the profile to your profiles.yml
.
Here is a demonstration:
Elementary profile details and format
- Path:
HOME_DIR/.dbt/profiles.yml
- Profile name:
elementary
- Schema name: The schema of elementary models, default is
<your_dbt_project_schema>_elementary
What is a connection profile?
What is a connection profile?
Elementary requires connection details and credentials to connect to the data warehouse.
These are configured in a connection profile using a file named profiles.yml
.
We recommend creating a dedicated database, or at least a schema.
Elementary leverages dbt's connection profile format.
dbt-core users
Just add a profile with the relevant details, and name it elementary
.
What permissions are required for the elementary profile?
What permissions are required for the elementary profile?
The provided credentials need to have permission to:
- Read - Information schema and the tables configured for monitoring.,
- Write - To the database configured in
elementary
profile, including creating new schemas.
Install Elementary CLI
To install the monitor module run:
Run one of the following commands based on your platform (no need to run all):
Run edr --help
in order to ensure the installation was successful.
If you're receiving command not found: edr
please check our troubleshooting guide.