Getting started
Running LaraBeacon
The command discovers applicable analyzers, executes them in the current Laravel application, prints category totals, and exits with a status your release process can use.
Run every applicable check
php artisan larabeaconThe summary separates performance, security, and reliability. A failed or errored analyzer returns exit code 1 unless it has been excluded from reporting; a clean run returns 0.
Show finding details
php artisan larabeacon --detailsDetailed output includes paths, line numbers, and analyzer messages where the check can identify them. Add --show-exceptions when diagnosing an analyzer error itself.
Run selected analyzers
Pass one or more fully qualified analyzer class names after the command.
php artisan larabeacon \
'BaerSoftware\LaraBeacon\Analyzers\Security\CSRFAnalyzer'This is useful while remediating one finding. A full scan should still run before release.
CI mode
php artisan larabeacon --ci --detailsCI mode skips analyzers listed in ci_mode_exclude_analyzers. Use it for deterministic pipeline checks, then run environment-dependent analyzers against a representative release candidate.
Create a baseline
After reviewing the current findings, write them to the published configuration:
php artisan larabeacon:baseline --ciThe command resets existing ignored errors before rebuilding the baseline. Review and commit the resulting config/larabeacon.php change so accepted risk has an owner and history.
Command options
| Option | Purpose |
|---|---|
--details | Print detailed output for failed checks. |
--ci | Apply the CI analyzer filter and retain deterministic exit behavior. |
--show-exceptions | Print analyzer exception stack traces in the local terminal. |
--report | Submit this run to a configured LaraBeacon Cloud endpoint. |
--hash=<sha> | Attach an explicit commit identifier to a Cloud report. |
--issue=<number> | Attach a pull-request or issue number to a Cloud report. |
--review | Mark the submitted report as requesting a repository review. |