App::Yath::Command::spawn - Launch a perl script from the preloaded environment


This will launch the specified script from the preloaded yath process.

NOTE: environment variables are not automatically passed to the spawned process. You must use -e or -E (see help) to specify what environment variables you care about.






Add paths to @INC before loading ANYTHING. This is what you use if you are developing yath or yath plugins to make sure the yath script finds the local code instead of the installed versions of the same code. You can provide an argument (-Dfoo) to provide a custom path, or you can just use -D without and arg to add lib, blib/lib and blib/arch.

Can be specified multiple times


--persist-dir ARG

Where to find persistence files.

--persist-file ARG
--pfile ARG

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. 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-name ARG

This lets you provide a label for your current project/codebase. This is best used in a .yath.rc file. This is necessary for a persistent runner.

Help and Debugging


Exit after showing what yath thinks your options mean


Exit after showing a helpful usage message



Normally yath scans for and loads all App::Yath::Plugin::* modules in order to bring in command-line options they may provide. This flag will disable that. This is useful if you have a naughty plugin that it 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,...

Load a yath plugin.

Can be specified multiple times


Git Options

--git-change-base master
--git-change-base HEAD^
--git-change-base df22abe4

Find files changed by all commits in the current branch from most recent stopping when a commit is found that is also present in the history of the branch/commit specified as the change base.

Help and Debugging


Dummy run, do not actually execute anything

Can also be set with the following environment variables: T2_HARNESS_DUMMY


exit after showing help information


Do not delete directories when done. This is useful if you want to inspect the directories used for various commands.

YathUI Options

--yathui-api-key ARG

Yath-UI API key. This is not necessary if your Yath-UI instance is set to single-user


If yath cannot connect to yath-ui it normally throws an error, use this to make it fail gracefully. You get a warning, but things keep going.

--yathui-long-duration 10

Minimum duration length (seconds) before a test goes from MEDIUM to LONG

--yathui-medium-duration 5

Minimum duration length (seconds) before a test goes from SHORT to MEDIUM

--yathui-mode summary
--yathui-mode qvf
--yathui-mode qvfd
--yathui-mode complete

Set the upload mode (default 'qvfd')

--yathui-project ARG

The Yath-UI project for your test results


How many times to try an operation before giving up

Can be specified multiple times


Yath-UI url

spawn options

--copy-env HOME
--copy-env SHELL
--copy-env /PERL_.*/i
-e /PERL_.*/i

Specify environment variables to pass along with their current values, can also use a regex

Can be specified multiple times

--env-var VAR=VAL

Set environment variables for the spawn

Can be specified multiple times

--stage foo
-s foo

Specify the stage to be used for launching the script


The source code repository for Test2-Harness can be found at


Chad Granum <>


Chad Granum <>


Copyright 2020 Chad Granum <>.

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