Skip to content

list

Terminal window
jk list -h
Lists tests at the given path(s)
Usage: jk list [OPTIONS] [path]...
Arguments:
[path]... The path(s) to search for test files
By default, the current path is used
Options:
-r Recursively search for test files
-t, --tag <tag> Select tests to run based on tags
By default, tests must match all given tags to be selected
--tags-or Toggle tag matching logic to select tests matching any of the given tags
-h, --help Print help

Description

Lists all test definitions in the current directory, including path, name, and tag data.

You can also specify one or more test files and/or paths to list, enable recursive searching, and filter tests based on tags via options.

Arguments

ArgumentDefaultDescription
pathThe current path(Optional) The path(s) at which to list test files. These can be single test files, or directories containing one or more files. By default, the current path is used.

Options

OptionValueDescription
‑h
‑‑help
Print command details, arguments, and options to the console.
‑rEnable recursive search for test files.
‑t
‑‑tag
A single tag valueSpecify one or more tags to be matched when searching for test files. By default, test files much match all provided tags to be selected. Each tag should be provided as a separate -t option (e.g. -t tag1 -t tag2).
‑‑tags‑orToggle tag matching behavior to select tests matching any of the provided tags (as opposed to all).