Installation

Install the plugin in your application's development dependencies:

composer require --dev dereuromark/cakephp-ide-helper

Composer checks the supported PHP and CakePHP versions against your application. See the package constraints for the current requirements.

Load the commands

In src/Application.php, add this inside bootstrap(), after parent::bootstrap():

if (PHP_SAPI === 'cli' && class_exists(\IdeHelper\IdeHelperPlugin::class)) {
    $this->addPlugin('IdeHelper');
}

This registers the commands for CLI use when the development dependency is installed. The class check also permits deployments using composer install --no-dev to boot without the plugin.

Check the commands

From the application directory, run:

bin/cake annotate all --help
bin/cake generate code_completion --help
bin/cake generate phpstorm --help
bin/cake illuminate code --help

Continue with Getting started for a first annotation preview and IDE setup.