App::Y...nd::run(3pm)

๐Ÿ’– NAME ๐Ÿ’–

App::Yath::Command::run โ€” bestie, this is the run command, and it is literally here to run your tests using the persistent test runner ๐Ÿ‘‘

(also hiii, you're reading the manual page App::Yath::Command::run(3pm) from the User Contributed Perl Documentation โ€” it also answers to App::Yath::run(3pm), and this is part 1 of 3, so there is more coming, do not go anywhere ๐Ÿซถ)

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

okay so picture this: you've already got a persistent instance up and running (that's a whole separate thing โ€” check the start command for the deets on how to launch a persistant instance, and yes, that's how it's spelled here, we keep it exactly as written, no notes ๐Ÿ’…). This command runs your tests through that already-started persistent instance. that's it, that's the vibe, iconic โœจ

๐ŸŽ€ USAGE ๐ŸŽ€

$ yath [YATH OPTIONS] run [COMMAND OPTIONS]

โœจ YATH OPTIONS โœจ

Developer

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib โ€” drops paths into @INC before loading ANYTHING. This is the one you reach for if you're developing yath or yath plugins, so your yath script finds the local code instead of the installed versions of the same code. You can hand it an argument (-Dfoo) to provide a custom path, or you can just use -D without an arg to add lib, blib/lib and blib/arch. Can be specified multiple times ๐Ÿ’…

Environment

  • --persist-dir ARG, --persist-dir=ARG, --no-persist-dir โ€” where to find persistence files. ๐Ÿ—‚๏ธ
  • --persist-file ARG, --persist-file=ARG, --pfile ARG, --pfile=ARG, --no-persist-file โ€” where to find the persistence file. The default is /{system-tempdir}/project-yath-persist.json. If no project is specified then it will fall back to the current directory. And if the current directory is not writable it will default to /tmp/yath-persist.json, which limits you to one persistent runner on your system ๐Ÿ˜ญ
  • --project ARG, --project=ARG, --project-name ARG, --project-name=ARG, --no-project โ€” this lets you provide a label for your current project/codebase. Best used in a .yath.rc file. And heads up, this is necessary for a persistent runner. no label, no runner, fr fr ๐Ÿซถ

Finder Options

  • --finder MyFinder, --finder +Test2::Harness::Finder::MyFinder, --no-finder โ€” pick which Finder subclass gets used when searching for files / processing the file list. Use the + prefix to specify a fully qualified namespace, otherwise the Test2::Harness::Finder::XXX namespace is assumed. periodt ๐Ÿ”

Help and Debugging

  • --show-opts, --no-show-opts โ€” exit after showing what yath thinks your options mean. like a lil vibe check on your flags ๐Ÿ‘€
  • --version, -V, --no-version โ€” exit after showing a helpful usage message.

Plugins

  • --no-scan-plugins, --no-no-scan-plugins โ€” normally yath scans for and loads all App::Yath::Plugin::* modules in order to bring in command-line options they may provide. This flag disables that. Super useful if you have a naughty plugin that is loading other modules when it should not. ๐Ÿ™ˆ
  • --plugins PLUGIN, --plugins +App::Yath::Plugin::PLUGIN, --plugins PLUGIN=arg1,arg2,..., --plugin PLUGIN, --plugin +App::Yath::Plugin::PLUGIN, --plugin PLUGIN=arg1,arg2,..., -pPLUGIN, --no-plugins โ€” load a yath plugin. Can be specified multiple times ๐Ÿ’–

๐Ÿ”ฅ COMMAND OPTIONS ๐Ÿ”ฅ

Cover Options

  • --cover-aggregator ByTest, --cover-aggregator ByRun, --cover-aggregator +Custom::Aggregator, --cover-agg ByTest, --cover-agg ByRun, --cover-agg +Custom::Aggregator, --no-cover-aggregator โ€” choose a custom aggregator subclass. ๐Ÿ“Š
  • --cover-class ARG, --cover-class=ARG, --no-cover-class โ€” choose a Test2::Plugin::Cover subclass.
  • --cover-dirs ARG, --cover-dirs=ARG, --cover-dir ARG, --cover-dir=ARG, --no-cover-dirs โ€” NO DESCRIPTION - FIX ME ๐Ÿ˜ญ (yes bestie, that is literally what the page says, I am not about to invent something). Can be specified multiple times
  • --cover-exclude-private, --no-cover-exclude-private, --cover-files, --no-cover-files โ€” use Test2::Plugin::Cover to collect coverage data for what files are touched by what tests. Unlike Devel::Cover this has very little performance impact (About 4% difference). slay ๐Ÿ”ฅ
  • --cover-from path/to/log.jsonl, --cover-from http://example.com/coverage, --cover-from path/to/coverage.jsonl, --no-cover-from โ€” this can be a test log, a coverage dump (old style json or new jsonl format), or a url to any of the previous. Tests will not be run if the file/url is invalid. โš ๏ธ
  • --cover-from-type json, --cover-from-type jsonl, --cover-from-type log, --no-cover-from-type โ€” file type for the coverage source. Usually it can be detected, but when it cannot be, you should specify. "json" is old style single-blob coverage data, "jsonl" is the new by-test style, "log" is a logfile from a previous run.
  • --cover-manager My::Coverage::Manager, --no-cover-manager โ€” coverage 'from' manager to use when coverage data does not provide one.
  • --cover-maybe-from path/to/log.jsonl, --cover-maybe-from http://example.com/coverage, --cover-maybe-from path/to/coverage.jsonl, --no-cover-maybe-from โ€” this can be a test log, a coverage dump (old style json or new jsonl format), or a url to any of the previous. Tests will coninue even if the coverage file/url is invalid. (and yes โ€” "coninue" โ€” that's the typo straight off the page and honestly? keeping it exactly as written, iconic ๐Ÿ’€)
  • --cover-maybe-from-type json, --cover-maybe-from-type jsonl, --cover-maybe-from-type log, --no-cover-maybe-from-type โ€” same as "from_type" but for "maybe_from". Defaults to "from_type" if that is specified, otherwise auto-detect.
  • --cover-metrics, --no-cover-metrics, --cover-types ARG, --cover-types=ARG, --cover-type ARG, --cover-type=ARG, --no-cover-types โ€” NO DESCRIPTION - FIX ME ๐Ÿ˜ญ. Can be specified multiple times
  • --cover-write, --cover-write=coverage.jsonl, --cover-write=coverage.json, --no-cover-write โ€” create a json or jsonl file of all coverage data seen during the run (this implies --cover-files). ๐ŸŽ€

Display Options

  • --color, --no-color โ€” turn color on, default is true if STDOUT is a TTY. ๐ŸŒˆ
  • --hide-runner-output, --no-hide-runner-output โ€” hide output from the runner, showing only test output. (See Also truncate_runner_output.)
  • --no-final-table, --no-no-final-table โ€” when printing final results, don't use table-style display. ๐Ÿ™…
  • --no-wrap, --no-no-wrap โ€” do not do fancy text-wrapping, let the terminal handle it.
  • --progress, --no-progress โ€” toggle progress indicators. On by default if STDOUT is a TTY. You can use --no-progress to disable the 'events seen' counter and buffered event pre-display. โœจ
  • --quiet, -q, --no-quiet โ€” be very quiet. Can be specified multiple times ๐Ÿคซ
  • --renderers +My::Renderer, --renderers Renderer=arg1,arg2,..., --renderer +My::Renderer, --renderer Renderer=arg1,arg2,..., --no-renderers โ€” specify renderers, (Default: "Formatter=Test2"). Use "+" to give a fully qualified module name. Without "+", "Test2::Harness::Renderer::" will be prepended to your argument. Can be specified multiple times. If the same key is listed multiple times the value lists will be appended together. ๐Ÿงš
  • --show-times, -T, --no-show-times โ€” show the timing data for each job. โฑ๏ธ
  • --term-width 80, --term-width 200, --term-size 80, --term-size 200, --no-term-width โ€” alternative to setting $TABLE_TERM_SIZE. Setting this will override the terminal width detection to the number of characters specified.
  • --truncate-runner-output, --no-truncate-runner-output โ€” only show runner output that was generated after the current command. This is only useful with a persistent runner.
  • --verbose, -v, --no-verbose โ€” be more verbose. Can be specified multiple times ๐Ÿ—ฃ๏ธ

Finder Options

  • --changed path/to/file, --no-changed โ€” specify one or more files as having been changed. Can be specified multiple times
  • --changed-only, --no-changed-only โ€” only search for tests for changed files (Requires a coverage data source, also requires a list of changes either from the --changed option, or a plugin that implements changed_files() or changed_diff()). ๐Ÿ‘€
  • --changes-diff path/to/diff.diff, --no-changes-diff โ€” path to a diff file that should be used to find changed files for use with --changed-only. This must be in the same format as git diff -W --minimal -U1000000. ๐Ÿฉท
  • --changes-exclude-file path/to/file, --no-changes-exclude-file โ€” specify one or more files to ignore when looking at changes. Can be specified multiple times ๐Ÿ™ˆ
  • --changes-exclude-loads, --no-changes-exclude-loads โ€” exclude coverage tests which only load changed files, but never call code from them. (default: off)
  • --changes-exclude-nonsub, --no-changes-exclude-nonsub โ€” exclude changes outside of subroutines (perl files only) (default: off)
  • --changes-exclude-opens, --no-changes-exclude-opens โ€” exclude coverage tests which only open() changed files, but never call code from them. (default: off)
  • --changes-exclude-pattern '(apple|pear|orange)', --no-changes-exclude-pattern โ€” ignore files matching this pattern when looking for changes. Your pattern will be inserted unmodified into a $file =~ m/$pattern/ check. Can be specified multiple times ๐ŸŽ๐Ÿ๐ŸŠ
  • --changes-filter-file path/to/file, --no-changes-filter-file โ€” specify one or more files to check for changes. Changes to other files will be ignored. Can be specified multiple times
  • --changes-filter-pattern '(apple|pear|orange)', --no-changes-filter-pattern โ€” specify a pattern for change checking. When only running tests for changed files this will limit which files are checked for changes. Only files that match this pattern will be checked. Your pattern will be inserted unmodified into a $file =~ m/$pattern/ check. Can be specified multiple times
  • --changes-include-whitespace, --no-changes-include-whitespace โ€” include changed lines that are whitespace only (default: off)
  • --changes-plugin Git, --changes-plugin +App::Yath::Plugin::Git, --no-changes-plugin โ€” what plugin should be used to detect changed files. ๐Ÿ”
  • --default-at-search ARG, --default-at-search=ARG, --no-default-at-search โ€” specify the default file/dir search when 'AUTHOR_TESTING' is set. Defaults to './xt'. The default AT search is only used if no files were specified at the command line. Can be specified multiple times
  • --default-search ARG, --default-search=ARG, --no-default-search โ€” specify the default file/dir search. Defaults to './t', './t2', and 'test.pl'. The default search is only used if no files were specified at the command line. Can be specified multiple times ๐ŸŽฏ

okay that's everything in part 1 bestie, hold on tight because there is more coming ๐Ÿซถ

  • --durations file.json, --durations http://example.com/durations.json, --no-durations โ€” point this at a json file or a url that holds a hash where the keys are relative test filenames and the values are 'SHORT', 'MEDIUM', or 'LONG'. This overrides the durations that were listed in the file headers. If the durations file or url doesn't work, an exception gets thrown. no cap, it will yell ๐Ÿ’…
  • --durations-threshold ARG, --durations-threshold=ARG, --Dt ARG, --Dt=ARG, --no-durations-threshold โ€” only bother fetching duration data if you're running at least this many tests. Default is (-j value + 1). ๐Ÿงฎ
  • --exclude-file t/nope.t, --no-exclude-file โ€” exclude a file from testing ๐Ÿ™ˆ

Can be specified multiple times

  • --exclude-list file.txt, --exclude-list http://example.com/exclusions.txt, --no-exclude-list โ€” point at a file or url that has a newline-separated list of test file names to exclude from testing. Start a line with # and it gets commented out (that's for compatibility with Test2::Aggregate list files, iykyk). ๐Ÿ“

Can be specified multiple times

  • --exclude-pattern t/nope.t, --no-exclude-pattern โ€” exclude a pattern from testing, matched using m/$PATTERN/ ๐ŸŽฏ

Can be specified multiple times

  • --extension ARG, --extension=ARG, --ext ARG, --ext=ARG, --no-extension โ€” tell it which test filename extensions are valid, default: t and t2 โœจ

Can be specified multiple times

  • --maybe-durations file.json, --maybe-durations http://example.com/durations.json, --no-maybe-durations โ€” point at a json file or a url with a hash where the keys are relative test filenames and the values are 'SHORT', 'MEDIUM', or 'LONG'. This overrides the durations listed in the file headers. An exception gets thrown if the durations file or url doesn't work. same energy as --durations, just vibing under a different name fr fr
  • --no-long, --no-no-long โ€” do not run tests that have their duration flag set to 'LONG' ๐Ÿ›‘
  • --only-long, --no-only-long โ€” only run tests that have their duration flag set to 'LONG' ๐Ÿ‘‘
  • --rerun, --rerun=path/to/log.jsonl, --rerun=plugin_specific_string, --no-rerun โ€” re-run tests from a previous run, pulled from a log file (or the last log file if you don't name one). Plugins can intercept this โ€” for example YathUIDB, which grabs a run UUID and derives the tests to re-run from that. ๐Ÿ”
  • --rerun-all, --rerun-all=path/to/log.jsonl, --rerun-all=plugin_specific_string, --no-rerun-all โ€” re-run all the tests from a previous run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB, which grabs a run UUID and derives tests to re-run from that. ๐Ÿ’–
  • --rerun-failed, --rerun-failed=path/to/log.jsonl, --rerun-failed=plugin_specific_string, --no-rerun-failed โ€” re-run the failed tests from a previous run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB, which grabs a run UUID and derives tests to re-run from that. ๐Ÿ˜ญ
  • --rerun-missed, --rerun-missed=path/to/log.jsonl, --rerun-missed=plugin_specific_string, --no-rerun-missed โ€” run the tests that got missed by a previously aborted/stopped run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB, which grabs a run UUID and derives tests to re-run from that. ๐Ÿซฅ
  • --rerun-modes failed,missed,..., --rerun-modes all, --rerun-modes failed, --rerun-modes missed, --rerun-modes passed, --rerun-modes retried, --rerun-mode failed,missed,..., --rerun-mode all, --rerun-mode failed, --rerun-mode missed, --rerun-mode passed, --rerun-mode retried, --no-rerun-modes โ€” pick which test categories actually get run ๐ŸŽ›๏ธ

Can be specified multiple times

  • --rerun-passed, --rerun-passed=path/to/log.jsonl, --rerun-passed=plugin_specific_string, --no-rerun-passed โ€” re-run the passed tests from a previous run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB, which grabs a run UUID and derives tests to re-run from that. ๐ŸŒˆ
  • --rerun-plugin Foo, --rerun-plugin +App::Yath::Plugin::Foo, --no-rerun-plugin โ€” which plugin(s) should be used for rerun (it'll fall back to other plugins if the listed ones decline the value, this is just used to set an order of priority) ๐Ÿงš

Can be specified multiple times

  • --rerun-retried, --rerun-retried=path/to/log.jsonl, --rerun-retried=plugin_specific_string, --no-rerun-retried โ€” re-run the tests that got retried in a previous run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB, which grabs a run UUID and derives tests to re-run from that. ๐Ÿ”„
  • --search ARG, --search=ARG, --no-search โ€” a list of tests and test directories to use instead of the default search paths. Lowkey you can usually just list these as plain command line arguments without the --search prefix. ๐Ÿ”

Can be specified multiple times

  • --show-changed-files, --no-show-changed-files โ€” print a list of changed files if any are found ๐Ÿ“‚

โœจ Formatter Options โœจ

  • --formatter ARG, --formatter=ARG, --no-formatter โ€” the manpage literally just says NO DESCRIPTION - FIX ME ๐Ÿ’€ keeping it 100, that's all it says, so that's all I'm telling you
  • --qvf, --no-qvf โ€” [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests when they pass, except to say they passed. But if a test fails, then ALL the output from that test gets verbosely dumped out. iconic behaviour honestly ๐Ÿ’…
  • --show-job-end, --no-show-job-end โ€” show output when a job ends. (Default: on) ๐Ÿ
  • --show-job-info, --no-show-job-info โ€” show the job configuration when a job starts. (Default: off, unless -vv) ๐Ÿ“‹
  • --show-job-launch, --no-show-job-launch โ€” show output for the start of a job. (Default: off unless -v) ๐Ÿš€
  • --show-run-info, --no-show-run-info โ€” show the run configuration when a run starts. (Default: off, unless -vv) ๐ŸŽฌ

๐ŸŒธ Git Options ๐ŸŒธ

  • --git-change-base master, --git-change-base HEAD^, --git-change-base df22abe4, --no-git-change-base โ€” find the files changed by all the commits in the current branch, starting from the most recent and stopping when you hit a commit that's also present in the history of the branch/commit you specified as the change base. ๐Ÿฆ‹

๐ŸŽ€ Help and Debugging ๐ŸŽ€

  • --dummy, -d, --no-dummy โ€” dummy run, it doesn't actually execute anything ๐Ÿ™ƒ

Can also be set with the following environment variables: T2_HARNESS_DUMMY

  • --help, -h, --no-help โ€” exit after showing help information ๐Ÿ†˜
  • --interactive, -i, --no-interactive โ€” use interactive mode, 1 test at a time, with stdin forwarded to it ๐ŸŽฎ
  • --keep-dirs, --keep_dir, -k, --no-keep-dirs โ€” do not delete directories when done. super useful if you wanna go snooping through the directories that various commands used. ๐Ÿ”Ž
  • --procname-prefix ARG, --procname-prefix=ARG, --no-procname-prefix โ€” add a prefix to all proc names (as seen by ps). ๐Ÿท๏ธ
  • --summary, --summary=/path/to/summary.json, --no-summary โ€” write out a summary json file; if you don't give it a path, 'summary.json' gets used. The .json extension is added automatically if you omit it. ๐Ÿ“Š

๐Ÿ’œ Logging Options ๐Ÿ’œ

  • --bzip2, --bz2, --bzip2_log, -B, --no-bzip2 โ€” use bzip2 compression when writing the log. This option implies -L. The .bz2 prefix is added to the log file name for you. ๐Ÿ—œ๏ธ
  • --gzip, --gz, --gzip_log, -G, --no-gzip โ€” use gzip compression when writing the log. This option implies -L. The .gz prefix is added to the log file name for you. ๐Ÿ—œ๏ธ
  • --log, -L, --no-log โ€” turn on logging ๐Ÿ““
  • --log-dir ARG, --log-dir=ARG, --no-log-dir โ€” specify a log directory. Will fall back to the system temp dir. ๐Ÿ“
  • --log-file ARG, --log-file=ARG, -F ARG, -F=ARG, --no-log-file โ€” specify the name of the log file. This option implies -L. ๐Ÿ“
  • --log-file-format ARG, --log-file-format=ARG, --lff ARG, --lff=ARG, --no-log-file-format โ€” specify the format for automatically-generated log files. Overridden by --log-file, if given. This option implies -L (Default: $YATH_LOG_FILE_FORMAT, if that is set, or else "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string where percent-escape sequences get replaced as per POSIX::strftime. These special escape sequences also get replaced: (%!P : project name followed by a ~, if a project is defined, otherwise an empty string) (%!U : the unique test run ID) (%!p : the process ID) (%!S : the number of seconds since local midnight UTC) โฐ

Can also be set with the following environment variables: YATH_LOG_FILE_FORMAT, TEST2_HARNESS_LOG_FORMAT


๐Ÿ”” Notification Options ๐Ÿ””

  • --notify-email foo@example.com, --no-notify-email โ€” email the test results to the specified email address(es) ๐Ÿ“ง

Can be specified multiple times

  • --notify-email-fail foo@example.com, --no-notify-email-fail โ€” email the failing results to the specified email address(es) ๐Ÿ˜ฌ

Can be specified multiple times

  • --notify-email-from foo@example.com, --no-notify-email-from โ€” if any email gets sent, this is who it will be from โœ‰๏ธ
  • --notify-email-owner, --no-notify-email-owner โ€” email the owner of the broken test files upon failure. Add # HARNESS-META-OWNER foo@example.com to the top of a test file to give it an owner. ๐Ÿ‘ค
  • --notify-no-batch-email, --no-notify-no-batch-email โ€” usually owner failures get sent as a single batch at the end of testing. Toggle this to send failures as they happen. โšก
  • --notify-no-batch-slack, --no-notify-no-batch-slack โ€” usually owner failures get sent as a single batch at the end of testing. Toggle this to send failures as they happen. โšก
  • --notify-slack '#foo', --notify-slack '@bar', --no-notify-slack โ€” send results to a slack channel and/or user ๐Ÿ’ฌ

Can be specified multiple times

  • --notify-slack-fail '#foo', --notify-slack-fail '@bar', --no-notify-slack-fail โ€” send the failing results to a slack channel and/or user ๐Ÿ’”

Can be specified multiple times

  • --notify-slack-owner, --no-notify-slack-owner โ€” send slack notifications to the slack channels/users listed in the test meta-data when tests fail. ๐Ÿ“จ
  • --notify-slack-url https://hooks.slack.com/..., --no-notify-slack-url โ€” specify an API endpoint for slack webhook integrations. ๐Ÿ”—
  • --notify-text ARG, --notify-text=ARG, --message ARG, --message=ARG, --msg ARG, --msg=ARG, --no-notify-text โ€” add a custom text snippet to email/slack notifications โœ๏ธ
  • --notify-text-module ARG, --notify-text-module=ARG, --message_module ARG, --message_module=ARG, --no-notify-text-module โ€” use the specified module to generate messages for emails and/or slack. ๐Ÿงฉ

โญ Run Options โญ

  • --author-testing, -A, --no-author-testing โ€” this flips the AUTHOR_TESTING environment variable to true. Yeah bestie, some tests literally will not run unless they know you're the author, and this is how you tell them. ๐Ÿ’–
  • --dbi-profiling, --no-dbi-profiling โ€” pulls in Test2::Plugin::DBIProfile so you're collecting database profiling data while the tests run. Gotta see where the queries are eating your time, fr fr. ๐Ÿ”ฅ
  • --env-var VAR=VAL, -EVAR=VAL, -E VAR=VAL, --no-env-var โ€” sets environment variables that get applied when each test runs. ๐ŸŒˆ

Can be specified multiple times, so stack 'em up.

  • --event-uuids, --uuids, --no-event-uuids โ€” uses Test2::Plugin::UUID inside tests. Default: on. The UUIDs are giving uniqueness, and honestly? Iconic. โœจ
  • --fields name:details, --fields JSON_STRING, -f name:details, -f JSON_STRING, --no-fields โ€” adds custom data to the harness run. Very main-character of you to leave your own little notes in there. ๐Ÿ’…

Can be specified multiple times.

  • --input ARG, --input=ARG, --no-input โ€” an input string used as standard input for ALL tests. Literally all of them. Also check out --input-file if a string isn't enough. ๐ŸŽ€
  • --input-file ARG, --input-file=ARG, --no-input-file โ€” same energy, but you point at a file, and that file becomes standard input for ALL tests. ๐Ÿ“
  • --io-events, --no-io-events โ€” uses Test2::Plugin::IOEvents inside tests, which turns all prints into test2 events. Default: off. So if you don't set this, your prints stay prints. ๐Ÿฆ‹
  • --link 'https://travis.work/builds/42', --link 'https://jenkins.work/job/42', --link 'https://buildbot.work/builders/foo/builds/42', --no-link โ€” drops one or more links so people can go look at more info about this run. Sharing is caring, bestie. ๐Ÿซถ

Can be specified multiple times.

  • --load ARG, --load=ARG, --load-module ARG, --load-module=ARG, -m ARG, -m=ARG, --no-load โ€” loads a module in each test, and this happens after fork. The import method is not called. Not even a little bit. ๐Ÿ‘€

Can be specified multiple times.

  • --load-import Module, --load-import Module=import_arg1,arg2,..., --loadim Module, --loadim Module=import_arg1,arg2,..., -M Module, -M Module=import_arg1,arg2,..., --no-load-import โ€” also loads a module in each test after fork, but this time import is called. ๐ŸŒธ

Can be specified multiple times. And heads up: if the same key shows up multiple times, the value lists get appended together. No overwriting, just vibes stacking. โœจ

  • --mem-usage, --no-mem-usage โ€” uses Test2::Plugin::MemUsage inside tests. Default: on. Watching the memory like ๐Ÿ‘€๐Ÿ’€
  • --retry ARG, --retry=ARG, -r ARG, -r=ARG, --no-retry โ€” runs any job that failed a second time. And please clock this: --retry=1 means failing tests get attempted twice! The number isn't "extra tries", it's total tries. Not me learning this the hard way. ๐Ÿ˜ญ
  • --retry-isolated, --retry-iso, --no-retry-isolated โ€” if true, any job retries happen in isolation, like -j1 was set. Alone time for the retry, as it deserves. ๐Ÿง˜
  • --run-id, --id, --no-run-id โ€” sets a specific run-id. Default: a UUID. ๐Ÿ†”
  • --test-args ARG, --test-args=ARG, --no-test-args โ€” arguments to pass in as @ARGV for all tests that run. And the easy-mode version is using the '::' argument separator. ๐Ÿ’…

Can be specified multiple times.

  • --stream, --no-stream โ€” uses the stream formatter. Default is on. Stream it, obviously. ๐Ÿ“ก
  • --tap, --TAP, ----no-stream, --no-tap โ€” okay so listen. The TAP format is lossy and clunky, no shade to TAP but it's true. Test2::Harness normally uses a newer streaming format to receive test results. But there are old/legacy tests out there where that newer thing causes problems, and in those cases setting --TAP or --no-stream can help. ๐Ÿ›Ÿ
Yes, ----no-stream really has four dashes up there. Copy it exactly, bestie. Do not "fix" it. ๐Ÿ™ˆ

โœจ YathUI Options โœจ

  • --yathui-api-key ARG, --yathui-api-key=ARG, --no-yathui-api-key โ€” your Yath-UI API key. You don't need it if your Yath-UI instance is set to single-user. ๐Ÿ”‘
  • --yathui-coverage, --no-yathui-coverage โ€” polls coverage data from Yath-UI to figure out which tests should run for changed files. Smart girl behavior. ๐Ÿ‘‘
  • --yathui-durations, --no-yathui-durations โ€” polls duration data from Yath-UI to help order tests efficiently. Efficiency is a love language. โฑ๏ธ
  • --yathui-grace, --no-yathui-grace โ€” normally if yath can't connect to yath-ui it throws an error. Turn this on and it fails gracefully instead: you get a warning, but things keep going. ๐Ÿฆ‹
  • --yathui-long-duration 10, --no-yathui-long-duration โ€” the minimum duration length, in seconds, before a test graduates from MEDIUM to LONG. Glow-up thresholds. โœจ
  • --yathui-medium-duration 5, --no-yathui-medium-duration โ€” the minimum duration length, in seconds, before a test goes from SHORT to MEDIUM. The middle child zone. ๐ŸŽ€
  • --yathui-mode summary, --yathui-mode qvf, --yathui-mode qvfd, --yathui-mode complete, --no-yathui-mode โ€” sets the upload mode. Default is 'qvfd'. That's the one. ๐Ÿ’–
  • --yathui-project ARG, --yathui-project=ARG, --no-yathui-project โ€” the Yath-UI project your test results belong to. ๐Ÿ—‚๏ธ
  • --yathui-retry, --no-yathui-retry โ€” how many times to try an operation before giving up. Persistence, but make it bounded. ๐Ÿ’ช

Can be specified multiple times.

NO CATEGORY - FIX ME

  • --check-reload-state, --no-check-reload-state โ€” aborts the run if there are unfixes reload errors, and shows a confirmation dialogue for unfixed reload warnings. It is, genuinely, checking on the reload state. ๐Ÿšจ
unfixes and unfixed โ€” that's exactly how it's written in the original, so we are keeping it exactly, no cap.

๐ŸŒŸ SOURCE ๐ŸŒŸ

The source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/. Go look, bestie, it's all right there. ๐Ÿซถ


๐Ÿ‘‘ MAINTAINERS ๐Ÿ‘‘

Chad Granum <exodist@cpan.org>


๐Ÿ’– AUTHORS ๐Ÿ’–

Chad Granum <exodist@cpan.org>


Copyright 2026 Chad Granum <exodist7@gmail.com>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://dev.perl.org/licenses/


And that's the whole page, bestie, you made it to the end of part three ๐ŸŽ‰๐Ÿฆ‹โœจ This came from perl v5.40.1, generated 2026-05-10, and it's the App::Y...nd::run(3pm) page from the User Contributed Perl Documentation. You're officially fluent now. Slay. ๐Ÿ’…๐ŸŒˆ

๐Ÿ“ฆ where this page comes from