PipeRider
Search…
Command Reference
PipeRider commands and related options.

Initialize Project

init will lead you to configure the data project according to the type of the data source you choose. Piperider CLI currently supports Snowflake, Postgres and Sqlite.
It will generate a .piperider directory and a few configuration files inside such as .piperider/config.yml , .piperider/credentials.yml and others according to user inputs under your project directory.
piperider init [OPTIONS]
Option
Argument
Description
--no-auto-search
none
Disable the auto search for dbt projects; it is enabled by default
--dbt-project-dir
path
Specify the path to the directory of a dbt project configuration
--dbt-profiles-dir
path
Specify the path to the directory of a dbt profiles configuration
--debug
none
Enable the debug mode
--help
none
List command-line options

Run profiler, assertions, report

The run command performs the following functions.
On first run:
  • Analyzes the data source and generates a data profile.
  • Offers to generate recommended assertions and check the data profile against these them. Assertion files will be generated in .piperider/assertions.
  • Generates blank assertion templates if recommended assertions were not created.
  • Generates a report in .piperider/outputs.
On subsequent runs:
  • Analyzes the data source and generates a data profile.
  • Checks the data profile against any existing assertions located in .piperider/assertions.
  • Generates a report in .piperider/outputs.
Regarding how to configure assertions, please check the assertion configuration for the detail.
piperider run [OPTIONS]
Option
Argument
Description
--datasource
name
Profile a specified data source
--dbt-build
none
Run dbt build prior to profiling
--dbt-test
none
Run dbt test prior to profiling
--debug
none
Enable debugging output
--help
none
List command-line options
--no-interaction
none
Generate assertion templates by default without a prompt
-o, --output
path
Specify the output directory for the generated report
--report-dir
path
Specify the path to read and write reports
--skip-recommend
none
Don't generate recommended assertions
--skip-report
none
Don't generate reports
--table
name
Profile a specified table only

Generate Assertions

Generate recommended assertion files in .piperider/assertions/ . You may want to generate recommended once profiling results are changed.
piperider generate-assertions
Option
Argument
Description
--input
path/to/run.json
Generate a recommended assertions based on a specific profiling run.json file
--debug
none
Enable debugging mode
--help
none
List command-line options

Generate Report

generate-report will generate static HTML reports in .piperider/outputs/<run> based on the profiling results of the latest run by default.
piperider generate-report [Options]
Option
Argument
Description
--debug
none
Enable debugging output
--help
none
List command-line options
--input
path/to/run.json
Generate a report based on a specific profiling run.json file
-o, --output
path
Specify the output directory for the generated report
--report-dir
path
Specify the path to read and write reports

Compare Reports

compare-reports will compare two reports by the selection and generate a static HTML comparison report at .piperider/comparisons/ for each comparison.
piperider compare-reports [Options]
Option
Argument
Description
--base
path
Specify the profiling run.json to use as the base report
--datasource
data source name
Specify the data source to use for the report
comparison (defined in .piperider/config.yml)
--debug
none
Enable debugging output
--help
none
List command-line options
--last
none
Compare the last two reports
-o, --output
path
Specify the output directory for the generated report
--report-dir
path
Specify the path to read and write reports
--target
path
Specify the profiling run.json to compare with the base report

Diagnose Project Configuration

debug shows connections statuses of data sources and checks the current configuration/assertions of the project.
piperider diagnose
Option
Argument
Description
--debug
none
Enable debugging output
--help
none
List command-line options

Love Your Feedback

We love to hear feedbacks from the community. Please don't hesitate to send the feedback that will help improve PipeRider and assure it on the right direction.
piperider feedback
Copy link
On this page
Initialize Project
Run profiler, assertions, report
Generate Assertions
Generate Report
Compare Reports
Diagnose Project Configuration
Love Your Feedback