ZFTool Usage Reference (ZendFramework 2)

ZFTool

Top 5 Most Important
===================
# zf								                                    show help screen
# zf modules           					                        show loaded modules
# zf create module <name> [<path>]
# zf create controller <name> <module> [<path>]
# zf create action <name> <controller> <module> [<path>]


Basic information
===================
# zf modules [list]           show loaded modules
# zf version | --version      display current Zend Framework version


Diagnostics
===================
# zf diag [options] [module name]

[module name]       (Optional) name of module to test
-v --verbose        Display detailed information.
-b --break          Stop testing on first failure.
-q --quiet          Do not display any output unless an error occurs.
--debug             Display raw debug info from tests.


Project creation
===================
# zf create project <path>

<path>              The path of the project to be created


Module creation
===================
# zf create module <name> [<path>]

<name>              The name of the module to be created
<path>              The path to the root folder of the ZF2 application (optional)


Controller creation
===================
# zf create controller <name> <module> [<path>]

<name>      The name of the controller to be created
<module>    The module in which the controller should be created
<path>      The root path of a ZF2 application where to create the controller


Action creation
===================
# zf create action <name> <controller> <module> [<path>]

<name>          The name of the action to be created
<controller>    The name of the controller in which the action should be created
<module>        The module containing the controller
<path>          The root path of a ZF2 application where to create the action


Application configuration
===================
# zf config list                  list all configuration option
# zf config get <name>            display a single config value, i.e. "config get db.host"
# zf config set <name> <value>    set a single config value (use only to change scalar values)


Classmap generator
===================
# zf classmap generate <directory> <classmap file> [--append|-a] [--overwrite|-w]

<directory>         The directory to scan for PHP classes (use "." to use current directory)
<classmap file>     File name for generated class map file  or - for standard output. If not supplied, defaults to
                    autoload_classmap.php inside <directory>.
--append | -a       Append to classmap file if it exists
--overwrite | -w    Whether or not to overwrite existing classmap file


ZF library installation
===================
# zf install zf <path> [<version>]

<path>              The directory where to install the ZF2 library
<version>           The version to install, if not specified uses the last available