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

📦
version 1.000172 · 8 versions
, in ubuntu stonking

💖 App::Y...::spawn — the manual page ✨

okay bestie, gather round, because this is the User Contributed Perl Documentation page for App::Y...::spawn(3pm) and it's genuinely so useful, no cap. it's a whole manual page and i'm gonna walk you through every single bit of it. grab a strawberry 🍓, we're going in.

🌸 NAME 🌸

App::Yath::Command::spawn — launch a perl script from the preloaded environment 🚀

✨ DESCRIPTION ✨

this thing will launch the script you specified, and it does it from the preloaded yath process. that's the whole vibe. it's giving "already warmed up, script is going now".

🫶 NOTE, and please read this one bestie: environment variables are NOT automatically passed to the spawned process. like, none of them. zero. you have to use -e or -E (go look at help) to say which environment variables you actually care about. don't come crying to me when HOME is missing. 💀

🎀 USAGE 🎀

$ yath [YATH OPTIONS] spawn [COMMAND OPTIONS]

👑 YATH OPTIONS 👑

Developer 🧚

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib — this one adds paths to @INC before loading ANYTHING. yes, anything. it's the move when you're developing yath itself or yath plugins and you need the yath script to find your local code instead of the installed versions of the same code. you can hand it an argument (-Dfoo) to give a custom path, or just use -D with no arg and it'll add lib, blib/lib and blib/arch. iconic.
    • 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 limits you to one persistent runner on your system. so, y'know. choices.
  • --project ARG, --project=ARG, --project-name ARG, --project-name=ARG, --no-project — lets you put a label on your current project/codebase. best used in a .yath.rc file, fr fr. and heads up: this is necessary for a persistent runner.

Help and Debugging 💅

  • --show-opts, --no-show-opts — exits after showing you what yath thinks your options mean. vibe check your own flags.
  • --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 every App::Yath::Plugin::* module so it can grab the command-line options they provide. this flag disables all of that. super useful when you've got a naughty plugin loading other modules when it 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
    • 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 on what files are touched by what tests. unlike Devel::Cover this has, and i quote, very little performance impact (about 4% difference). slay.
  • --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 those. and no cap: 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, but when it can't, you should specify. here's the tea: "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 — same deal as above (test log, coverage dump in old style json or new jsonl format, or a url to any of those) — except tests will coninue even if the coverage file/url is invalid. yes that typo is in the original, i'm just reporting the news bestie. 💀
  • --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". it defaults to "from_type" if that'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 — create a json or jsonl file of all the 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 the 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. it's giving detective energy 🕵️

Help and Debugging ⭐

  • --dummy, -d, --no-dummy — dummy run, it doesn't 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. this is the one you want when you need to go inspect the directories used for the 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 — the 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 instead: you get a warning, but things keep going. we love resilience.
  • --yathui-long-duration 10, --no-yathui-long-duration — minimum duration length (in seconds) before a test goes from MEDIUM to LONG.
  • --yathui-medium-duration 5, --no-yathui-medium-duration — minimum duration length (in 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 🔁
  • --yathui-url http://my-yath-ui.com/..., --uri http://my-yath-ui.com/..., --no-yathui-url — Yath-UI url.

spawn options 🐣

  • --copy-env HOME, --copy-env SHELL, --copy-env /PERL_.*/i, -e HOME, -e SHELL, -e /PERL_.*/i, --no-copy-env — specify environment variables to pass along with their current values. you can also use a regex. ✨
    • can be specified multiple times 🔁
  • --env-var VAR=VAL, -EVAR=VAL, -E VAR=VAL, --no-env-var — set environment variables for the spawn.
    • can be specified multiple times 🔁
  • --stage foo, -s foo, --no-stage — specify the stage to be used for launching the script.

🔗 SOURCE 🔗

the source code repository for Test2-Harness lives at http://github.com/Test-More/Test2-Harness/. go be nosy, 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 the whole page, bestie!! this was perl v5.40.1, dated 2026-05-10, and it's the App::Y...::spawn(3pm) manual page — you absolutely ate that read 💅👑 no cap, go spawn something iconic ✨🦋

📦 where this page comes from