Usage

A short tour of the high-level commands. Each section has a dedicated guide with the full set of options.

Annotations

Run on your app:

bin/cake annotate [type]

The command writes annotations and prints the changes. Add -d to preview without writing files.

Run on a loaded plugin:

bin/cake annotate [type] -p FooBar

The plugin is autoloaded if needed (when not manually loaded already).

Use -v for verbose output:

bin/cake annotate [type] -v

Add -d (--dry-run) to simulate the output without modifying files.

See Annotations for the full reference.

Code Completion

The code completion file aims to be generic and to work with all IDEs.

Generate the code completion files into TMP/:

bin/cake generate code_completion

See Code Completion.

Meta File Generator

The meta file is supported by:

• PhpStorm (2016.2+)
• VS Code with the PHP Intelephense plugin

Generate the app-level .phpstorm.meta.php file:

bin/cake generate phpstorm

See Generator.

Illuminator

Rewrite PHP files using configured Illuminator tasks:

bin/cake illuminate code [path]

Use -v for verbose output and -t (--task) with a comma-separated list to limit the run to specific tasks. Add -d (--dry-run) to simulate.

See Illuminator.

Recommended composer Scripts

Group commands so they are easy to remember and easy to wire into hooks or CI:

"scripts": {
    "setup": "bin/cake generate code_completion && bin/cake generate phpstorm",
    "annotate": "bin/cake annotate all && bin/cake annotate all -p Sandbox",
    "illuminate": "bin/cake illuminate code"
}

That way you only have to remember the wrapper commands:

• composer setup: also useful as a Git hook after checkout/pull
• composer annotate: include all your /plugins/ (the non-vendor ones)
• composer illuminate: include all your /plugins/ (the non-vendor ones)