@datatrue/cli

CLI to interact with DataTrue.

• @datatrue/cli
  • Install
  • Usage
    • Accounts
    • Data Layer Validations
    • Steps
    • Suites
    • Tag Validations
    • Tests

Install

$ npm i @datatrue/cli -g

Usage

Your DataTrue user API token must be specified either using the --user-token option or the DATATRUE_USER_TOKEN environment variable.

$ dt --help
dt

interactive mode

Commands:
  dt                        interactive mode                           [default]
  dt account                interact with accounts                  [aliases: a]
  dt data-layer-validation  interact with data layer validations  [aliases: dlv]
  dt step                   interact with steps                    [aliases: st]
  dt suite                  interact with suites                    [aliases: s]
  dt tag-validation         interact with tag validations          [aliases: tv]
  dt test                   interact with tests                     [aliases: t]
  dt completion             generate completion script

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]

Accounts

$ dt account --help
dt account

interact with accounts

Commands:
  dt account ls              list accounts
  dt account view <account>  view an account

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]

Data Layer Validations

$ dt data-layer-validation --help
dt data-layer-validation

interact with data layer validations

Commands:
  dt data-layer-validation ls <step>        display data layer validations
  dt data-layer-validation cp               copy a data layer validation
  <data-layer-validation> <step>
  dt data-layer-validation mv               move a data layer validation
  <data-layer-validation> <step>
  dt data-layer-validation rm               delete data layer validations
  <data-layer-validations..>
  dt data-layer-validation view             view a data layer validation
  <data-layer-validation>

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]

Steps

$ dt step --help
dt step

interact with steps

Commands:
  dt step ls <test>         list steps within a test
  dt step cp <step> <test>  copy a step
  dt step mv <step> <test>  move a step
  dt step rm <steps..>      delete steps
  dt step view <step>       view a step

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]

Suites

$ dt suite --help
dt suite

interact with suites

Commands:
  dt suite run <suites..>        run suites
  dt suite ls <account>          list suites
  dt suite cp <suite> <account>  copy a suite
  dt suite mv <suite> <account>  move a suite to a different account
  dt suite rm <suites..>         delete suites
  dt suite view <suite>          view a suite

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]

Tag Validations

$ dt tag-validation --help
dt tag-validation

interact with tag validations

Commands:
  dt tag-validation ls <parent>             list tag validations
  dt tag-validation cp <tag-validation>     copy a tag validation
  <parent>
  dt tag-validation mv <tag-validation>     move a tag validation
  <parent>
  dt tag-validation rm <tag-validations..>  delete tag validations
  dt tag-validation view <tag-validation>   view a tag validation

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]

Tests

$ dt test --help
dt test

interact with tests

Commands:
  dt test run <tests..>      run tests
  dt test ls <suite>         list tests within a suite
  dt test cp <test> <suite>  copy a test
  dt test mv <test> <suite>  move a test
  dt test rm <tests..>       delete tests
  dt test view <test>        view a test

Options:
  -U, --user-token  your DataTrue user API token             [string] [required]
  -H, --host        the DataTrue host you wish to connect to
                                  [string] [default: "https://app.datatrue.com"]
  -v, --version     Show version number                                [boolean]
  -h, --help        Show help                                          [boolean]