App::Yath::Command::help(3pm)

1App::Yath::Command::helUps(e3r)Contributed Perl DocumentAaptpi:o:nYath::Command::help(3)
2
3
4

NAME

6       App::Yath::Command::help - Show the list of commands
7

DESCRIPTION

9       This command provides a list of commands when called with no arguments.
10       When given a command name as an argument it will print the help for
11       that command.
12

USAGE

14           $ yath [YATH OPTIONS] help [COMMAND OPTIONS]
15
16   YATH OPTIONS
17       Developer
18
19       --dev-lib
20       --dev-lib=lib
21       -D
22       -D=lib
23       -Dlib
24       --no-dev-lib
25           Add paths to @INC before loading ANYTHING. This is what you use if
26           you are developing yath or yath plugins to make sure the yath
27           script finds the local code instead of the installed versions of
28           the same code. You can provide an argument (-Dfoo) to provide a
29           custom path, or you can just use -D without and arg to add lib,
30           blib/lib and blib/arch.
31
32           Can be specified multiple times
33
34       Environment
35
36       --persist-dir ARG
37       --persist-dir=ARG
38       --no-persist-dir
39           Where to find persistence files.
40
41       --persist-file ARG
42       --persist-file=ARG
43       --pfile ARG
44       --pfile=ARG
45       --no-persist-file
46           Where to find the persistence file. The default is
47           /{system-tempdir}/project-yath-persist.json. If no project is
48           specified then it will fall back to the current directory. If the
49           current directory is not writable it will default to
50           /tmp/yath-persist.json which limits you to one persistent runner on
51           your system.
52
53       --project ARG
54       --project=ARG
55       --project-name ARG
56       --project-name=ARG
57       --no-project
58           This lets you provide a label for your current project/codebase.
59           This is best used in a .yath.rc file. This is necessary for a
60           persistent runner.
61
62       Help and Debugging
63
64       --show-opts
65       --no-show-opts
66           Exit after showing what yath thinks your options mean
67
68       --version
69       -V
70       --no-version
71           Exit after showing a helpful usage message
72
73       Plugins
74
75       --no-scan-plugins
76       --no-no-scan-plugins
77           Normally yath scans for and loads all App::Yath::Plugin::* modules
78           in order to bring in command-line options they may provide. This
79           flag will disable that. This is useful if you have a naughty plugin
80           that is loading other modules when it should not.
81
82       --plugins PLUGIN
83       --plugins +App::Yath::Plugin::PLUGIN
84       --plugins PLUGIN=arg1,arg2,...
85       --plugin PLUGIN
86       --plugin +App::Yath::Plugin::PLUGIN
87       --plugin PLUGIN=arg1,arg2,...
88       -pPLUGIN
89       --no-plugins
90           Load a yath plugin.
91
92           Can be specified multiple times
93
94   COMMAND OPTIONS
95       Cover Options
96
97       --cover-aggregator ByTest
98       --cover-aggregator ByRun
99       --cover-aggregator +Custom::Aggregator
100       --cover-agg ByTest
101       --cover-agg ByRun
102       --cover-agg +Custom::Aggregator
103       --no-cover-aggregator
104           Choose a custom aggregator subclass
105
106       --cover-class ARG
107       --cover-class=ARG
108       --no-cover-class
109           Choose a Test2::Plugin::Cover subclass
110
111       --cover-dirs ARG
112       --cover-dirs=ARG
113       --cover-dir ARG
114       --cover-dir=ARG
115       --no-cover-dirs
116           NO DESCRIPTION - FIX ME
117
118           Can be specified multiple times
119
120       --cover-exclude-private
121       --no-cover-exclude-private
122       --cover-files
123       --no-cover-files
124           Use Test2::Plugin::Cover to collect coverage data for what files
125           are touched by what tests. Unlike Devel::Cover this has very little
126           performance impact (About 4% difference)
127
128       --cover-from path/to/log.jsonl
129       --cover-from http://example.com/coverage
130       --cover-from path/to/coverage.jsonl
131       --no-cover-from
132           This can be a test log, a coverage dump (old style json or new
133           jsonl format), or a url to any of the previous. Tests will not be
134           run if the file/url is invalid.
135
136       --cover-from-type json
137       --cover-from-type jsonl
138       --cover-from-type log
139       --no-cover-from-type
140           File type for coverage source. Usually it can be detected, but when
141           it cannot be you should specify. "json" is old style single-blob
142           coverage data, "jsonl" is the new by-test style, "log" is a logfile
143           from a previous run.
144
145       --cover-manager My::Coverage::Manager
146       --no-cover-manager
147           Coverage 'from' manager to use when coverage data does not provide
148           one
149
150       --cover-maybe-from path/to/log.jsonl
151       --cover-maybe-from http://example.com/coverage
152       --cover-maybe-from path/to/coverage.jsonl
153       --no-cover-maybe-from
154           This can be a test log, a coverage dump (old style json or new
155           jsonl format), or a url to any of the previous. Tests will coninue
156           if even if the coverage file/url is invalid.
157
158       --cover-maybe-from-type json
159       --cover-maybe-from-type jsonl
160       --cover-maybe-from-type log
161       --no-cover-maybe-from-type
162           Same as "from_type" but for "maybe_from". Defaults to "from_type"
163           if that is specified, otherwise auto-detect
164
165       --cover-metrics
166       --no-cover-metrics
167       --cover-types ARG
168       --cover-types=ARG
169       --cover-type ARG
170       --cover-type=ARG
171       --no-cover-types
172           NO DESCRIPTION - FIX ME
173
174           Can be specified multiple times
175
176       --cover-write
177       --cover-write=coverage.jsonl
178       --cover-write=coverage.json
179       --no-cover-write
180           Create a json or jsonl file of all coverage data seen during the
181           run (This implies --cover-files).
182
183       Git Options
184
185       --git-change-base master
186       --git-change-base HEAD^
187       --git-change-base df22abe4
188       --no-git-change-base
189           Find files changed by all commits in the current branch from most
190           recent stopping when a commit is found that is also present in the
191           history of the branch/commit specified as the change base.
192
193       Help and Debugging
194
195       --dummy
196       -d
197       --no-dummy
198           Dummy run, do not actually execute anything
199
200           Can also be set with the following environment variables:
201           "T2_HARNESS_DUMMY"
202
203       --help
204       -h
205       --no-help
206           exit after showing help information
207
208       --interactive
209       -i
210       --no-interactive
211           Use interactive mode, 1 test at a time, stdin forwarded to it
212
213       --keep-dirs
214       --keep_dir
215       -k
216       --no-keep-dirs
217           Do not delete directories when done. This is useful if you want to
218           inspect the directories used for various commands.
219
220       --procname-prefix ARG
221       --procname-prefix=ARG
222       --no-procname-prefix
223           Add a prefix to all proc names (as seen by ps).
224
225       YathUI Options
226
227       --yathui-api-key ARG
228       --yathui-api-key=ARG
229       --no-yathui-api-key
230           Yath-UI API key. This is not necessary if your Yath-UI instance is
231           set to single-user
232
233       --yathui-db
234       --no-yathui-db
235           Add the YathUI DB renderer in addition to other renderers
236
237       --yathui-grace
238       --no-yathui-grace
239           If yath cannot connect to yath-ui it normally throws an error, use
240           this to make it fail gracefully. You get a warning, but things keep
241           going.
242
243       --yathui-long-duration 10
244       --no-yathui-long-duration
245           Minimum duration length (seconds) before a test goes from MEDIUM to
246           LONG
247
248       --yathui-medium-duration 5
249       --no-yathui-medium-duration
250           Minimum duration length (seconds) before a test goes from SHORT to
251           MEDIUM
252
253       --yathui-mode summary
254       --yathui-mode qvf
255       --yathui-mode qvfd
256       --yathui-mode complete
257       --no-yathui-mode
258           Set the upload mode (default 'qvfd')
259
260       --yathui-only
261       --no-yathui-only
262           Only use the YathUI renderer
263
264       --yathui-only-db
265       --no-yathui-only-db
266           Only use the YathUI DB renderer
267
268       --yathui-port 8080
269       --no-yathui-port
270           Port to use when running a local server
271
272       --yathui-port-command get_port.sh
273       --yathui-port-command get_port.sh --pid $$
274       --no-yathui-port-command
275           Use a command to get a port number. "$$" will be replaced with the
276           PID of the yath process
277
278       --yathui-project ARG
279       --yathui-project=ARG
280       --no-yathui-project
281           The Yath-UI project for your test results
282
283       --yathui-render
284       --no-yathui-render
285           Add the YathUI renderer in addition to other renderers
286
287       --yathui-resources
288       --yathui-resources=5
289       --no-yathui-resources
290           Send resource info (for supported resources) to yathui at the
291           specified interval in seconds (5 if not specified)
292
293       --yathui-retry
294       --no-yathui-retry
295           How many times to try an operation before giving up
296
297           Can be specified multiple times
298
299       --yathui-schema PostgreSQL
300       --yathui-schema MySQL
301       --yathui-schema MySQL56
302       --no-yathui-schema
303           What type of DB/schema to use when using a temporary database
304
305       --yathui-url http://my-yath-ui.com/...
306       --uri http://my-yath-ui.com/...
307       --no-yathui-url
308           Yath-UI url
309
310       --yathui-user ARG
311       --yathui-user=ARG
312       --no-yathui-user
313           Username to attach to the data sent to the db
314
315       --yathui-db-buffering none
316       --yathui-db-buffering job
317       --yathui-db-buffering diag
318       --yathui-db-buffering run
319       --no-yathui-db-buffering
320           Type of buffering to use, if "none" then events are written to the
321           db one at a time, which is SLOW
322
323       --yathui-db-config ARG
324       --yathui-db-config=ARG
325       --no-yathui-db-config
326           Module that implements 'MODULE->yath_ui_config(%params)' which
327           should return a Test2::Harness::UI::Config instance.
328
329       --yathui-db-coverage
330       --no-yathui-db-coverage
331           Pull coverage data directly from the database (default: off)
332
333       --yathui-db-driver Pg
334       --yathui-db-drivermysql
335       --yathui-db-driverMariaDB
336       --no-yathui-db-driver
337           DBI Driver to use
338
339       --yathui-db-dsn ARG
340       --yathui-db-dsn=ARG
341       --no-yathui-db-dsn
342           DSN to use when connecting to the db
343
344       --yathui-db-duration-limit ARG
345       --yathui-db-duration-limit=ARG
346       --no-yathui-db-duration-limit
347           Limit the number of runs to look at for durations data (default:
348           10)
349
350       --yathui-db-durations
351       --no-yathui-db-durations
352           Pull duration data directly from the database (default: off)
353
354       --yathui-db-flush-interval 2
355       --yathui-db-flush-interval 1.5
356       --no-yathui-db-flush-interval
357           When buffering DB writes, force a flush when an event is recieved
358           at least N seconds after the last flush.
359
360       --yathui-db-host ARG
361       --yathui-db-host=ARG
362       --no-yathui-db-host
363           hostname to use when connecting to the db
364
365       --yathui-db-name ARG
366       --yathui-db-name=ARG
367       --no-yathui-db-name
368           Name of the database to use for yathui
369
370       --yathui-db-pass ARG
371       --yathui-db-pass=ARG
372       --no-yathui-db-pass
373           Password to use when connecting to the db
374
375       --yathui-db-port ARG
376       --yathui-db-port=ARG
377       --no-yathui-db-port
378           port to use when connecting to the db
379
380       --yathui-db-publisher ARG
381       --yathui-db-publisher=ARG
382       --no-yathui-db-publisher
383           When using coverage or duration data, only use data uploaded by
384           this user
385
386       --yathui-db-socket ARG
387       --yathui-db-socket=ARG
388       --no-yathui-db-socket
389           socket to use when connecting to the db
390
391       --yathui-db-user ARG
392       --yathui-db-user=ARG
393       --no-yathui-db-user
394           Username to use when connecting to the db
395

SOURCE

397       The source code repository for Test2-Harness can be found at
398       http://github.com/Test-More/Test2-Harness/.
399

MAINTAINERS

401       Chad Granum <exodist@cpan.org>
402

AUTHORS

404       Chad Granum <exodist@cpan.org>
405

COPYRIGHT

407       Copyright 2023 Chad Granum <exodist7@gmail.com>.
408
409       This program is free software; you can redistribute it and/or modify it
410       under the same terms as Perl itself.
411
412       See http://dev.perl.org/licenses/
413
414
415
416perl v5.36.1                      2023-10-04       App::Yath::Command::help(3)