CLI Reference

nydok

Usage:

nydok [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

nydok report

Usage:

nydok report [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

nydok report code-review

Create code review table.

Usage:

nydok report code-review [OPTIONS]

Options:

  -r, --repo-path TEXT  Gitlab repository path. E.g. my-group/my-project.
                        [required]
  -c, --to-ref TEXT     Git ref for end of commit range. Default is default
                        branch configured for repository.
  -f, --from-ref TEXT   Git ref for start of commit range. Default is all
                        history.
  -o, --output PATH     Output path (default: stdout).
  --help                Show this message and exit.

nydok report pipeline-logs

Create pipeline logs report.

Usage:

nydok report pipeline-logs [OPTIONS]

Options:

  -r, --repo-path TEXT       Gitlab repository path. E.g. my-group/my-project.
                             [required]
  -p, --pipeline-id INTEGER  Pipeline ID in Gitlab from which to retrieve job
                             logs.  [required]
  -j, --job-names TEXT       Job names in pipeline for only including certain
                             jobs. Default is all jobs.
  -o, --output PATH          Output path (default: stdout).
  --help                     Show this message and exit.

nydok report risk-assessment

Create risk assessment tables.

Usage:

nydok report risk-assessment [OPTIONS] RESULT

Options:

  -o, --output PATH  Output path (default: stdout).
  --help             Show this message and exit.

nydok report test-cases

Create test case report.

Usage:

nydok report test-cases [OPTIONS] RESULT

Options:

  -o, --output PATH  Output path (default: stdout).
  --help             Show this message and exit.

nydok report test-overview

Create test overview table.

Usage:

nydok report test-overview [OPTIONS] RESULT

Options:

  -o, --output PATH  Output path (default: stdout).
  --help             Show this message and exit.

nydok report traceability-matrix

Create traceability matrix.

Usage:

nydok report traceability-matrix [OPTIONS] RESULT

Options:

  --base-prefix TEXT  Prefix to use as basis (filter).
  --categories TEXT   Categories for traceability (title,prefix). Repeat for
                      multiple.
  -o, --output PATH   Output path (default: stdout).
  --help              Show this message and exit.