Repository files navigation

DebugKit provides a debugging toolbar and enhanced debugging tools for CakePHPapplications. It lets you quickly see configuration data, log messages, SQLqueries, and timing data for your application.

⚠️ DebugKit is only intended for use in single-user local developmentenvironments. You should avoid using DebugKit in shared developmentenvironments, staging environments, or any environment where you need to keepconfiguration data and environment variables hidden.⚠️

• SQLite (pdo_sqlite) or another database driver that CakePHP can talk to. Bydefault DebugKit will use SQLite, if you need to use a different database see the Database Configuration section in the documentation linked below.

For details and older versions seeversion map.

• Install the plugin withComposer from your CakePHP Project's ROOT directory (where thecomposer.json file is located)

php composer.phar require --dev cakephp/debug_kit:"^5.0"

• Load the plugin

bin/cake plugin load DebugKit --only-debug

If you don't see a CakePHP icon on the bottom right of your page DebugKit is not beworking correctly. Some common problems are:

1. Your PHP environment doesn't have SQLite installed. Check your applicationlogs to confirm if this happening. You can either configure DebugKit to usea different database, or install the PDO SQLite 3 extension.
2. Your hostname needs to be added to theDebugKit.safeTld. If your localdomain isn't a known development environment name, DebugKit will disableitself to protect a potentially non-development environment.
3. If you are using theAuthorization Pluginyou need to setDebugKit.ignoreAuthorization totrue in your config.

If you have a problem with DebugKit please open an issue onGitHub.

If you'd like to contribute to DebugKit, check out theroadmap for anyplanned features. You canforkthe project, add features, and sendpullrequests or openissues.

Documentation for DebugKit can be found in theCakePHP documentation.

Panels by other plugins:

• L10n bySetup plugin to show current localization for Date, DateTime, Time objects/values.
• Twig byTwig plugin to list all templates.