App::Y...auditor(3pm)

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💅 App::Y...auditor — the 3pm page bestie

okay so this is App::Yath::Command::auditor, and the manual name for it is 3pm (perl module section, iykyk). buckle up 🎀

✨ NAME ✨

App::Yath::Command::auditor — literally for internal use only 🙈 no cap, that's the whole name section.

🦋 DESCRIPTION 🦋

There is No Description. that's it. that's the whole description. the devs said "no thoughts, head empty" 💀 not me getting zero lore from the description section bestie 😭

🌸 USAGE 🌸

$ yath [YATH OPTIONS] auditor [COMMAND OPTIONS]

so you run yath with its options, then the auditor command, then the command options. slay 💅

👑 YATH OPTIONS

🧚 Developer

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib — adds paths to @INC before loading ANYTHING. this is the one you want if you're developing yath or yath plugins and you need the yath script to find your local code instead of the installed versions of that same code. you can pass an argument (-Dfoo) for a custom path, or just do -D with no arg and it adds 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. default is /{system-tempdir}/project-yath-persist.json. if no project is specified it falls back to the current directory, and if the current directory isn't writable it defaults to /tmp/yath-persist.json — which lowkey limits you to one persistent runner on your whole system. 😭
  • --project ARG, --project=ARG, --project-name ARG, --project-name=ARG, --no-project — lets you slap a label on your current project/codebase. best used in a .yath.rc file, and it's necessary for a persistent runner. ✨

💜 Help and Debugging

  • --show-opts, --no-show-opts — exit after showing what yath thinks your options mean. vibe check your flags fr fr 🔍
  • --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 so it can pull in whatever command-line options they provide. this flag disables that whole situation. useful when you have a naughty plugin loading other modules when it absolutely 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. (the devs left us on read, bestie 💀)

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). 🔥
  • --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 can't, you gotta specify it yourself. "json" is old style single-blob coverage data, "jsonl" is the new by-test style, and "log" is a logfile from a previous run.
  • --cover-manager My::Coverage::Manager, --no-cover-manager — the coverage 'from' manager to use when the coverage data doesn't 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 — same deal as --cover-from: a test log, a coverage dump (old style json or new jsonl format), or a url to any of the previous — except tests continue even if the coverage file/url is invalid. 🫶
  • --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's 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). 📝

🧚 Git Options

  • --git-change-base master, --git-change-base HEAD^, --git-change-base df22abe4, --no-git-change-base — find files changed by all commits in the current branch, starting from most recent and stopping when a commit is found that's also present in the history of the branch/commit specified as the change base. 🔍

💅 Help and Debugging

  • --dummy, -d, --no-dummy — dummy run, do not 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 inspect the directories used for various commands. 🕵️
  • --procname-prefix ARG, --procname-prefix=ARG, --no-procname-prefix — add a prefix to all proc names (as seen by ps).

🌟 YathUI Options

  • --yathui-api-key ARG, --yathui-api-key=ARG, --no-yathui-api-key — Yath-UI API key. not necessary if your Yath-UI instance is set to single-user. 🔑
  • --yathui-grace, --no-yathui-grace — if yath can't 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, --no-yathui-long-duration — minimum duration length (seconds) before a test goes from MEDIUM to LONG.
  • --yathui-medium-duration 5, --no-yathui-medium-duration — minimum duration length (seconds) before a test goes from SHORT to MEDIUM.
  • --yathui-mode summary, --yathui-mode qvf, --yathui-mode qvfd, --yathui-mode complete, --no-yathui-mode — set the upload mode (default 'qvfd').
  • --yathui-project ARG, --yathui-project=ARG, --no-yathui-project — the Yath-UI project for your test results. 📊
  • --yathui-retry, --no-yathui-retry — how many times to try an operation before giving up.

can be specified multiple times.

📚 SOURCE

the source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/. go peek bestie, it's giving open source royalty 👑

🛠 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/

so that's the whole page bestie 💖 this was App::Y...auditor, manual section 3pm, from perl v5.40.1 dated 2026-05-10. internal use only, but you understood every word of it. periodt. 🎀✨

📦 where this page comes from