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 it 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       Git Options
96
97       --git-change-base master
98       --git-change-base HEAD^
99       --git-change-base df22abe4
100       --no-git-change-base
101           Find files changed by all commits in the current branch from most
102           recent stopping when a commit is found that is also present in the
103           history of the branch/commit specified as the change base.
104
105       Help and Debugging
106
107       --dummy
108       -d
109       --no-dummy
110           Dummy run, do not actually execute anything
111
112           Can also be set with the following environment variables:
113           "T2_HARNESS_DUMMY"
114
115       --help
116       -h
117       --no-help
118           exit after showing help information
119
120       --keep-dirs
121       --keep_dir
122       -k
123       --no-keep-dirs
124           Do not delete directories when done. This is useful if you want to
125           inspect the directories used for various commands.
126
127       YathUI Options
128
129       --yathui-api-key ARG
130       --yathui-api-key=ARG
131       --no-yathui-api-key
132           Yath-UI API key. This is not necessary if your Yath-UI instance is
133           set to single-user
134
135       --yathui-db
136       --no-yathui-db
137           Add the YathUI DB renderer in addition to other renderers
138
139       --yathui-grace
140       --no-yathui-grace
141           If yath cannot connect to yath-ui it normally throws an error, use
142           this to make it fail gracefully. You get a warning, but things keep
143           going.
144
145       --yathui-long-duration 10
146       --no-yathui-long-duration
147           Minimum duration length (seconds) before a test goes from MEDIUM to
148           LONG
149
150       --yathui-medium-duration 5
151       --no-yathui-medium-duration
152           Minimum duration length (seconds) before a test goes from SHORT to
153           MEDIUM
154
155       --yathui-mode summary
156       --yathui-mode qvf
157       --yathui-mode qvfd
158       --yathui-mode complete
159       --no-yathui-mode
160           Set the upload mode (default 'qvfd')
161
162       --yathui-only
163       --no-yathui-only
164           Only use the YathUI renderer
165
166       --yathui-only-db
167       --no-yathui-only-db
168           Only use the YathUI DB renderer
169
170       --yathui-port 8080
171       --no-yathui-port
172           Port to use when running a local server
173
174       --yathui-port-command get_port.sh
175       --yathui-port-command get_port.sh --pid $$
176       --no-yathui-port-command
177           Use a command to get a port number. "$$" will be replaced with the
178           PID of the yath process
179
180       --yathui-project ARG
181       --yathui-project=ARG
182       --no-yathui-project
183           The Yath-UI project for your test results
184
185       --yathui-render
186       --no-yathui-render
187           Add the YathUI renderer in addition to other renderers
188
189       --yathui-retry
190       --no-yathui-retry
191           How many times to try an operation before giving up
192
193           Can be specified multiple times
194
195       --yathui-schema PostgreSQL
196       --yathui-schema MySQL
197       --yathui-schema MySQL56
198       --no-yathui-schema
199           What type of DB/schema to use when using a temporary database
200
201       --yathui-url http://my-yath-ui.com/...
202       --uri http://my-yath-ui.com/...
203       --no-yathui-url
204           Yath-UI url
205
206       --yathui-user ARG
207       --yathui-user=ARG
208       --no-yathui-user
209           Username to attach to the data sent to the db
210
211       --yathui-db-buffering none
212       --yathui-db-buffering job
213       --yathui-db-buffering diag
214       --yathui-db-buffering run
215       --no-yathui-db-buffering
216           Type of buffering to use, if "none" then events are written to the
217           db one at a time, which is SLOW
218
219       --yathui-db-config ARG
220       --yathui-db-config=ARG
221       --no-yathui-db-config
222           Module that implements 'MODULE->yath_ui_config(%params)' which
223           should return a Test2::Harness::UI::Config instance.
224
225       --yathui-db-driver Pg
226       --yathui-db-drivermysql
227       --yathui-db-driverMariaDB
228       --no-yathui-db-driver
229           DBI Driver to use
230
231       --yathui-db-dsn ARG
232       --yathui-db-dsn=ARG
233       --no-yathui-db-dsn
234           DSN to use when connecting to the db
235
236       --yathui-db-flush-interval 2
237       --yathui-db-flush-interval 1.5
238       --no-yathui-db-flush-interval
239           When buffering DB writes, force a flush when an event is recieved
240           at least N seconds after the last flush.
241
242       --yathui-db-host ARG
243       --yathui-db-host=ARG
244       --no-yathui-db-host
245           hostname to use when connecting to the db
246
247       --yathui-db-name ARG
248       --yathui-db-name=ARG
249       --no-yathui-db-name
250           Name of the database to use for yathui
251
252       --yathui-db-pass ARG
253       --yathui-db-pass=ARG
254       --no-yathui-db-pass
255           Password to use when connecting to the db
256
257       --yathui-db-port ARG
258       --yathui-db-port=ARG
259       --no-yathui-db-port
260           port to use when connecting to the db
261
262       --yathui-db-socket ARG
263       --yathui-db-socket=ARG
264       --no-yathui-db-socket
265           socket to use when connecting to the db
266
267       --yathui-db-user ARG
268       --yathui-db-user=ARG
269       --no-yathui-db-user
270           Username to use when connecting to the db
271

SOURCE

273       The source code repository for Test2-Harness can be found at
274       http://github.com/Test-More/Test2-Harness/.
275

MAINTAINERS

277       Chad Granum <exodist@cpan.org>
278

AUTHORS

280       Chad Granum <exodist@cpan.org>
281

COPYRIGHT

283       Copyright 2021 Chad Granum <exodist7@gmail.com>.
284
285       This program is free software; you can redistribute it and/or modify it
286       under the same terms as Perl itself.
287
288       See http://dev.perl.org/licenses/
289
290
291
292perl v5.32.1                      2021-03-12       App::Yath::Command::help(3)