Comment on page

run

Generate an Exploratory Data Analysis (EDA) Report

piperider run [options]
The run command performs the following functions.
Analyze the data source and generate a data profile.
(If assertion files exist) Test the data profile against any existing assertions located in .piperider/assertions.
Generate a report in .piperider/outputs.
Check assertion configuration for more information on built-in assertions
Option
Argument
Description
--dbt-profile
Text
The name of the dbt profile to load. This overrides the setting in dbt_project.yml
--dbt-target
Text
The dbt target to load for the given profile
-o, --output
Path
Directory to save the results
--open
N/A
Automatically open the HTML report in your browser
--report-dir
Path
Specify the path to read and write reports relative to the .piperider folder
--skip-report
N/A
Don't generate any reports. (run.json is still generated)
--upload
N/A
Uploads the generated report to PipeRider Cloud (If logged in, see piperider cloud login)
--table
Table name
Profile a specified table only. Deprecated - use --select instead
--select
Model, directory
Specify dbt resources to profile
--debug
N/A
Enable debugging output
--help
N/A
List command-line options

Option	Argument	Description
`--dbt-profile`	Text	The name of the dbt profile to load. This overrides the setting in `dbt_project.yml`
`--dbt-target`	Text	The dbt target to load for the given profile
`-o`, `--output`	Path	Directory to save the results
`--open`	N/A	Automatically open the HTML report in your browser
`--report-dir`	Path	Specify the path to read and write reports relative to the `.piperider` folder
`--skip-report`	N/A	Don't generate any reports. (`run.json` is still generated)
`--upload`	N/A	Uploads the generated report to PipeRider Cloud (If logged in, see `piperider cloud login`)
`--table`	Table name	Profile a specified table only. Deprecated - use `--select` instead
`--select`	Model, directory	Specify dbt resources to profile
`--debug`	N/A	Enable debugging output
`--help`	N/A	List command-line options

feedback

init (deprecated)

Last modified 1mo ago