~/.local/bin/launchable
executable that should be in your PATH
. (See PEP-370 for further details.)launchable verify
in your CI environment to see if you've successfully configured the CLI. If it succeeds, you'll see a message like the one below. If you see an error message, see Troubleshooting.--subset-id ID
launchable subset
.--test-session-id ID
launchable record tests
.--max-days DAYS
30
--source DIR
$PWD
--scrub-pii
record build
, so normally this command need not be invoked separately.--name BUILD_NAME
--max-days DAYS
30
--no-submodules
False
--source REPO_NAME=DIR
(recommended) or --source DIR
label
would be dir/source
for --source dir/source
). We recommend naming labels explicitly (e.g. to keep them stable even when directory names move around), by prepending a label name followed by =
, such as --source vendor=$VENDOR_PATH
.$PWD
--scrub-pii
--no-commit-collection
launchable record commit
elsewhere in your pipeline if you use this option.--commit REPO_NAME=COMMIT_HASH
--no-commit-collection
and launchable record commit
.--commit
is used, --source
is unnecessary--build BUILD_NAME
record build --name
)record build
command. This is only needed in more complex scenarios.launchable subset
and launchable record tests
) in lieu of --build
. We suggest saving the value either to an environment variable or to a text file:~/.config/launchable/sessions/{hash}.txt
. This location may change in the future, so don't rely on it.)--subset-id SUBSETID
launchable subset --split ...
(see --split
under subset
)--bin BIN_NUMBER/BIN_COUNT
--rest FILE
--build BUILD_NAME
record build --name
)--build
or --session
is required--session SESSIONID
record session
)--build
or --session
is required--base DIR
--base
option lets you specify a separate directory to relativize the path of tests before recording them.--target PERCENTAGE
0%-100%
)--target
, --time
or --confidence
is required--time TIME
10m
for 10 minutes, 2h30m
for 2.5 hours, 1w3d
for 7+3=10 days. )--target
, --time
or --confidence
is required--confidence PERCENTAGE
0%-100%
)--target
, --time
or --confidence
is required--flavor KEY=VALUE
flavor
. Flavors must be submitted ahead of time with test reports (see launchable record tests --flavor
below). Supports multiples, e.g. --flavor key1=value1 --flavor key2=value2
.--rest FILE
--target 100%
, all tests will be included in the subset, but to keep test runners from erroring, the --rest
file will contain one test (the last test in the subset file).--split
launchable split-subset
--ignore-new-tests
launchable subset
, these tests will be added to the end of the --rest
file output (if that option is used)TESTRUNNER
s, see Integrations.--build BUILD_NAME
record build --name
)--build
or --session
is required--session SESSIONID
record session
)--build
or --session
is required--flavor KEY=VALUE
launchable subset --flavor
. Supports multiples, e.g. --flavor key1=value1 --flavor key2=value2
.--base DIR
launchable subset --base
option above.TESTRUNNER
, see Integrations​launchable verify || true
in a recognizable spot in your CI process. This way, when you suspect a problem in Launchable, you can check the output of this command as a starting point.--log-level
option to output extra information from each command.--log-level audit
is particularly useful if you want to see exactly what data gets passed to Launchable when you run CLI commands. For example:--plugins
option to tell the CLI where to look for custom profiles/plugins.myProfile.py
, place that file in the directory of your choosing (e.g. ~/launchable-plugins
) and use it like this:--plugins
is a global option, make sure to place it right after launchable
but before subset
or record
in your command.