Home

Peep shows what your PHP app is doing in a separate window: values you send with peep(), queries, logs, exceptions and jobs, and the mail and SMS it sends. It works in any PHP app from PHP 7.1 to 8.5 and sets itself up in Laravel.

Using Peep

• Getting Started: What Peep is, how it fits together, and your first card in five minutes.
• Installation: Install the viewer and the client, turn Peep on, and connect apps in Docker or on other machines.
• Version Support: Which PHP, Laravel, packages and operating systems each part supports and CI tests.
• Configuration: peep.php, environment variables, Docker paths, and the bridges for apps without Laravel.
• The Viewer: Cards, request groups, projects, filters, search, screens, pausing and settings.
• API Reference: How a card works, when nothing is sent, and every method of peep() at a glance.
• API Values: Sending values: send, pass, raw, text, HTML, JSON, XML, tables, images, files and links, and how values are shown.
• API Inspecting: The card's look, callers and traces, exceptions, timing, counting, catching, pausing and stopping.
• API Control: Sending less, turning Peep on and off, screens, notifications, SMS, and your own methods with macros.
• API Laravel: The Laravel methods: query and watcher switches, models, mail, Context, ->peep() on Laravel classes and Blade.
• Laravel: What Laravel shows with no code, the config, macros, Blade, mail and SMS.
• Query Debugging: Queries with bindings, slow and duplicate badges, and switching capture from the viewer.
• Plain PHP: Scripts and apps without a framework: errors, logs and dump().
• Symfony: Monolog, dump() and VarDumper casters in a Symfony app.
• Slim: Slim 3 and 4: the error middleware and loggers.
• WordPress: Themes and plugins, with a must-use plugin for errors.
• Global Install: peep() in every script of a PHP install, without Composer.
• Mail and SMS: Catch the mail and SMS your app sends: SMTP, the peep mailer, Mailgun, Twilio and Vonage.
• Webhooks: Call your app back with signed Mailgun, Twilio and Vonage events.
• Logs: Your app's log files as colored entries, with exceptions, context trees, live watching and filters.
• Desktop App: The viewer in its own window: display mode, tray, hotkey, notifications and updates.
• Finding Leftover Calls: peep-clean, artisan peep:clean and the PHPStan rule.
• AI Agents: Let an AI agent debug with Peep: the skill, vendor/bin/peep, the debug report and the MCP server.
• Troubleshooting: No cards, Docker, editor links, ports and failing webhooks.

Working on Peep

• Architecture: The client, the viewer, the UI and the desktop app, and one peep() call through them.
• Protocol: The HTTP and JSON protocol between the client and the viewer, and its safety rules.
• Contributing: Setting up, the rules that matter, running the tests, and what CI runs.
• Releasing: Betas from develop, stable releases on main, version.ts, and the repository settings.
• Wiki and Screenshots: Writing these pages, taking the screenshots, and how the wiki is published.