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

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💖 App::Y...::help — like, the help command for yath, bestie 💖

okay so you're in the App::Yath::Command::help page from the Perl user-contributed docs (yes, the manual is literally called App::Y...::help(3pm), they really did abbreviate it like that 😭) — and it's giving "let me show you around" energy. Buckle up, we're doing a tour. 🎀

✨ NAME ✨

App::Yath::Command::help — shove a big ol' list of commands in my face, please 💅

🌸 DESCRIPTION 🌸

So here's the vibe: you call this thing with no arguments and it hits you with the full list of commands. That's it. That's the whole personality. 😌

But wait — if you do hand it a command name as an argument? Iconic. It prints the help for that command specifically. Chef's kiss. 🫶

🦋 USAGE 🦋

$ yath [YATH OPTIONS] help [COMMAND OPTIONS]

🔥 YATH OPTIONS 🔥

Developer

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib — adds paths to @INC before loading ANYTHING. Lowkey this is the one you want if you're hacking on yath itself (or yath plugins) — it makes sure the yath script grabs your local code instead of whatever version is installed on your machine, no cap. You can pass an argument (-Dfoo) for a custom path, or just rawdog -D with no arg and it'll 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 falls back to the current directory. And if the current directory isn't writable, it defaults to /tmp/yath-persist.json — which, heads up bestie, 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, fr fr. This one is necessary if you want a persistent runner. 🏷️

Help and Debugging

  • --show-opts, --no-show-opts — exit after showing what yath thinks your options mean 👀
  • --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 bring in whatever command-line options they provide. This flag disables that whole situation. Super useful if you've got a naughty plugin loading other modules when it absolutely should not be. 🙈
  • --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 😭 (even the docs are like "idk girl")

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 a 4% difference, queen 👑)
  • --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 the new jsonl format), or a url pointing at any of the above. 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 — the file type for the coverage source. Usually it can be detected on its own, but when it can't, you gotta 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 — 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 — 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. (Yes, that spelling is what the docs say. I am but a vessel. 🍓)
  • --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 (heads up: 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 the most recent and stopping when it hits 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, 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, stdin forwarded to it 🎮
  • --keep-dirs, --keep_dir, -k, --no-keep-dirs — do not delete directories when done. Useful if you wanna go snooping through 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 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, --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 star it, bestie, it's free. ⭐

👑 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, mwah 💋 this was perl v5.40.1, dated 2026-05-10 — and it's the App::Y...::help(3pm) page from the Perl user-contributed docs. slay, go read your help, bye bestie 🦋✨

📦 where this page comes from