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       Help and Debugging
96
97       --dummy
98       -d
99       --no-dummy
100           Dummy run, do not actually execute anything
101
102           Can also be set with the following environment variables:
103           "T2_HARNESS_DUMMY"
104
105       --help
106       -h
107       --no-help
108           exit after showing help information
109
110       --keep-dirs
111       --keep_dir
112       -k
113       --no-keep-dirs
114           Do not delete directories when done. This is useful if you want to
115           inspect the directories used for various commands.
116
117       YathUI Options
118
119       --yathui-api-key ARG
120       --yathui-api-key=ARG
121       --no-yathui-api-key
122           Yath-UI API key. This is not necessary if your Yath-UI instance is
123           set to single-user
124
125       --yathui-grace
126       --no-yathui-grace
127           If yath cannot connect to yath-ui it normally throws an error, use
128           this to make it fail gracefully. You get a warning, but things keep
129           going.
130
131       --yathui-long-duration 10
132       --no-yathui-long-duration
133           Minimum duration length (seconds) before a test goes from MEDIUM to
134           LONG
135
136       --yathui-medium-duration 5
137       --no-yathui-medium-duration
138           Minimum duration length (seconds) before a test goes from SHORT to
139           MEDIUM
140
141       --yathui-mode summary
142       --yathui-mode qvf
143       --yathui-mode qvfd
144       --yathui-mode complete
145       --no-yathui-mode
146           Set the upload mode (default 'qvfd')
147
148       --yathui-project ARG
149       --yathui-project=ARG
150       --no-yathui-project
151           The Yath-UI project for your test results
152
153       --yathui-retry
154       --no-yathui-retry
155           How many times to try an operation before giving up
156
157           Can be specified multiple times
158
159       --yathui-url http://my-yath-ui.com/...
160       --uri http://my-yath-ui.com/...
161       --no-yathui-url
162           Yath-UI url
163

SOURCE

165       The source code repository for Test2-Harness can be found at
166       http://github.com/Test-More/Test2-Harness/.
167

MAINTAINERS

169       Chad Granum <exodist@cpan.org>
170

AUTHORS

172       Chad Granum <exodist@cpan.org>
173

175       Copyright 2020 Chad Granum <exodist7@gmail.com>.
176
177       This program is free software; you can redistribute it and/or modify it
178       under the same terms as Perl itself.
179
180       See http://dev.perl.org/licenses/
181
182
183
184perl v5.32.0                      2020-07-28       App::Yath::Command::help(3)
Impressum