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

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💖 App::Yath::Command::collector 💖

okay bestie, so this is one of those pages that exists in the perl manual set — it's shipped in the User Contributed Perl Documentation section, and its whole personality is... "for internal use only" 🙈. That's the NAME, that's the vibe. Don't @ me.

🦋 DESCRIPTION

No Description.

Literally. That's it. That's the whole description. The maintainers said "no thoughts, head empty" and moved on. 💀 Which honestly? Iconic of them.

✨ USAGE ✨

$ yath [YATH OPTIONS] collector [COMMAND OPTIONS]

So it's a yath subcommand called collector, and it takes yath options and command options. Slay.

🌸 YATH OPTIONS

Developer

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib — this one adds paths to @INC before loading ANYTHING. That's the move when you're developing yath itself, or yath plugins, and you need the yath script to grab your local code instead of the installed versions of the exact same code. You can hand it an argument (-Dfoo) for a custom path, or just go -D with no arg and it'll add lib, blib/lib and blib/arch for you. 🫶

Can be specified multiple times.

Environment

  • --persist-dir ARG, --persist-dir=ARG, --no-persist-dir — tells yath 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. No project specified? It falls back to the current directory. Current directory not writable?? Then it defaults to /tmp/yath-persist.json, and bestie, that caps you at one persistent runner on your whole system. So like, plan accordingly. 😭
  • --project ARG, --project=ARG, --project-name ARG, --project-name=ARG, --no-project — gives you 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 project, no persistent runner, that's the deal. 🎀

Help and Debugging

  • --show-opts, --no-show-opts — exits right after showing you what yath thinks your options mean. Receipts, basically. 🧾
  • --version, -V, --no-version — exits 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 all that. Super useful when you've got a naughty plugin that's 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 — loads a yath plugin. That's the whole job. ✨

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 😬

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 get touched by what tests. Unlike Devel::Cover, this has very little performance impact — we're talking about a 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 the new jsonl format), or a URL pointing at any of the previous. And listen: tests will not be run if the file/url is invalid. So double check that path, bestie. ⚠️
  • --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 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, 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 those. BUT — and this is the glow-up — tests will continue even if the coverage file/url is invalid. Chill mode activated. 😌
  • --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 one's specified, otherwise it auto-detects.
  • --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 — creates a json or jsonl file of all coverage data seen during the run. Heads up though: this implies --cover-files. 🔥

Git Options

  • --git-change-base master, --git-change-base HEAD^, --git-change-base df22abe4, --no-git-change-base — finds files changed by all commits in the current branch, starting from 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. Detective mode. 🕵️

Help and Debugging

  • --dummy, -d, --no-dummy — dummy run, doesn't actually execute anything. Pretend-play only. 🎭

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 — interactive mode: 1 test at a time, and stdin gets forwarded to it. 🫵
  • --keep-dirs, --keep_dir, -k, --no-keep-dirs — don't delete directories when done. Useful when you want to go poke around the directories various commands used. 🔍
  • --procname-prefix ARG, --procname-prefix=ARG, --no-procname-prefix — adds 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 — normally if yath can't connect to yath-ui it throws an error. This makes it fail gracefully instead: you get a warning, but things keep on keeping on. 💐
  • --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 is 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 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/

and that's the whole page, fr fr 🫶 this was perl v5.40.1, dated 2026-05-10, filed under the User Contributed Perl Documentation section. take care of her, she's mostly undocumented but she's doing her best 💖🌸✨

📦 where this page comes from