How to use laravel-ide-helper: install, generate and tips

Check requirements before you install

The README says the 3.x branch supports Laravel 10 and later. For older versions, use the 2.x releases instead.

Model generation requires a working database connection, because the command introspects the table of each model. Some facades may also be skipped if there is no default working connection.

• PHP and Composer
• Laravel 10 or later for the 3.x branch
• A working database connection for model generation

Install laravel-ide-helper as a dev dependency

Require the package with Composer using the command below. It is installed as a development dependency.

Generate autocompletion for facades

Run the generate command to create the facade helper file. It creates _ide_helper.php. Your IDE is expected to parse this file for autocomplete.

You can change the file name with the filename config. To regenerate the docs after updates, run the command again. The README also shows adding it to the post-update-cmd script in composer.json so it runs each time you update dependencies. If you do not want the full file, you can use the -M option to use an in-memory SQLite driver when a database connection is missing.

• Use --helpers (-H) to include helper files, which is not enabled by default
• Publish the config file to change implementations or set defaults for --helpers

Generate PHPDocs for Eloquent models

The models command generates PHPDocs based on table columns, relations and getters/setters. By default you are asked whether to overwrite or write to a separate file, _ide_helper_models.php.

Use --write (-W) to write comments directly into your model files, or --nowrite (-N) to avoid writing. The README says to back up your models before writing. The --reset (-R) option replaces the whole existing PHPDoc, including any comments you made. Without it, writing keeps existing comments and only appends new properties and methods.

• Use --write-mixin (-M) to add only a @mixin tag to the model and keep the generated docs in a separate file
• Use --write-eloquent-helper (-E) to generate a smaller helper file needed for QueryBuilder methods
• Use --ignore (-I) or the ignored_models config to skip models

Target specific models and directories

Pass model class names to scan only those models. By default, models in app/models are scanned. Use --dir to scan another directory, relative to the base path.

Know the editor-specific notes

The README says Sublime Text users need CodeComplice for autocompletion. It also mentions PhpStorm Meta files, which are generated with the ide-helper:meta command, for container instances.

Real-time facades are included through a @mixin annotation, but only if the framework has already generated their files in storage/framework/cache. Run the route, command or code first, then regenerate the helper file.