Debug

Debugger and toolbar for Yii2 applications
Pico-inspired UI, scoped CSS, light/dark mode, and 14 inspection panels

> [!WARNING] > **Development only.** Never enable the debugger in production. Keep access restricted to trusted development IPs > and install production dependencies with `composer install --no-dev`. ## Features ## Quick start ### Installation Requires PHP 8.3 or newer and Yii2 22.x. The 0.2 line does not support Yii2 2.0.x. When upgrading from 0.1, review the [changelog](CHANGELOG.md) for breaking changes. Keep the debugger and `php-forge/debug-core` up to date together in the application's lock file. ### Enable the debugger In your application's entry script, set `YII_ENV` to `dev` before loading Yii. Then register the module in `config/web.php`, before returning `$config`: Keep the registration inside the development guard. Do not bootstrap the module in production. ### Basic usage Open an application page, expand the toolbar at the bottom, and select a panel chip to inspect the request. Use the Yii chip for Configuration and the PHP chip for PHP info. Switch between light and dark themes from the toolbar, and press `Escape` to close the drawer. Open the `debug/index` route to browse retained requests. Select two captures in History to compare request metrics and panel changes, then open either capture for its details. Comparison shows structural counts without exposing panel values. ## Configuration The module runs with no options: up to 50 retained requests, captures under `@runtime/debug`, and a bottom toolbar. See the [configuration reference](docs/configuration.md) for custom collectors and panels, the Inertia and Vite providers, database thresholds, IDE links, and the standalone router. ## Security The toolbar and debugger routes allow `127.0.0.1` and `::1` by default. Add only trusted development addresses to `allowedIPs`; never expose the debugger publicly. A `checkAccessCallback` can further restrict allowed requests. Request, identity, and queue captures redact common sensitive fields, and so do Inertia captures registered with the capture-policy closure shown in the configuration reference. Logs preserve original diagnostic values and are not redacted by the capture policy; SQL diagnostics can include substituted query values. Treat stored captures as sensitive and review them before sharing. In the Events panel, context capture and source traces are disabled by default. This does not disable source traces in Logs or Database. To redact additional exact keys, extend the defaults instead of replacing them: ## Browser support Use a current browser with Web Components, native JavaScript modules, and CSS custom properties. Internet Explorer is not supported. ## Documentation - [Configuration reference](docs/configuration.md) - [Panel screenshots](docs/screenshots.md) - [Testing guide](docs/testing.md) - [Changelog](CHANGELOG.md) ## Package information [](https://www.php.net/releases/8.3/en.php) [](https://github.com/yiisoft/yii2/tree/22.0) [](https://packagist.org/packages/yii2-extensions/debug) [](https://packagist.org/packages/yii2-extensions/debug) ## Project status [](https://codecov.io/github/yii2-extensions/debug) [](https://github.com/yii2-extensions/debug/actions/workflows/static.yml) [](https://github.com/yii2-extensions/debug/actions/workflows/quality.yml) [](https://github.styleci.io/repos/699842423?branch=main) ## Our social networks [](https://x.com/Terabytesoftw) [](https://www.facebook.com/wilmer.arambula.9) [](https://www.reddit.com/r/Yii2/) [](https://t.me/yii_framework_in_english) ## License [](LICENSE)