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

NAME

6       App::Yath::Command::init - Create/update test.pl to run tests via
7       Test2::Harness
8

DESCRIPTION

10       This command will create or update the 'test.pl' file in the current
11       directory.  This 'test.pl' file this creates will run all your tests
12       via yath.
13
14       This command will fail if there is already a test.pl file that does not
15       look like it was generated by this command.
16

USAGE

18           $ yath [YATH OPTIONS] init [COMMAND OPTIONS]
19
20   YATH OPTIONS
21       Developer
22
23       --dev-lib
24       --dev-lib=lib
25       -D
26       -D=lib
27       -Dlib
28       --no-dev-lib
29           Add paths to @INC before loading ANYTHING. This is what you use if
30           you are developing yath or yath plugins to make sure the yath
31           script finds the local code instead of the installed versions of
32           the same code. You can provide an argument (-Dfoo) to provide a
33           custom path, or you can just use -D without and arg to add lib,
34           blib/lib and blib/arch.
35
36           Can be specified multiple times
37
38       Environment
39
40       --persist-dir ARG
41       --persist-dir=ARG
42       --no-persist-dir
43           Where to find persistence files.
44
45       --persist-file ARG
46       --persist-file=ARG
47       --pfile ARG
48       --pfile=ARG
49       --no-persist-file
50           Where to find the persistence file. The default is
51           /{system-tempdir}/project-yath-persist.json. If no project is
52           specified then it will fall back to the current directory. If the
53           current directory is not writable it will default to
54           /tmp/yath-persist.json which limits you to one persistent runner on
55           your system.
56
57       --project ARG
58       --project=ARG
59       --project-name ARG
60       --project-name=ARG
61       --no-project
62           This lets you provide a label for your current project/codebase.
63           This is best used in a .yath.rc file. This is necessary for a
64           persistent runner.
65
66       Help and Debugging
67
68       --show-opts
69       --no-show-opts
70           Exit after showing what yath thinks your options mean
71
72       --version
73       -V
74       --no-version
75           Exit after showing a helpful usage message
76
77       Plugins
78
79       --no-scan-plugins
80       --no-no-scan-plugins
81           Normally yath scans for and loads all App::Yath::Plugin::* modules
82           in order to bring in command-line options they may provide. This
83           flag will disable that. This is useful if you have a naughty plugin
84           that it loading other modules when it should not.
85
86       --plugins PLUGIN
87       --plugins +App::Yath::Plugin::PLUGIN
88       --plugins PLUGIN=arg1,arg2,...
89       --plugin PLUGIN
90       --plugin +App::Yath::Plugin::PLUGIN
91       --plugin PLUGIN=arg1,arg2,...
92       -pPLUGIN
93       --no-plugins
94           Load a yath plugin.
95
96           Can be specified multiple times
97
98   COMMAND OPTIONS
99       Help and Debugging
100
101       --dummy
102       -d
103       --no-dummy
104           Dummy run, do not actually execute anything
105
106           Can also be set with the following environment variables:
107           "T2_HARNESS_DUMMY"
108
109       --help
110       -h
111       --no-help
112           exit after showing help information
113
114       --keep-dirs
115       --keep_dir
116       -k
117       --no-keep-dirs
118           Do not delete directories when done. This is useful if you want to
119           inspect the directories used for various commands.
120
121       YathUI Options
122
123       --yathui-api-key ARG
124       --yathui-api-key=ARG
125       --no-yathui-api-key
126           Yath-UI API key. This is not necessary if your Yath-UI instance is
127           set to single-user
128
129       --yathui-grace
130       --no-yathui-grace
131           If yath cannot connect to yath-ui it normally throws an error, use
132           this to make it fail gracefully. You get a warning, but things keep
133           going.
134
135       --yathui-long-duration 10
136       --no-yathui-long-duration
137           Minimum duration length (seconds) before a test goes from MEDIUM to
138           LONG
139
140       --yathui-medium-duration 5
141       --no-yathui-medium-duration
142           Minimum duration length (seconds) before a test goes from SHORT to
143           MEDIUM
144
145       --yathui-mode summary
146       --yathui-mode qvf
147       --yathui-mode qvfd
148       --yathui-mode complete
149       --no-yathui-mode
150           Set the upload mode (default 'qvfd')
151
152       --yathui-project ARG
153       --yathui-project=ARG
154       --no-yathui-project
155           The Yath-UI project for your test results
156
157       --yathui-retry
158       --no-yathui-retry
159           How many times to try an operation before giving up
160
161           Can be specified multiple times
162
163       --yathui-url http://my-yath-ui.com/...
164       --uri http://my-yath-ui.com/...
165       --no-yathui-url
166           Yath-UI url
167

SOURCE

169       The source code repository for Test2-Harness can be found at
170       http://github.com/Test-More/Test2-Harness/.
171

MAINTAINERS

173       Chad Granum <exodist@cpan.org>
174

AUTHORS

176       Chad Granum <exodist@cpan.org>
177

COPYRIGHT

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