NAME
App::Yath::Command::watch - Watch/Tail a test runner
DESCRIPTION
Tails the log from a running yath daemon
USAGE
$ yath [YATH OPTIONS] watch [COMMAND OPTIONS]
OPTIONS
Harness Options
- -d
- --dummy
- --no-dummy
-
Dummy run, do not actually execute anything
Can also be set with the following environment variables:
T2_HARNESS_DUMMY
The following environment variables will be cleared after arguments are processed:
T2_HARNESS_DUMMY
- --procname-prefix ARG
- --procname-prefix=ARG
- --no-procname-prefix
-
Add a prefix to all proc names (as seen by ps).
The following environment variables will be set after arguments are processed:
T2_HARNESS_PROC_PREFIX
IPC Options
- --ipc-address ARG
- --ipc-address=ARG
- --no-ipc-address
-
IPC address to use (usually auto-generated or discovered)
- --ipc-allow-multiple
- --no-ipc-allow-multiple
-
Normally yath will prevent you from starting multiple persistent runners in the same project, this option will allow you to start more than one.
- --ipc-dir ARG
- --ipc-dir=ARG
- --no-ipc-dir
-
Directory for ipc files
Can also be set with the following environment variables:
T2_HARNESS_IPC_DIR
,YATH_IPC_DIR
- --ipc-dir-order ARG
- --ipc-dir-order=ARG
- --ipc-dir-order '["json","list"]'
- --ipc-dir-order='["json","list"]'
- --ipc-dir-order :{ ARG1 ARG2 ... }:
- --ipc-dir-order=:{ ARG1 ARG2 ... }:
- --no-ipc-dir-order
-
When finding ipc-dir automatically, search in this order, default: ['base', 'temp']
Note: Can be specified multiple times
- --ipc-file ARG
- --ipc-file=ARG
- --no-ipc-file
-
IPC file used to locate instances (usually auto-generated or discovered)
- --ipc-peer-pid ARG
- --ipc-peer-pid=ARG
- --no-ipc-peer-pid
-
Optionally a peer PID may be provided
- --ipc-port ARG
- --ipc-port=ARG
- --no-ipc-port
-
Some IPC protocols require a port, otherwise this should be left empty
- --ipc-prefix ARG
- --ipc-prefix=ARG
- --no-ipc-prefix
-
Prefix for ipc files
- --ipc-protocol IPSocket
- --ipc-protocol AtomicPipe
- --ipc-protocol UnixSocket
- --ipc-protocol +Test2::Harness::IPC::Protocol::AtomicPipe
- --no-ipc-protocol
-
Specify what IPC Protocol to use. Use the "+" prefix to specify a fully qualified namespace, otherwise Test2::Harness::IPC::Protocol::XXX namespace is assumed.
Renderer Options
- --hide-runner-output
- --no-hide-runner-output
-
Hide output from the runner, showing only test output. (See Also truncate_runner_output)
- -q
- --quiet
- --no-quiet
-
Be very quiet.
- --qvf
- --no-qvf
-
Replaces App::Yath::Theme::Default with App::Yath::Theme::QVF which is quiet for passing tests and verbose for failing ones.
- --renderer +My::Renderer
- --renderers +My::Renderer
- --renderer MyRenderer=opt1,opt2
- --renderers MyRenderer=opt1,opt2
- --renderer MyRenderer,MyOtherRenderer
- --renderers MyRenderer,MyOtherRenderer
- --renderer=:{ MyRenderer opt1,opt2,... }:
- --renderers=:{ MyRenderer opt1,opt2,... }:
- --renderer :{ MyRenderer :{ opt1 opt2 }: }:
- --renderers :{ MyRenderer :{ opt1 opt2 }: }:
- --no-renderers
-
Specify renderers. Use "+" to give a fully qualified module name. Without "+" "App::Yath::Renderer::" will be prepended to your argument.
Note: Can be specified multiple times
- --server
- --server=ARG
- --no-server
-
Start an ephemeral yath database and web server to view results
- --show-job-end
- --no-show-job-end
-
Show output when a job ends. (Default: on)
- --show-job-info
- --no-show-job-info
-
Show the job configuration when a job starts. (Default: off, unless -vv)
- --show-job-launch
- --no-show-job-launch
-
Show output for the start of a job. (Default: off unless -v)
- --show-run-fields
- --no-show-run-fields
-
Show run fields. (Default: off, unless -vv)
- --show-run-info
- --no-show-run-info
-
Show the run configuration when a run starts. (Default: off, unless -vv)
- -T
- --show-times
- --no-show-times
-
Show the timing data for each job.
- -tARG
- -t ARG
- -t=ARG
- --theme ARG
- --theme=ARG
- --no-theme
-
Select a theme for the renderer (not all renderers use this)
- --truncate-runner-output
- --no-truncate-runner-output
-
Only show runner output that was generated after the current command. This is only useful with a persistent runner.
- -v
- -vv
- -vvv..
- -v=COUNT
- --verbose
- --verbose=COUNT
- --no-verbose
-
Be more verbose
The following environment variables will be set after arguments are processed:
T2_HARNESS_IS_VERBOSE
,HARNESS_IS_VERBOSE
Note: Can be specified multiple times, counter bumps each time it is used.
- --wrap
- --no-wrap
-
When active (default) renderers should try to wrap text in a human-friendly way. When this is turned off they should just throw text at the terminal.
Terminal Options
- -c
- --color
- --no-color
-
Turn color on, default is true if STDOUT is a TTY.
Can also be set with the following environment variables:
YATH_COLOR
,CLICOLOR_FORCE
The following environment variables will be set after arguments are processed:
YATH_COLOR
- --progress
- --no-progress
-
Toggle progress indicators. On by default if STDOUT is a TTY. You can use --no-progress to disable the 'events seen' counter and buffered event pre-display
- --term-size 80
- --term-width 80
- --term-size 200
- --term-width 200
- --no-term-width
-
Alternative to setting $TABLE_TERM_SIZE. Setting this will override the terminal width detection to the number of characters specified.
Can also be set with the following environment variables:
TABLE_TERM_SIZE
The following environment variables will be set after arguments are processed:
TABLE_TERM_SIZE
Yath Options
- --base-dir ARG
- --base-dir=ARG
- --no-base-dir
-
Root directory for the project being tested (usually where .yath.rc lives)
- -D
- -Dlib
- -Dlib
- -D=lib
- -D"lib/*"
- --dev-lib
- --dev-lib=lib
- --dev-lib="lib/*"
- --no-dev-lib
-
This is what you use if you are developing yath or yath plugins to make sure the yath script finds the local code instead of the installed versions of the same code. You can provide an argument (-Dfoo) to provide a custom path, or you can just use -D without and arg to add lib, blib/lib and blib/arch.
Note: This option can cause yath to use exec() to reload itself with the correct libraries in place. Each occurence of this argument can cause an additional exec() call. Use --dev-libs-verbose BEFORE any -D calls to see the exec() calls.
Note: Can be specified multiple times
- --dev-libs-verbose
- --no-dev-libs-verbose
-
Be verbose and announce that yath will re-exec in order to have the correct includes (normally yath will just call exec() quietly)
- -h
- -h=Group
- --help
- --help=Group
- --no-help
-
exit after showing help information
- -p key=val
- -p=key=val
- -pkey=value
- -p '{"json":"hash"}'
- -p='{"json":"hash"}'
- -p:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- -p :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- -p=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --plugin key=val
- --plugin=key=val
- --plugins key=val
- --plugins=key=val
- --plugin '{"json":"hash"}'
- --plugin='{"json":"hash"}'
- --plugins '{"json":"hash"}'
- --plugins='{"json":"hash"}'
- --plugin :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --plugin=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --plugins :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --plugins=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --no-plugins
-
Load a yath plugin.
Note: Can be specified multiple times
- --project ARG
- --project=ARG
- --project-name ARG
- --project-name=ARG
- --no-project
-
This lets you provide a label for your current project/codebase. This is best used in a .yath.rc file.
- --scan-options key=val
- --scan-options=key=val
- --scan-options '{"json":"hash"}'
- --scan-options='{"json":"hash"}'
- --scan-options(?^:^--(no-)?(?^:scan-(.+))$)
- --scan-options :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --scan-options=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:
- --no-scan-options
- /^--(no-)?scan-(.+)$/
-
Yath will normally scan plugins for options. Some commands scan other libraries (finders, resources, renderers, etc) for options. You can use this to disable all scanning, or selectively disable/enable some scanning.
Note: This is parsed early in the argument processing sequence, before options that may be earlier in your argument list.
Note: Can be specified multiple times
- --show-opts
- --show-opts=group
- --no-show-opts
-
Exit after showing what yath thinks your options mean
- --user ARG
- --user=ARG
- --no-user
-
Username to associate with logs, database entries, and yath servers.
Can also be set with the following environment variables:
YATH_USER
,USER
- -V
- --version
- --no-version
-
Exit after showing a helpful usage message
SOURCE
The source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/.
MAINTAINERS
AUTHORS
COPYRIGHT
Copyright Chad Granum <exodist7@gmail.com>.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.