dzil

Usage

Usage:

dzil <command> [-?hIVv] [long options...]
 -v --verbose                        log additional output
 -V STR... --verbose-plugin STR...   log additional output from some
                                     plugins only
 -I STR... --lib-inc STR...          additional @INC dirs
 -? -h --help                        show help

Displaying all available commands:

dzil commands

Displaying general help message:

dzil help

Displaying command help message:

dzil help COMMAND

new

Set up a new distribution
`new`	Set up a new distribution
`-p STR --profile STR`	Name of the profile to use
`-P STR --provider STR`	Name of the profile provider to use

build

Build the distribution
`build`	Build the distribution
`--trial`	Build a trial release that PAUSE will not index
`--tgz`	Build a tarball (default behavior)
`--in STR`	The directory in which to build the distribution

clean

Clean the build for the distribution
`clean`	Clean out the build
`-n --dry-run`	Do not remove anything, just show what would be done

test

Run the test suite for the distribution
`test`	Test the distribution
`--release`	Enables the `RELEASE_TESTING` environment variable
`--automated`	Enables the `AUTOMATED_TESTING` environment variable
`--extended`	Enables the `EXTENDED_TESTING` environment variable
`--author`	Enables the `AUTHOR_TESTING` environment variable (default behavior)
`--all`	Enables the `RELEASE_TESTING`, `AUTOMATED_TESTING`, `EXTENDED_TESTING` and `AUTHOR_TESTING` environment variables
`--keep --keep-build-dir`	Keep the build directory even after a success
`-j INT --jobs INT`	Number of parallel test jobs to run
`--test-verbose`	Enables verbose testing (`TEST_VERBOSE` environment variable on `Makefile.PL`, `--verbose` on `Build.PL`

xtest

Run the extra tests for the distribution Requires: Dist::Zilla::Plugin::CheckExtraTests
`xtest`	Run xt tests for the distribution
`--author`	Enables the `AUTHOR_TESTING` environment variable (default behavior)
`--release`	Enables the `RELEASE_TESTING` environment variable (default behavior)
`--automated`	Enables the `AUTOMATED_TESTING` environment variable
`--all`	Enables the `RELEASE_TESTING`, `AUTOMATED_TESTING` and `AUTHOR_TESTING` environment variables
`-j INT --jobs INT`	Number of parallel test jobs to run

smoke

Run a smoke test
`smoke`	Clean out the build
`--release`	Enables the `RELEASE_TESTING` environment variable
`--automated`	Enables the `AUTOMATED_TESTING` environment variable (default behavior)
`--author`	Enables the `AUTHOR_TESTING` environment variable

cover

Generate test coverage reports for the distribution Requires: Dist::Zilla::App::Command::cover
`cover`	Generate coverage report for the distribution
`--outputdir STR`	Specifies the directory for where to output the coverage report elements, default is inside the `.build` directory structure

install

Install the distribution
`install`	Install the distribution
`--install-command STR`	Command to run to install (e.g. `cpan .`)
`--keep --keep-build-dir`	Keep the build directory even after a success

release

Release the distribution to PAUSE/CPAN
`release`	Release the distribution
`--trial`	Build a trial release that PAUSE will not index
`-j INT`	Number of test jobs to run in parallel

add

Adds a new module to an existing distribution
`add`	Adds a new module to an existing distribution
`-p STR --profile STR`	Name of the profile to use
`-P STR --provider STR`	Name of the profile provider to use

listdeps

Working With Dependencies
`listdeps`	Lists dependencies, can be piped to CPAN client for installation
`--author / --develop`	Include author/develop dependencies
`--missing`	List only the missing dependencies
`--requires`	List the required dependencies
`--recommends`	List the recommended dependencies
`--suggests`	List the suggested dependencies
`--versions`	Include required version numbers in the listing
`--cpanm-versions`	format versions for consumption by `cpanm`
`--json`	List dependencies by phase (build, develop, runtime, test) in JSON format
`--omit-core STR`	Omit dependencies that are shipped with the specified version of Perl

authordeps

Working with dependencies for Dist::Zilla
`authordeps`	Lists author dependencies
`--root STR`	The root of the distribution; defaults to current directory
`--missing`	List only the missing dependencies
`--versions`	Include required version numbers in listing

Miscellaneous

`run`	Run executables in the directory where your distribution is built
`setup`	Set up a basic global config file through a basic interactive proces in `$HOME/.dzil/config.ini`
`nop`	This command will initialize Dist::Zilla and exit, can be useful for diagnostic purposes

Environment Variables

`RELEASE_TESTING`	See also: `smoke --release`
`AUTOMATED_TESTING`	See also: `smoke --automated`
`AUTHOR_TESTING`	See also: `smoke --author`
`HARNESS_OPTIONS`	Similar to the: `--jobs` option supported by several commands. Allows for specification of number of test jobs to run in parallel, e.g. `HARNESS_OPTIONS=j9`

Usage

new

build

clean

test

xtest

smoke

cover

install

release

add

listdeps

authordeps

Miscellaneous

Environment Variables

Notes