App::Yath::Command::auditor - For internal use only


No Description


    $ yath [YATH OPTIONS] auditor [COMMAND OPTIONS]




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


Add the YathUI DB renderer in addition to other renderers


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')


Only use the YathUI renderer


Only use the YathUI DB renderer

--yathui-port 8080

Port to use when running a local server

--yathui-port-command --pid $$

Use a command to get a port number. "$$" will be replaced with the PID of the yath process

--yathui-project ARG

The Yath-UI project for your test results


Add the YathUI renderer in addition to other renderers


How many times to try an operation before giving up

Can be specified multiple times

--yathui-schema PostgreSQL
--yathui-schema MySQL
--yathui-schema MySQL56

What type of DB/schema to use when using a temporary database


Yath-UI url

--yathui-user ARG

Username to attach to the data sent to the db

--yathui-db-buffering none
--yathui-db-buffering job
--yathui-db-buffering diag
--yathui-db-buffering run

Type of buffering to use, if "none" then events are written to the db one at a time, which is SLOW

--yathui-db-config ARG

Module that implements 'MODULE->yath_ui_config(%params)' which should return a Test2::Harness::UI::Config instance.

--yathui-db-driver Pg

DBI Driver to use

--yathui-db-dsn ARG

DSN to use when connecting to the db

--yathui-db-flush-interval 2
--yathui-db-flush-interval 1.5

When buffering DB writes, force a flush when an event is recieved at least N seconds after the last flush.

--yathui-db-host ARG

hostname to use when connecting to the db

--yathui-db-name ARG

Name of the database to use for yathui

--yathui-db-pass ARG

Password to use when connecting to the db

--yathui-db-port ARG

port to use when connecting to the db

--yathui-db-socket ARG

socket to use when connecting to the db

--yathui-db-user ARG

Username to use when connecting to the db


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


Chad Granum <>


Chad Granum <>


Copyright 2021 Chad Granum <>.

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