1App::Yath::Command::helUps(e3r)Contributed Perl DocumentAaptpi:o:nYath::Command::help(3)
2
6 App::Yath::Command::help - Show the list of commands
7
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
14 $ yath [YATH OPTIONS] help [COMMAND OPTIONS]
15 YATH OPTIONS
17 Developer
18 --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 Can be specified multiple times
33 Environment
35 --persist-dir ARG
37 --persist-dir=ARG
38 --no-persist-dir
39 Where to find persistence files.
40 --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 --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 Help and Debugging
63 --show-opts
65 --no-show-opts
66 Exit after showing what yath thinks your options mean
67 --version
69 -V
70 --no-version
71 Exit after showing a helpful usage message
72 Plugins
74 --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 --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 Can be specified multiple times
93 COMMAND OPTIONS
95 Cover Options
96 --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 --cover-class ARG
107 --cover-class=ARG
108 --no-cover-class
109 Choose a Test2::Plugin::Cover subclass
110 --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 Can be specified multiple times
119 --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 --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 --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 --cover-manager My::Coverage::Manager
146 --no-cover-manager
147 Coverage 'from' manager to use when coverage data does not provide
148 one
149 --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 --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 --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 Can be specified multiple times
175 --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 Git Options
184 --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 Help and Debugging
194 --dummy
196 -d
197 --no-dummy
198 Dummy run, do not actually execute anything
199 Can also be set with the following environment variables:
201 "T2_HARNESS_DUMMY"
202 --help
204 -h
205 --no-help
206 exit after showing help information
207 --interactive
209 -i
210 --no-interactive
211 Use interactive mode, 1 test at a time, stdin forwarded to it
212 --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 YathUI Options
221 --yathui-api-key ARG
223 --yathui-api-key=ARG
224 --no-yathui-api-key
225 Yath-UI API key. This is not necessary if your Yath-UI instance is
226 set to single-user
227 --yathui-db
229 --no-yathui-db
230 Add the YathUI DB renderer in addition to other renderers
231 --yathui-grace
233 --no-yathui-grace
234 If yath cannot connect to yath-ui it normally throws an error, use
235 this to make it fail gracefully. You get a warning, but things keep
236 going.
237 --yathui-long-duration 10
239 --no-yathui-long-duration
240 Minimum duration length (seconds) before a test goes from MEDIUM to
241 LONG
242 --yathui-medium-duration 5
244 --no-yathui-medium-duration
245 Minimum duration length (seconds) before a test goes from SHORT to
246 MEDIUM
247 --yathui-mode summary
249 --yathui-mode qvf
250 --yathui-mode qvfd
251 --yathui-mode complete
252 --no-yathui-mode
253 Set the upload mode (default 'qvfd')
254 --yathui-only
256 --no-yathui-only
257 Only use the YathUI renderer
258 --yathui-only-db
260 --no-yathui-only-db
261 Only use the YathUI DB renderer
262 --yathui-port 8080
264 --no-yathui-port
265 Port to use when running a local server
266 --yathui-port-command get_port.sh
268 --yathui-port-command get_port.sh --pid $$
269 --no-yathui-port-command
270 Use a command to get a port number. "$$" will be replaced with the
271 PID of the yath process
272 --yathui-project ARG
274 --yathui-project=ARG
275 --no-yathui-project
276 The Yath-UI project for your test results
277 --yathui-render
279 --no-yathui-render
280 Add the YathUI renderer in addition to other renderers
281 --yathui-retry
283 --no-yathui-retry
284 How many times to try an operation before giving up
285 Can be specified multiple times
287 --yathui-schema PostgreSQL
289 --yathui-schema MySQL
290 --yathui-schema MySQL56
291 --no-yathui-schema
292 What type of DB/schema to use when using a temporary database
293 --yathui-url http://my-yath-ui.com/...
295 --uri http://my-yath-ui.com/...
296 --no-yathui-url
297 Yath-UI url
298 --yathui-user ARG
300 --yathui-user=ARG
301 --no-yathui-user
302 Username to attach to the data sent to the db
303 --yathui-db-buffering none
305 --yathui-db-buffering job
306 --yathui-db-buffering diag
307 --yathui-db-buffering run
308 --no-yathui-db-buffering
309 Type of buffering to use, if "none" then events are written to the
310 db one at a time, which is SLOW
311 --yathui-db-config ARG
313 --yathui-db-config=ARG
314 --no-yathui-db-config
315 Module that implements 'MODULE->yath_ui_config(%params)' which
316 should return a Test2::Harness::UI::Config instance.
317 --yathui-db-coverage
319 --no-yathui-db-coverage
320 Pull coverage data directly from the database (default: off)
321 --yathui-db-driver Pg
323 --yathui-db-drivermysql
324 --yathui-db-driverMariaDB
325 --no-yathui-db-driver
326 DBI Driver to use
327 --yathui-db-dsn ARG
329 --yathui-db-dsn=ARG
330 --no-yathui-db-dsn
331 DSN to use when connecting to the db
332 --yathui-db-durations
334 --no-yathui-db-durations
335 Pull duration data directly from the database (default: off)
336 --yathui-db-flush-interval 2
338 --yathui-db-flush-interval 1.5
339 --no-yathui-db-flush-interval
340 When buffering DB writes, force a flush when an event is recieved
341 at least N seconds after the last flush.
342 --yathui-db-host ARG
344 --yathui-db-host=ARG
345 --no-yathui-db-host
346 hostname to use when connecting to the db
347 --yathui-db-name ARG
349 --yathui-db-name=ARG
350 --no-yathui-db-name
351 Name of the database to use for yathui
352 --yathui-db-pass ARG
354 --yathui-db-pass=ARG
355 --no-yathui-db-pass
356 Password to use when connecting to the db
357 --yathui-db-port ARG
359 --yathui-db-port=ARG
360 --no-yathui-db-port
361 port to use when connecting to the db
362 --yathui-db-publisher ARG
364 --yathui-db-publisher=ARG
365 --no-yathui-db-publisher
366 When using coverage or duration data, only use data uploaded by
367 this user
368 --yathui-db-socket ARG
370 --yathui-db-socket=ARG
371 --no-yathui-db-socket
372 socket to use when connecting to the db
373 --yathui-db-user ARG
375 --yathui-db-user=ARG
376 --no-yathui-db-user
377 Username to use when connecting to the db
378
380 The source code repository for Test2-Harness can be found at
381 http://github.com/Test-More/Test2-Harness/.
382
384 Chad Granum <exodist@cpan.org>
385
387 Chad Granum <exodist@cpan.org>
388
390 Copyright 2021 Chad Granum <exodist7@gmail.com>.
391 This program is free software; you can redistribute it and/or modify it
393 under the same terms as Perl itself.
394 See http://dev.perl.org/licenses/
396perl v5.34.0 2021-11-05 App::Yath::Command::help(3)