Shaztra CLI

Shaztra CLI is a command line interface for Shaztra. Use it for your CI/CD pipelines, or to manage your Shaztra projects.

• Usage
• Commands

Usage

$ npm install -g @shaztra/cli
$ shaztra COMMAND
running command...
$ shaztra (--version)
@shaztra/cli/0.1.1 darwin-x64 node-v16.14.2
$ shaztra --help [COMMAND]
USAGE
  $ shaztra COMMAND
...

Commands

• shaztra report plan RUNREPORTID
• shaztra report test RUNREPORTID
• shaztra run plan
• shaztra run test

shaztra report plan RUNREPORTID

View Run Reports

USAGE
  $ shaztra report plan [RUNREPORTID] -a <value> -w <value> [-d | ]

ARGUMENTS
  RUNREPORTID  Run Report ID to view results for

FLAGS
  -a, --authToken=<value>    (required) Your auth token
  -d, --detailed             Show detailed view
  -w, --workspaceId=<value>  (required) Workspace identifier

DESCRIPTION
  View Run Reports

EXAMPLES
  $ shaztra report plan lHXnQ9aWlrKc2HoOICG6
  Run Report ID: lHXnQ9aWlrKc2HoOICG6
  Status: passed

shaztra report test RUNREPORTID

View Run Reports

USAGE
  $ shaztra report test [RUNREPORTID] -a <value> -w <value> [-d | ]

ARGUMENTS
  RUNREPORTID  Run Report ID to view results for

FLAGS
  -a, --authToken=<value>    (required) Your auth token
  -d, --detailed             Show detailed view
  -w, --workspaceId=<value>  (required) Workspace identifier

DESCRIPTION
  View Run Reports

EXAMPLES
  $ shaztra report test lHXnQ9aWlrKc2HoOICG6
  Run Report ID: lHXnQ9aWlrKc2HoOICG6
  Status: passed

shaztra run plan

Run Shaztra Plan

USAGE
  $ shaztra run plan -a <value> -w <value> [-i <value> | -t <value>] [-v <value>] [-r]

FLAGS
  -a, --authToken=<value>    (required) Your auth token
  -i, --id=<value>           Plan identifier to run
  -r, --waitForResults       Wait for results to be available
  -t, --tag=<value>...       Plan tag to run
  -v, --var=<value>...       Variables to use in the plan
  -w, --workspaceId=<value>  (required) Workspace identifier

DESCRIPTION
  Run Shaztra Plan

EXAMPLES
  $ shaztra run plan <plan-id>
  successfully triggered 1 runs
  Run Report ID: zfPLgxJ6lxPwwzILuQOi
  Status: running

shaztra run test

Run Shaztra Test

USAGE
  $ shaztra run test -a <value> -w <value> [-i <value> | -t <value>] [-v <value>] [-r]

FLAGS
  -a, --authToken=<value>    (required) Your auth token
  -i, --id=<value>           Test identifier to run
  -r, --waitForResults       Wait for results to be available
  -t, --tag=<value>...       Test tag to run
  -v, --var=<value>...       Variables to use in the test
  -w, --workspaceId=<value>  (required) Workspace identifier

DESCRIPTION
  Run Shaztra Test

EXAMPLES
  $ shaztra run test <test-id>
  successfully triggered 1 runs
  Run Report ID: zfPLgxJ6lxPwwzILuQOi
  Status: running