PipeRider commands and related options.
piperider init [options]
Initializing a project will generate a
.piperiderdirectory containing project configuration files such as
.piperider/credentials.ymland others according to user inputs under your project directory.
piperider run [options]
runcommand 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
- Generate a report in
Generate recommended assertion files in
.piperider/assertions/. You may want to generate recommended once profiling results are changed.
piperider generate-report [options]
Generate static HTML reports in
.piperider/outputs/<run>based on the profiling results of the latest
piperider compare-reports [options]
Compare two selected reports and generate the following output:
- Comparison report (HTML)
- Comparison summary (Markdown)
Comparison reports and summaries are stored in
piperider cloud login
cloud loginwill lead you to signup/login the PipeRider Cloud. Using the command to have the authorization with a valid Token. You will receive an authorizing email by giving your email address. The Token will be stored at
piperider cloud logout
cloud logoutwill clear up the token string stored at
piperider cloud upload-report
upload-reportallows you to select single/multiple profiling reports and upload them to PipeRider Cloud.
piperider cloud compare-reports --base <base-report> --target <target-report>
compare-reportswill compare the two specified reports (
target) and generate a comparison report in your PipeRider Cloud account.
Compare reports with the ID
456and save the Markdown comparison summary to a file named
piperider cloud compare-reports --base 123 --target 456 --summary-file summary.md
Compare the latest reports from the
jaffle-shop-devdata sources and save the Markdown comparison summary to a file named
piperider cloud compare-reports --base datasource:jaffle-shop --target datasource:jaffle-shop-dev --summary-file summary.md
Show data source connection status and check the current configuration and data assertions format.
We love to hear feedback from the community. Help us improve PipeRider by sending your suggestions.