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

📦

version 1.000172 · 8 versions

1.000172 · ubuntu stonking (latest)
1.0.161 · fedora 43
1.0.163 · fedora 43, fedora 44
1.0.163 · fedora 44
1.000155 · ubuntu noble
1.000151 · debian bookworm
1.000161 · ubuntu resolute
1.000158 · debian trixie, ubuntu questing

💖 App::Y...::kill 💖

okay bestie, welcome to the manual page for App::Y...::kill(3pm) — straight out of the User Contributed Perl Documentation, and it is exactly what it sounds like. it kills things. slay. 🩸✨

🎀 NAME 🎀

App::Yath::Command::kill — the yath command that kills the runner plus any tests that are currently running or just chilling in the pending queue. bye boo 👋

🦋 DESCRIPTION 🦋

This command kills the active yath runner, and also any running or pending tests. that's the whole entire job description, no cap. one word and everything goes night-night 💀💤

✨ USAGE ✨

$ yath [YATH OPTIONS] kill [COMMAND OPTIONS]

🌸 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 reach for when 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) to give it a custom path, or just rawdog -D with no argument 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 it falls back to the current directory. and if the current directory is not writable it defaults to /tmp/yath-persist.json, which unfortunately limits you to one persistent runner on your whole system 😭
--project ARG, --project=ARG, --project-name ARG, --project-name=ARG, --no-project — lets you hand over a label for your current project/codebase. best used in a .yath.rc file. and honestly? it's necessary for a persistent runner, so don't skip it 💅

🔍 Finder Options 🔍

--finder MyFinder, --finder +Test2::Harness::Finder::MyFinder, --no-finder — picks which Finder subclass gets used when searching for files / processing the file list. use the + prefix to give a fully qualified namespace, otherwise the Test2::Harness::Finder::XXX namespace is assumed.

🆘 Help and Debugging 🆘

--show-opts, --no-show-opts — exits after showing you what yath thinks your options mean.
--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 bring in whatever command-line options they provide. this flag disables that whole operation. super useful if 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. 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 — chooses a custom aggregator subclass.
--cover-class ARG, --cover-class=ARG, --no-cover-class — chooses 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. (yes the docs really say that, i'm just the messenger bestie 🙈)
--cover-exclude-private, --no-cover-exclude-private, --cover-files, --no-cover-files — uses Test2::Plugin::Cover to collect coverage data for what files get 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 pointing at 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 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 — 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, it can be a test log, a coverage dump (old style json or new jsonl format), or a url to any of those. but this one keeps going even if the coverage file/url is invalid. resilient queen ✨
--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 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 the coverage data seen during the run (this implies --cover-files).

🎨 Display Options 🎨

--color, --no-color — turns color on. default is true if STDOUT is a TTY. 🌈
--hide-runner-output, --no-hide-runner-output — hides output from the runner, showing only test output. (see also truncate_runner_output)
--no-final-table, --no-no-final-table — when printing final results, don't use the table-style display.
--no-wrap, --no-no-wrap — doesn't do the fancy text-wrapping, lets the terminal handle it.
--progress, --no-progress — toggles progress indicators. on by default if STDOUT is a TTY. you can use --no-progress to disable the 'events seen' counter and the buffered event pre-display.
--quiet, -q, --no-quiet — be very quiet. 🤫 Can be specified multiple times.
--renderers +My::Renderer, --renderers Renderer=arg1,arg2,..., --renderer +My::Renderer, --renderer Renderer=arg1,arg2,..., --no-renderers — specifies renderers (default: Formatter=Test2). use + to give a fully qualified module name. without the +, Test2::Harness::Renderer:: gets prepended to your argument. Can be specified multiple times. if the same key is listed multiple times the value lists get appended together.
--show-times, -T, --no-show-times — shows the timing data for each job ⏱️
--term-width 80, --term-width 200, --term-size 80, --term-size 200, --no-term-width — alternative to setting $TABLE_TERM_SIZE. setting this overrides the terminal width detection to the number of characters you specified.
--truncate-runner-output, --no-truncate-runner-output — only shows runner output that was generated after the current command. this is only useful with a persistent runner.
--verbose, -v, --no-verbose — be more verbose. Can be specified multiple times.

🔍 Finder Options 🔍

--changed path/to/file, --no-changed — specifies one or more files as having been changed. Can be specified multiple times.
--changed-only, --no-changed-only — only searches for tests for changed files. (requires a coverage data source, and also requires a list of changes either from the --changed option, or a plugin that implements changed_files() or changed_diff())
--changes-diff path/to/diff.diff, --no-changes-diff — path to a diff file that should be used to find changed files for use with --changed-only. this must be in the same format as git diff -W --minimal -U1000000.
--changes-exclude-file path/to/file, --no-changes-exclude-file — specifies one or more files to ignore when looking at changes. Can be specified multiple times.
--changes-exclude-loads, --no-changes-exclude-loads — excludes coverage tests which only load changed files but never actually call code from them. (default: off)
--changes-exclude-nonsub, --no-changes-exclude-nonsub — excludes changes outside of subroutines (perl files only). (default: off)
--changes-exclude-opens, --no-changes-exclude-opens — excludes coverage tests which only open() changed files but never call code from them. (default: off)
--changes-exclude-pattern '(apple|pear|orange)', --no-changes-exclude-pattern — ignores files matching this pattern when looking for changes. your pattern gets inserted unmodified into a $file =~ m/$pattern/ check. Can be specified multiple times.
--changes-filter-file path/to/file, --no-changes-filter-file — specifies one or more files to check for changes. changes to other files will be ignored. Can be specified multiple times.
--changes-filter-pattern '(apple|pear|orange)', --no-changes-filter-pattern — specifies a pattern for change checking. when only running tests for changed files, this limits which files get checked for changes. only files matching this pattern get checked. your pattern gets inserted unmodified into a $file =~ m/$pattern/ check. Can be specified multiple times.
--changes-include-whitespace, --no-changes-include-whitespace — includes changed lines that are whitespace only. (default: off)
--changes-plugin Git, --changes-plugin +App::Yath::Plugin::Git, --no-changes-plugin — what plugin should be used to detect changed files.
--default-at-search ARG, --default-at-search=ARG, --no-default-at-search — specifies the default file/dir search when 'AUTHOR_TESTING' is set. defaults to './xt'. the default AT search is only used if no files were specified at the command line. Can be specified multiple times.
--default-search ARG, --default-search=ARG, --no-default-search — specifies the default file/dir search. defaults to './t', './t2', and 'test.pl'. the default search is only used if no files were specified at the command line. Can be specified multiple times.
--durations file.json, --durations http://example.com/durations.json, --no-durations — bestie, point this at a json file or a url that holds a hash where the keys are relative test filenames and the values are 'SHORT', 'MEDIUM', or 'LONG'. This will ✨override✨ the durations listed in the file headers. If the durations file or url doesn't work, an exception will be thrown. No silent vibes here. 😤
--durations-threshold ARG, --durations-threshold=ARG, --Dt ARG, --Dt=ARG, --no-durations-threshold — only go fetch duration data if you're running at least this many tests. Default is (-j value + 1). fr fr, small run = don't even bother checking. 💅
--exclude-file t/nope.t, --no-exclude-file — exclude a file from testing. 🚫 Can be specified multiple times.
--exclude-list file.txt, --exclude-list http://example.com/exclusions.txt, --no-exclude-list — point at a file or url with a new-line-separated list of test file names to exclude from testing. Start a line with a # and it's commented out (for compatibility with Test2::Aggregate list files, periodt). 📝 Can be specified multiple times.
--exclude-pattern t/nope.t, --no-exclude-pattern — exclude a pattern from testing, matched using m/$PATTERN/. 🎯 Can be specified multiple times.
--extension ARG, --extension=ARG, --ext ARG, --ext=ARG, --no-extension — tell it which test filename extensions are valid. Default: t and t2. 👑 Can be specified multiple times.
--maybe-durations file.json, --maybe-durations http://example.com/durations.json, --no-maybe-durations — point at a json file or url which has a hash of relative test filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This will override durations listed in the file headers. An exception will be thrown if the durations file or url does not work. 📊 (okay so yes, the wording is literally identical to --durations up there — I'm not making that up, that's what the page says, and we do not edit the sacred text 💀)
--no-long, --no-no-long — do NOT run tests that have their duration flag set to 'LONG'. bye long tests 👋
--only-long, --no-only-long — ONLY run tests that have their duration flag set to 'LONG'. long test stans rise 🫶
--rerun, --rerun=path/to/log.jsonl, --rerun=plugin_specific_string, --no-rerun — re-run tests from a previous run, from a log file (or the last log file). Plugins can intercept this — for example YathUIDB, which will grab a run UUID and derive the tests to re-run from that. 🔁
--rerun-all, --rerun-all=path/to/log.jsonl, --rerun-all=plugin_specific_string, --no-rerun-all — re-run all the tests from a previous run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB grabbing a run UUID and deriving the tests to re-run from that. 💫
--rerun-failed, --rerun-failed=path/to/log.jsonl, --rerun-failed=plugin_specific_string, --no-rerun-failed — re-run the failed tests from a previous run, from a log file (or the last log file). Plugins can intercept this, e.g. YathUIDB snagging a run UUID and deriving the tests to re-run from it. 😭🔁
--rerun-missed, --rerun-missed=path/to/log.jsonl, --rerun-missed=plugin_specific_string, --no-rerun-missed — run the missed tests from a previously aborted/stopped run, from a log file (or the last log file). Plugins can intercept this — you know the drill, YathUIDB grabs a run UUID and derives tests to re-run from that. 🙈
--rerun-modes failed,missed,..., --rerun-modes all, --rerun-modes failed, --rerun-modes missed, --rerun-modes passed, --rerun-modes retried, --rerun-mode failed,missed,..., --rerun-mode all, --rerun-mode failed, --rerun-mode missed, --rerun-mode passed, --rerun-mode retried, --no-rerun-modes — pick which test categories to run. 🎛️ Can be specified multiple times.
--rerun-passed, --rerun-passed=path/to/log.jsonl, --rerun-passed=plugin_specific_string, --no-rerun-passed — re-run the passed tests from a previous run, from a log file (or the last log file). Plugins can intercept this, such as YathUIDB, which will grab a run UUID and derive tests to re-run from that. ✅
--rerun-plugin Foo, --rerun-plugin +App::Yath::Plugin::Foo, --no-rerun-plugin — which plugin(s) should be used for rerun. It will fallback to other plugins if the listed ones decline the value; this is just used to set an order of priority. 🧚 Can be specified multiple times.
--rerun-retried, --rerun-retried=path/to/log.jsonl, --rerun-retried=plugin_specific_string, --no-rerun-retried — re-run the retried tests from a previous run, from a log file (or the last log file). Plugins can intercept this, like YathUIDB grabbing a run UUID and deriving the tests to re-run from that. 🔄
--search ARG, --search=ARG, --no-search — a list of tests and test directories to use instead of the default search paths. Typically you can just list these as plain command line arguments without the --search prefix, iykyk. 🔍 Can be specified multiple times.
--show-changed-files, --no-show-changed-files — print a list of changed files if any are found. 📃

✨ Formatter Options ✨

--formatter ARG, --formatter=ARG, --no-formatter — NO DESCRIPTION - FIX ME. not me reading the manpage and the manpage says fix me 😭 that's literally what it says bestie, I can't invent lore.
--qvf, --no-qvf — [Q]uiet, but [V]erbose on [F]ailure. Hide ALL the output from tests when they pass, except to say they passed. If a test fails, then ALL the output from that test gets verbosely dumped out. 🤫➡️📢
--show-job-end, --no-show-job-end — show output when a job ends. (Default: on) 🏁
--show-job-info, --no-show-job-info — show the job configuration when a job starts. (Default: off, unless -vv) ⚙️
--show-job-launch, --no-show-job-launch — show output for the start of a job. (Default: off unless -v) 🚀
--show-run-info, --no-show-run-info — show the run configuration when a run starts. (Default: off, unless -vv) 📋

🌈 Git Options 🌈

--git-change-base master, --git-change-base HEAD^, --git-change-base df22abe4, --no-git-change-base — find files changed by all the commits in the current branch, starting from the most recent and stopping when a commit is found 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. Pretend mode, main character energy 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 — 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. 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). 🏷️
--summary, --summary=/path/to/summary.json, --no-summary — write out a summary json file; if no path is provided, 'summary.json' will be used. The .json extension is added automatically if you omit it. 📦

📝 Logging Options 📝

--bzip2, --bz2, --bzip2_log, -B, --no-bzip2 — use bzip2 compression when writing the log. This option implies -L. The .bz2 prefix is added to the log file name for you. 🗜️
--gzip, --gz, --gzip_log, -G, --no-gzip — use gzip compression when writing the log. This option implies -L. The .gz prefix is added to the log file name for you. 🗜️✨
--log, -L, --no-log — turn on logging. 🪵
--log-dir ARG, --log-dir=ARG, --no-log-dir — specify a log directory. It'll fall back to the system temp dir. 📁
--log-file ARG, --log-file=ARG, -F ARG, -F=ARG, --no-log-file — specify the name of the log file. This option implies -L. 📄
--log-file-format ARG, --log-file-format=ARG, --lff ARG, --lff=ARG, --no-log-file-format — specify the format for automatically-generated log files. Overridden by --log-file, if given. This option implies -L. Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl". This is a string in which percent-escape sequences will be replaced as per POSIX::strftime. The following special escape sequences are also replaced too: (%!P : Project name followed by a ~, if a project is defined, otherwise empty string) (%!U : the unique test run ID) (%!p : the process ID) (%!S : the number of seconds since local midnight UTC). 🕰️ Can also be set with the following environment variables: YATH_LOG_FILE_FORMAT, TEST2_HARNESS_LOG_FORMAT