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

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💖 NAME 💖

Bestie, this is the App::Y...sources(3pm) page from User Contributed Perl Documentation ✨ and the command we're talking about is App::Yath::Command::resources — View the state info for a test runner. It's giving main character energy for your test runner's internal state 💅.

🌸 DESCRIPTION 🌸

A look at the state and resources used by a runner. Lowkey a vibe check on the state and the resources a runner is using 👀✨.

✨ USAGE ✨

$ yath [YATH OPTIONS] resources [COMMAND OPTIONS]

That's the shape of it, fr fr 🫶.

🦋 YATH OPTIONS 🦋

okay so these are the yath-level options that come before the resources command. Slay.

💅 Developer 💅

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib — 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 an arg to 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 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=ARG, --project-name ARG, --project-name=ARG, --no-project — 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 🧚

  • --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 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 is 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,..., -pPLUGIN, --no-plugins — Load a yath plugin. Can be specified multiple times.

🎀 COMMAND OPTIONS 🎀

These are the command-specific options for resources. They're giving "I only apply here" energy 💅.

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 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 coverage source. Usually it can be detected, but when it cannot be you should 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 — Coverage 'from' manager to use when coverage data does not 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 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 is 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 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, -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. This is useful if you want to 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).

Runner Options

  • --abort-on-bail, --no-abort-on-bail — Abort all testing if a bail-out is encountered (default: on).
  • --blib, -b, --no-blib — (Default: include if it exists) Include 'blib/lib' and 'blib/arch' in your module path.
  • --cover, --cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl, --no-cover — Use Devel::Cover to calculate test coverage. This disables forking. If no args are specified the following are used: -silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl.
  • --dump-depmap, --no-dump-depmap — When using staged preload, dump the depmap for each stage as json files.
  • --event-timeout SECONDS, --et SECONDS, --no-event-timeout — Kill test if no output is received within timeout period. (Default: 60 seconds). Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test file to disable timeouts on a per-test basis. This prevents a hung test from running forever.
  • --fail-on-resource-skip, --no-fail-on-resource-skip — Treat resource-skipped tests as failures instead of skips. When enabled, tests that would be skipped due to unavailable resources will be marked as failing.
  • --include ARG, --include=ARG, -I ARG, -I=ARG, --no-include — Add a directory to your include paths. Can be specified multiple times.
  • --job-count 4, --job-count 8:2, --jobs 4, --jobs 8:2, -j4, -j8:2, --no-job-count — Set the number of concurrent jobs to run. Add a :# if you also wish to designate multiple slots per test. 8:2 means 8 slots, but each test gets 2 slots, so 4 tests run concurrently. Tests can find their concurrency assignment in the "T2_HARNESS_MY_JOB_CONCURRENCY" environment variable. Can also be set with the following environment variables: "YATH_JOB_COUNT", "T2_HARNESS_JOB_COUNT", "HARNESS_JOB_COUNT".
  • --lib, -l, --no-lib — (Default: include if it exists) Include 'lib' in your module path.
  • --nytprof, --no-nytprof — Use Devel::NYTProf on tests. This will set addpid=1 for you. This works with or without fork.
  • --post-exit-timeout SECONDS, --pet SECONDS, --no-post-exit-timeout — Stop waiting post-exit after the timeout period. (Default: 15 seconds) Some tests fork and allow the parent to exit before writing all their output. If Test2::Harness detects an incomplete plan after the test exits it will monitor for more events until the timeout period. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test file to disable timeouts on a per-test basis.
  • --preload-threshold ARG, --preload-threshold=ARG, --Pt ARG, --Pt=ARG, -W ARG, -W=ARG, --no-preload-threshold — Only do preload if at least N tests are going to be run. In some cases a full preload takes longer than simply running the tests, this lets you specify a minimum number of test jobs that will be run for preload to happen. This has no effect for a persistent runner. The default is 0, and it means always preload.
  • --preloads ARG, --preloads=ARG, --preload ARG, --preload=ARG, -P ARG, -P=ARG, --no-preloads — Preload a module before running tests. Can be specified multiple times.
  • --resource-timeout SECONDS, --rt SECONDS, --no-resource-timeout — Abort the test run if no tests have been able to start for SECONDS seconds while there are pending tests and none running. This is useful when a resource class is broken and always claims a resource will become available, preventing yath from ever finishing. (Default: 0, meaning no timeout)
  • --resource Port, --resource +Test2::Harness::Runner::Resource::Port, -R Port, --no-resource — Use a resource module to assign resource assignments to individual tests. Can be specified multiple times.
  • --runner-id ARG, --runner-id=ARG, --no-runner-id — Runner ID (usually a generated uuid).
  • --shared-jobs-config .sharedjobslots.yml, --shared-jobs-config relative/path/.sharedjobslots.yml, --shared-jobs-config /absolute/path/.sharedjobslots.yml, --no-shared-jobs-config — Where to look for a shared slot config file. If a filename with no path is provided yath will search the current and all parent directories for the name.
  • --slots-per-job 2, -x2, --no-slots-per-job — okay so this one sets how many slots each job gets to use (default 1, bestie). Usually you're not setting this by hand bc it's set by the :# in -j#:#, iykyk.

You can also set it with this env var: T2_HARNESS_JOB_CONCURRENCY

  • --switch ARG, --switch=ARG, -S ARG, -S=ARG, --no-switch — passes the switch you name straight to perl for every single test 🌈. Heads up though: this is not compatible with preload, so don't come crying to me when it vibes wrong together.

Can be specified multiple times 💅

  • --tlib, --no-tlib — (Default: off) adds t/lib into your module path. that's it, that's the whole thing 🎀
  • --unsafe-inc, --no-unsafe-inc — so perl is literally removing '.' from @INC for security reasons 😭 and this option is the little bandaid that keeps stuff from breaking for now. no cap.

You can also set it with this env var: PERL_USE_UNSAFE_INC

  • --use-fork, --fork, --no-use-fork — (default: on, except on windows 🪟) Normally tests get run by forking, which is what lets the fancy stuff like preloading happen. Turning this off kills that behavior globally — and no, global off is not compatible with preloading, just so we're clear. It's also slower 😔 so the move is to tag the misbehaving tests with the # HARNESS-NO-PRELOAD comment in their header and disable forking for those tests only. main character problem-solving fr.

You can also set it with these env vars: !T2_NO_FORK, T2_HARNESS_FORK, !T2_HARNESS_NO_FORK, YATH_FORK, !YATH_NO_FORK

  • --use-timeout, --timeout, --no-use-timeout — (default: on) turns timeouts on/off. simple as that ⏱️✨

✨ YathUI Options ✨

  • --yathui-api-key ARG, --yathui-api-key=ARG, --no-yathui-api-key — your Yath-UI API key 🔑. You don't even need this 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 just throws an error and we all perish 💀. Using this makes it fail gracefully instead — you still get a warning, but everything keeps going 🫶.
  • --yathui-long-duration 10, --no-yathui-long-duration — minimum duration length, in seconds, before a test levels up from MEDIUM to LONG ⬆️
  • --yathui-medium-duration 5, --no-yathui-medium-duration — minimum duration length, in seconds, before a test levels up from SHORT to MEDIUM ⬆️
  • --yathui-mode summary, --yathui-mode qvf, --yathui-mode qvfd, --yathui-mode complete, --no-yathui-mode — sets the upload mode (default 'qvfd') 📤
  • --yathui-project ARG, --yathui-project=ARG, --no-yathui-project — the Yath-UI project your test results belong to 🗂️
  • --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 💖

👑 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 a wrap, bestie 🎀 this was perl v5.40.1, dated 2026-05-10, straight from the App::Y...sources(3pm) manual page — iconic behavior tbh, now go run some tests 💅✨

📦 where this page comes from