1App::Yath::Command::ps(U3s)er Contributed Perl DocumentatAipopn::Yath::Command::ps(3)
2
6 App::Yath::Command::ps - Process list for the runner
7
9 List all running processes and runner stages.
10
12 $ yath [YATH OPTIONS] ps [COMMAND OPTIONS]
13 YATH OPTIONS
15 Developer
16 --dev-lib
18 --dev-lib=lib
19 -D
20 -D=lib
21 -Dlib
22 --no-dev-lib
23 Add paths to @INC before loading ANYTHING. This is what you use if
24 you are developing yath or yath plugins to make sure the yath
25 script finds the local code instead of the installed versions of
26 the same code. You can provide an argument (-Dfoo) to provide a
27 custom path, or you can just use -D without and arg to add lib,
28 blib/lib and blib/arch.
29 Can be specified multiple times
31 Environment
33 --persist-dir ARG
35 --persist-dir=ARG
36 --no-persist-dir
37 Where to find persistence files.
38 --persist-file ARG
40 --persist-file=ARG
41 --pfile ARG
42 --pfile=ARG
43 --no-persist-file
44 Where to find the persistence file. The default is
45 /{system-tempdir}/project-yath-persist.json. If no project is
46 specified then it will fall back to the current directory. If the
47 current directory is not writable it will default to
48 /tmp/yath-persist.json which limits you to one persistent runner on
49 your system.
50 --project ARG
52 --project=ARG
53 --project-name ARG
54 --project-name=ARG
55 --no-project
56 This lets you provide a label for your current project/codebase.
57 This is best used in a .yath.rc file. This is necessary for a
58 persistent runner.
59 Finder Options
61 --finder MyFinder
63 --finder +Test2::Harness::Finder::MyFinder
64 --no-finder
65 Specify what Finder subclass to use when searching for
66 files/processing the file list. Use the "+" prefix to specify a
67 fully qualified namespace, otherwise Test2::Harness::Finder::XXX
68 namespace is assumed.
69 Help and Debugging
71 --show-opts
73 --no-show-opts
74 Exit after showing what yath thinks your options mean
75 --version
77 -V
78 --no-version
79 Exit after showing a helpful usage message
80 Plugins
82 --no-scan-plugins
84 --no-no-scan-plugins
85 Normally yath scans for and loads all App::Yath::Plugin::* modules
86 in order to bring in command-line options they may provide. This
87 flag will disable that. This is useful if you have a naughty plugin
88 that is loading other modules when it should not.
89 --plugins PLUGIN
91 --plugins +App::Yath::Plugin::PLUGIN
92 --plugins PLUGIN=arg1,arg2,...
93 --plugin PLUGIN
94 --plugin +App::Yath::Plugin::PLUGIN
95 --plugin PLUGIN=arg1,arg2,...
96 -pPLUGIN
97 --no-plugins
98 Load a yath plugin.
99 Can be specified multiple times
101 COMMAND OPTIONS
103 Cover Options
104 --cover-aggregator ByTest
106 --cover-aggregator ByRun
107 --cover-aggregator +Custom::Aggregator
108 --cover-agg ByTest
109 --cover-agg ByRun
110 --cover-agg +Custom::Aggregator
111 --no-cover-aggregator
112 Choose a custom aggregator subclass
113 --cover-class ARG
115 --cover-class=ARG
116 --no-cover-class
117 Choose a Test2::Plugin::Cover subclass
118 --cover-dirs ARG
120 --cover-dirs=ARG
121 --cover-dir ARG
122 --cover-dir=ARG
123 --no-cover-dirs
124 NO DESCRIPTION - FIX ME
125 Can be specified multiple times
127 --cover-exclude-private
129 --no-cover-exclude-private
130 --cover-files
131 --no-cover-files
132 Use Test2::Plugin::Cover to collect coverage data for what files
133 are touched by what tests. Unlike Devel::Cover this has very little
134 performance impact (About 4% difference)
135 --cover-from path/to/log.jsonl
137 --cover-from http://example.com/coverage
138 --cover-from path/to/coverage.jsonl
139 --no-cover-from
140 This can be a test log, a coverage dump (old style json or new
141 jsonl format), or a url to any of the previous. Tests will not be
142 run if the file/url is invalid.
143 --cover-from-type json
145 --cover-from-type jsonl
146 --cover-from-type log
147 --no-cover-from-type
148 File type for coverage source. Usually it can be detected, but when
149 it cannot be you should specify. "json" is old style single-blob
150 coverage data, "jsonl" is the new by-test style, "log" is a logfile
151 from a previous run.
152 --cover-manager My::Coverage::Manager
154 --no-cover-manager
155 Coverage 'from' manager to use when coverage data does not provide
156 one
157 --cover-maybe-from path/to/log.jsonl
159 --cover-maybe-from http://example.com/coverage
160 --cover-maybe-from path/to/coverage.jsonl
161 --no-cover-maybe-from
162 This can be a test log, a coverage dump (old style json or new
163 jsonl format), or a url to any of the previous. Tests will coninue
164 if even if the coverage file/url is invalid.
165 --cover-maybe-from-type json
167 --cover-maybe-from-type jsonl
168 --cover-maybe-from-type log
169 --no-cover-maybe-from-type
170 Same as "from_type" but for "maybe_from". Defaults to "from_type"
171 if that is specified, otherwise auto-detect
172 --cover-metrics
174 --no-cover-metrics
175 --cover-types ARG
176 --cover-types=ARG
177 --cover-type ARG
178 --cover-type=ARG
179 --no-cover-types
180 NO DESCRIPTION - FIX ME
181 Can be specified multiple times
183 --cover-write
185 --cover-write=coverage.jsonl
186 --cover-write=coverage.json
187 --no-cover-write
188 Create a json or jsonl file of all coverage data seen during the
189 run (This implies --cover-files).
190 Display Options
192 --color
194 --no-color
195 Turn color on, default is true if STDOUT is a TTY.
196 --hide-runner-output
198 --no-hide-runner-output
199 Hide output from the runner, showing only test output. (See Also
200 truncate_runner_output)
201 --no-wrap
203 --no-no-wrap
204 Do not do fancy text-wrapping, let the terminal handle it
205 --progress
207 --no-progress
208 Toggle progress indicators. On by default if STDOUT is a TTY. You
209 can use --no-progress to disable the 'events seen' counter and
210 buffered event pre-display
211 --quiet
213 -q
214 --no-quiet
215 Be very quiet.
216 Can be specified multiple times
218 --renderers +My::Renderer
220 --renderers Renderer=arg1,arg2,...
221 --renderer +My::Renderer
222 --renderer Renderer=arg1,arg2,...
223 --no-renderers
224 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
225 fully qualified module name. Without "+"
226 "Test2::Harness::Renderer::" will be prepended to your argument.
227 Can be specified multiple times. If the same key is listed multiple
229 times the value lists will be appended together.
230 --show-times
232 -T
233 --no-show-times
234 Show the timing data for each job
235 --term-width 80
237 --term-width 200
238 --term-size 80
239 --term-size 200
240 --no-term-width
241 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
242 the terminal width detection to the number of characters specified.
243 --truncate-runner-output
245 --no-truncate-runner-output
246 Only show runner output that was generated after the current
247 command. This is only useful with a persistent runner.
248 --verbose
250 -v
251 --no-verbose
252 Be more verbose
253 Can be specified multiple times
255 Finder Options
257 --changed path/to/file
259 --no-changed
260 Specify one or more files as having been changed.
261 Can be specified multiple times
263 --changed-only
265 --no-changed-only
266 Only search for tests for changed files (Requires a coverage data
267 source, also requires a list of changes either from the --changed
268 option, or a plugin that implements changed_files() or
269 changed_diff())
270 --changes-diff path/to/diff.diff
272 --no-changes-diff
273 Path to a diff file that should be used to find changed files for
274 use with --changed-only. This must be in the same format as `git
275 diff -W --minimal -U1000000`
276 --changes-exclude-file path/to/file
278 --no-changes-exclude-file
279 Specify one or more files to ignore when looking at changes
280 Can be specified multiple times
282 --changes-exclude-loads
284 --no-changes-exclude-loads
285 Exclude coverage tests which only load changed files, but never
286 call code from them. (default: off)
287 --changes-exclude-nonsub
289 --no-changes-exclude-nonsub
290 Exclude changes outside of subroutines (perl files only) (default:
291 off)
292 --changes-exclude-opens
294 --no-changes-exclude-opens
295 Exclude coverage tests which only open() changed files, but never
296 call code from them. (default: off)
297 --changes-exclude-pattern '(apple|pear|orange)'
299 --no-changes-exclude-pattern
300 Ignore files matching this pattern when looking for changes. Your
301 pattern will be inserted unmodified into a `$file =~ m/$pattern/`
302 check.
303 Can be specified multiple times
305 --changes-filter-file path/to/file
307 --no-changes-filter-file
308 Specify one or more files to check for changes. Changes to other
309 files will be ignored
310 Can be specified multiple times
312 --changes-filter-pattern '(apple|pear|orange)'
314 --no-changes-filter-pattern
315 Specify a pattern for change checking. When only running tests for
316 changed files this will limit which files are checked for changes.
317 Only files that match this pattern will be checked. Your pattern
318 will be inserted unmodified into a `$file =~ m/$pattern/` check.
319 Can be specified multiple times
321 --changes-include-whitespace
323 --no-changes-include-whitespace
324 Include changed lines that are whitespace only (default: off)
325 --changes-plugin Git
327 --changes-plugin +App::Yath::Plugin::Git
328 --no-changes-plugin
329 What plugin should be used to detect changed files.
330 --default-at-search ARG
332 --default-at-search=ARG
333 --no-default-at-search
334 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
335 Defaults to './xt'. The default AT search is only used if no files
336 were specified at the command line
337 Can be specified multiple times
339 --default-search ARG
341 --default-search=ARG
342 --no-default-search
343 Specify the default file/dir search. defaults to './t', './t2', and
344 'test.pl'. The default search is only used if no files were
345 specified at the command line
346 Can be specified multiple times
348 --durations file.json
350 --durations http://example.com/durations.json
351 --no-durations
352 Point at a json file or url which has a hash of relative test
353 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
354 will override durations listed in the file headers. An exception
355 will be thrown if the durations file or url does not work.
356 --durations-threshold ARG
358 --durations-threshold=ARG
359 --Dt ARG
360 --Dt=ARG
361 --no-durations-threshold
362 Only fetch duration data if running at least this number of tests.
363 Default (-j value + 1)
364 --exclude-file t/nope.t
366 --no-exclude-file
367 Exclude a file from testing
368 Can be specified multiple times
370 --exclude-list file.txt
372 --exclude-list http://example.com/exclusions.txt
373 --no-exclude-list
374 Point at a file or url which has a new line separated list of test
375 file names to exclude from testing. Starting a line with a '#' will
376 comment it out (for compatibility with Test2::Aggregate list
377 files).
378 Can be specified multiple times
380 --exclude-pattern t/nope.t
382 --no-exclude-pattern
383 Exclude a pattern from testing, matched using m/$PATTERN/
384 Can be specified multiple times
386 --extension ARG
388 --extension=ARG
389 --ext ARG
390 --ext=ARG
391 --no-extension
392 Specify valid test filename extensions, default: t and t2
393 Can be specified multiple times
395 --maybe-durations file.json
397 --maybe-durations http://example.com/durations.json
398 --no-maybe-durations
399 Point at a json file or url which has a hash of relative test
400 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
401 will override durations listed in the file headers. An exception
402 will be thrown if the durations file or url does not work.
403 --no-long
405 --no-no-long
406 Do not run tests that have their duration flag set to 'LONG'
407 --only-long
409 --no-only-long
410 Only run tests that have their duration flag set to 'LONG'
411 --rerun
413 --rerun=path/to/log.jsonl
414 --rerun=plugin_specific_string
415 --no-rerun
416 Re-Run tests from a previous run from a log file (or last log
417 file). Plugins can intercept this, such as YathUIDB which will grab
418 a run UUID and derive tests to re-run from that.
419 --rerun-all
421 --rerun-all=path/to/log.jsonl
422 --rerun-all=plugin_specific_string
423 --no-rerun-all
424 Re-Run all tests from a previous run from a log file (or last log
425 file). Plugins can intercept this, such as YathUIDB which will grab
426 a run UUID and derive tests to re-run from that.
427 --rerun-failed
429 --rerun-failed=path/to/log.jsonl
430 --rerun-failed=plugin_specific_string
431 --no-rerun-failed
432 Re-Run failed tests from a previous run from a log file (or last
433 log file). Plugins can intercept this, such as YathUIDB which will
434 grab a run UUID and derive tests to re-run from that.
435 --rerun-missed
437 --rerun-missed=path/to/log.jsonl
438 --rerun-missed=plugin_specific_string
439 --no-rerun-missed
440 Run missed tests from a previously aborted/stopped run from a log
441 file (or last log file). Plugins can intercept this, such as
442 YathUIDB which will grab a run UUID and derive tests to re-run from
443 that.
444 --rerun-modes failed,missed,...
446 --rerun-modes all
447 --rerun-modes failed
448 --rerun-modes missed
449 --rerun-modes passed
450 --rerun-modes retried
451 --rerun-mode failed,missed,...
452 --rerun-mode all
453 --rerun-mode failed
454 --rerun-mode missed
455 --rerun-mode passed
456 --rerun-mode retried
457 --no-rerun-modes
458 Pick which test categories to run
459 Can be specified multiple times
461 --rerun-passed
463 --rerun-passed=path/to/log.jsonl
464 --rerun-passed=plugin_specific_string
465 --no-rerun-passed
466 Re-Run passed tests from a previous run from a log file (or last
467 log file). Plugins can intercept this, such as YathUIDB which will
468 grab a run UUID and derive tests to re-run from that.
469 --rerun-plugin Foo
471 --rerun-plugin +App::Yath::Plugin::Foo
472 --no-rerun-plugin
473 What plugin(s) should be used for rerun (will fallback to other
474 plugins if the listed ones decline the value, this is just used ot
475 set an order of priority)
476 Can be specified multiple times
478 --rerun-retried
480 --rerun-retried=path/to/log.jsonl
481 --rerun-retried=plugin_specific_string
482 --no-rerun-retried
483 Re-Run retried tests from a previous run from a log file (or last
484 log file). Plugins can intercept this, such as YathUIDB which will
485 grab a run UUID and derive tests to re-run from that.
486 --search ARG
488 --search=ARG
489 --no-search
490 List of tests and test directories to use instead of the default
491 search paths. Typically these can simply be listed as command line
492 arguments without the --search prefix.
493 Can be specified multiple times
495 --show-changed-files
497 --no-show-changed-files
498 Print a list of changed files if any are found
499 Formatter Options
501 --formatter ARG
503 --formatter=ARG
504 --no-formatter
505 NO DESCRIPTION - FIX ME
506 --qvf
508 --no-qvf
509 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
510 when they pass, except to say they passed. If a test fails then ALL
511 output from the test is verbosely output.
512 --show-job-end
514 --no-show-job-end
515 Show output when a job ends. (Default: on)
516 --show-job-info
518 --no-show-job-info
519 Show the job configuration when a job starts. (Default: off, unless
520 -vv)
521 --show-job-launch
523 --no-show-job-launch
524 Show output for the start of a job. (Default: off unless -v)
525 --show-run-info
527 --no-show-run-info
528 Show the run configuration when a run starts. (Default: off, unless
529 -vv)
530 Git Options
532 --git-change-base master
534 --git-change-base HEAD^
535 --git-change-base df22abe4
536 --no-git-change-base
537 Find files changed by all commits in the current branch from most
538 recent stopping when a commit is found that is also present in the
539 history of the branch/commit specified as the change base.
540 Help and Debugging
542 --dummy
544 -d
545 --no-dummy
546 Dummy run, do not actually execute anything
547 Can also be set with the following environment variables:
549 "T2_HARNESS_DUMMY"
550 --help
552 -h
553 --no-help
554 exit after showing help information
555 --interactive
557 -i
558 --no-interactive
559 Use interactive mode, 1 test at a time, stdin forwarded to it
560 --keep-dirs
562 --keep_dir
563 -k
564 --no-keep-dirs
565 Do not delete directories when done. This is useful if you want to
566 inspect the directories used for various commands.
567 --procname-prefix ARG
569 --procname-prefix=ARG
570 --no-procname-prefix
571 Add a prefix to all proc names (as seen by ps).
572 --summary
574 --summary=/path/to/summary.json
575 --no-summary
576 Write out a summary json file, if no path is provided
577 'summary.json' will be used. The .json extension is added
578 automatically if omitted.
579 Logging Options
581 --bzip2
583 --bz2
584 --bzip2_log
585 -B
586 --no-bzip2
587 Use bzip2 compression when writing the log. This option implies -L.
588 The .bz2 prefix is added to log file name for you
589 --gzip
591 --gz
592 --gzip_log
593 -G
594 --no-gzip
595 Use gzip compression when writing the log. This option implies -L.
596 The .gz prefix is added to log file name for you
597 --log
599 -L
600 --no-log
601 Turn on logging
602 --log-dir ARG
604 --log-dir=ARG
605 --no-log-dir
606 Specify a log directory. Will fall back to the system temp dir.
607 --log-file ARG
609 --log-file=ARG
610 -F ARG
611 -F=ARG
612 --no-log-file
613 Specify the name of the log file. This option implies -L.
614 --log-file-format ARG
616 --log-file-format=ARG
617 --lff ARG
618 --lff=ARG
619 --no-log-file-format
620 Specify the format for automatically-generated log files.
621 Overridden by --log-file, if given. This option implies -L
622 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
623 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
624 percent-escape sequences will be replaced as per POSIX::strftime.
625 The following special escape sequences are also replaced: (%!P :
626 Project name followed by a ~, if a project is defined, otherwise
627 empty string) (%!U : the unique test run ID) (%!p : the process ID)
628 (%!S : the number of seconds since local midnight UTC)
629 Can also be set with the following environment variables:
631 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
632 Notification Options
634 --notify-email foo@example.com
636 --no-notify-email
637 Email the test results to the specified email address(es)
638 Can be specified multiple times
640 --notify-email-fail foo@example.com
642 --no-notify-email-fail
643 Email failing results to the specified email address(es)
644 Can be specified multiple times
646 --notify-email-from foo@example.com
648 --no-notify-email-from
649 If any email is sent, this is who it will be from
650 --notify-email-owner
652 --no-notify-email-owner
653 Email the owner of broken tests files upon failure. Add `# HARNESS-
654 META-OWNER foo@example.com` to the top of a test file to give it an
655 owner
656 --notify-no-batch-email
658 --no-notify-no-batch-email
659 Usually owner failures are sent as a single batch at the end of
660 testing. Toggle this to send failures as they happen.
661 --notify-no-batch-slack
663 --no-notify-no-batch-slack
664 Usually owner failures are sent as a single batch at the end of
665 testing. Toggle this to send failures as they happen.
666 --notify-slack '#foo'
668 --notify-slack '@bar'
669 --no-notify-slack
670 Send results to a slack channel and/or user
671 Can be specified multiple times
673 --notify-slack-fail '#foo'
675 --notify-slack-fail '@bar'
676 --no-notify-slack-fail
677 Send failing results to a slack channel and/or user
678 Can be specified multiple times
680 --notify-slack-owner
682 --no-notify-slack-owner
683 Send slack notifications to the slack channels/users listed in test
684 meta-data when tests fail.
685 --notify-slack-url https://hooks.slack.com/...
687 --no-notify-slack-url
688 Specify an API endpoint for slack webhook integrations
689 --notify-text ARG
691 --notify-text=ARG
692 --message ARG
693 --message=ARG
694 --msg ARG
695 --msg=ARG
696 --no-notify-text
697 Add a custom text snippet to email/slack notifications
698 --notify-text-module ARG
700 --notify-text-module=ARG
701 --message_module ARG
702 --message_module=ARG
703 --no-notify-text-module
704 Use the specified module to generate messages for emails and/or
705 slack.
706 Run Options
708 --author-testing
710 -A
711 --no-author-testing
712 This will set the AUTHOR_TESTING environment to true
713 --dbi-profiling
715 --no-dbi-profiling
716 Use Test2::Plugin::DBIProfile to collect database profiling data
717 --env-var VAR=VAL
719 -EVAR=VAL
720 -E VAR=VAL
721 --no-env-var
722 Set environment variables to set when each test is run.
723 Can be specified multiple times
725 --event-uuids
727 --uuids
728 --no-event-uuids
729 Use Test2::Plugin::UUID inside tests (default: on)
730 --fields name:details
732 --fields JSON_STRING
733 -f name:details
734 -f JSON_STRING
735 --no-fields
736 Add custom data to the harness run
737 Can be specified multiple times
739 --input ARG
741 --input=ARG
742 --no-input
743 Input string to be used as standard input for ALL tests. See also:
744 --input-file
745 --input-file ARG
747 --input-file=ARG
748 --no-input-file
749 Use the specified file as standard input to ALL tests
750 --io-events
752 --no-io-events
753 Use Test2::Plugin::IOEvents inside tests to turn all prints into
754 test2 events (default: off)
755 --link 'https://travis.work/builds/42'
757 --link 'https://jenkins.work/job/42'
758 --link 'https://buildbot.work/builders/foo/builds/42'
759 --no-link
760 Provide one or more links people can follow to see more about this
761 run.
762 Can be specified multiple times
764 --load ARG
766 --load=ARG
767 --load-module ARG
768 --load-module=ARG
769 -m ARG
770 -m=ARG
771 --no-load
772 Load a module in each test (after fork). The "import" method is not
773 called.
774 Can be specified multiple times
776 --load-import Module
778 --load-import Module=import_arg1,arg2,...
779 --loadim Module
780 --loadim Module=import_arg1,arg2,...
781 -M Module
782 -M Module=import_arg1,arg2,...
783 --no-load-import
784 Load a module in each test (after fork). Import is called.
785 Can be specified multiple times. If the same key is listed multiple
787 times the value lists will be appended together.
788 --mem-usage
790 --no-mem-usage
791 Use Test2::Plugin::MemUsage inside tests (default: on)
792 --retry ARG
794 --retry=ARG
795 -r ARG
796 -r=ARG
797 --no-retry
798 Run any jobs that failed a second time. NOTE: --retry=1 means
799 failing tests will be attempted twice!
800 --retry-isolated
802 --retry-iso
803 --no-retry-isolated
804 If true then any job retries will be done in isolation (as though
805 -j1 was set)
806 --run-id
808 --id
809 --no-run-id
810 Set a specific run-id. (Default: a UUID)
811 --test-args ARG
813 --test-args=ARG
814 --no-test-args
815 Arguments to pass in as @ARGV for all tests that are run. These can
816 be provided easier using the '::' argument separator.
817 Can be specified multiple times
819 --stream
821 --no-stream
822 Use the stream formatter (default is on)
823 --tap
825 --TAP
826 ----no-stream
827 --no-tap
828 The TAP format is lossy and clunky. Test2::Harness normally uses a
829 newer streaming format to receive test results. There are
830 old/legacy tests where this causes problems, in which case setting
831 --TAP or --no-stream can help.
832 YathUI Options
834 --yathui-api-key ARG
836 --yathui-api-key=ARG
837 --no-yathui-api-key
838 Yath-UI API key. This is not necessary if your Yath-UI instance is
839 set to single-user
840 --yathui-coverage
842 --no-yathui-coverage
843 Poll coverage data from Yath-UI to determine what tests should be
844 run for changed files
845 --yathui-db
847 --no-yathui-db
848 Add the YathUI DB renderer in addition to other renderers
849 --yathui-durations
851 --no-yathui-durations
852 Poll duration data from Yath-UI to help order tests efficiently
853 --yathui-grace
855 --no-yathui-grace
856 If yath cannot connect to yath-ui it normally throws an error, use
857 this to make it fail gracefully. You get a warning, but things keep
858 going.
859 --yathui-long-duration 10
861 --no-yathui-long-duration
862 Minimum duration length (seconds) before a test goes from MEDIUM to
863 LONG
864 --yathui-medium-duration 5
866 --no-yathui-medium-duration
867 Minimum duration length (seconds) before a test goes from SHORT to
868 MEDIUM
869 --yathui-mode summary
871 --yathui-mode qvf
872 --yathui-mode qvfd
873 --yathui-mode complete
874 --no-yathui-mode
875 Set the upload mode (default 'qvfd')
876 --yathui-only
878 --no-yathui-only
879 Only use the YathUI renderer
880 --yathui-only-db
882 --no-yathui-only-db
883 Only use the YathUI DB renderer
884 --yathui-port 8080
886 --no-yathui-port
887 Port to use when running a local server
888 --yathui-port-command get_port.sh
890 --yathui-port-command get_port.sh --pid $$
891 --no-yathui-port-command
892 Use a command to get a port number. "$$" will be replaced with the
893 PID of the yath process
894 --yathui-project ARG
896 --yathui-project=ARG
897 --no-yathui-project
898 The Yath-UI project for your test results
899 --yathui-render
901 --no-yathui-render
902 Add the YathUI renderer in addition to other renderers
903 --yathui-resources
905 --yathui-resources=5
906 --no-yathui-resources
907 Send resource info (for supported resources) to yathui at the
908 specified interval in seconds (5 if not specified)
909 --yathui-retry
911 --no-yathui-retry
912 How many times to try an operation before giving up
913 Can be specified multiple times
915 --yathui-schema PostgreSQL
917 --yathui-schema MySQL
918 --yathui-schema MySQL56
919 --no-yathui-schema
920 What type of DB/schema to use when using a temporary database
921 --yathui-upload
923 --no-yathui-upload
924 Upload the log to Yath-UI
925 --yathui-url http://my-yath-ui.com/...
927 --uri http://my-yath-ui.com/...
928 --no-yathui-url
929 Yath-UI url
930 --yathui-user ARG
932 --yathui-user=ARG
933 --no-yathui-user
934 Username to attach to the data sent to the db
935 --yathui-db-buffering none
937 --yathui-db-buffering job
938 --yathui-db-buffering diag
939 --yathui-db-buffering run
940 --no-yathui-db-buffering
941 Type of buffering to use, if "none" then events are written to the
942 db one at a time, which is SLOW
943 --yathui-db-config ARG
945 --yathui-db-config=ARG
946 --no-yathui-db-config
947 Module that implements 'MODULE->yath_ui_config(%params)' which
948 should return a Test2::Harness::UI::Config instance.
949 --yathui-db-coverage
951 --no-yathui-db-coverage
952 Pull coverage data directly from the database (default: off)
953 --yathui-db-driver Pg
955 --yathui-db-drivermysql
956 --yathui-db-driverMariaDB
957 --no-yathui-db-driver
958 DBI Driver to use
959 --yathui-db-dsn ARG
961 --yathui-db-dsn=ARG
962 --no-yathui-db-dsn
963 DSN to use when connecting to the db
964 --yathui-db-duration-limit ARG
966 --yathui-db-duration-limit=ARG
967 --no-yathui-db-duration-limit
968 Limit the number of runs to look at for durations data (default:
969 10)
970 --yathui-db-durations
972 --no-yathui-db-durations
973 Pull duration data directly from the database (default: off)
974 --yathui-db-flush-interval 2
976 --yathui-db-flush-interval 1.5
977 --no-yathui-db-flush-interval
978 When buffering DB writes, force a flush when an event is recieved
979 at least N seconds after the last flush.
980 --yathui-db-host ARG
982 --yathui-db-host=ARG
983 --no-yathui-db-host
984 hostname to use when connecting to the db
985 --yathui-db-name ARG
987 --yathui-db-name=ARG
988 --no-yathui-db-name
989 Name of the database to use for yathui
990 --yathui-db-pass ARG
992 --yathui-db-pass=ARG
993 --no-yathui-db-pass
994 Password to use when connecting to the db
995 --yathui-db-port ARG
997 --yathui-db-port=ARG
998 --no-yathui-db-port
999 port to use when connecting to the db
1000 --yathui-db-publisher ARG
1002 --yathui-db-publisher=ARG
1003 --no-yathui-db-publisher
1004 When using coverage or duration data, only use data uploaded by
1005 this user
1006 --yathui-db-socket ARG
1008 --yathui-db-socket=ARG
1009 --no-yathui-db-socket
1010 socket to use when connecting to the db
1011 --yathui-db-user ARG
1013 --yathui-db-user=ARG
1014 --no-yathui-db-user
1015 Username to use when connecting to the db
1016 NO CATEGORY - FIX ME
1018 --check-reload-state
1020 --no-check-reload-state
1021 Abort the run if there are unfixes reload errors and show a
1022 confirmation dialogue for unfixed reload warnings.
1023
1025 The source code repository for Test2-Harness can be found at
1026 http://github.com/Test-More/Test2-Harness/.
1027
1029 Chad Granum <exodist@cpan.org>
1030
1032 Chad Granum <exodist@cpan.org>
1033
1035 Copyright 2023 Chad Granum <exodist7@gmail.com>.
1036 This program is free software; you can redistribute it and/or modify it
1038 under the same terms as Perl itself.
1039 See http://dev.perl.org/licenses/
1041perl v5.38.0 2023-10-04 App::Yath::Command::ps(3)