README

Real-time PHP debugging in the browser.

DebugPHP streams your debug output to a browser-based dashboard via Server-Sent Events — no page reloads, no desktop apps, no configuration headaches.

Why DebugPHP?

Installation

composer require callmeleon167/debugphp --dev

Requirements: PHP 8.1+ and the curl extension.

Quick Start

use DebugPHP\Debug;

// 1. Initialize with your session token from the dashboard
Debug::init('your-session-token');

// 2. Send anything
Debug::send('Hello DebugPHP!');
Debug::send($user);
Debug::send($request->all());

Open the Dashboard in your browser — your debug data appears in real-time.

Self-Hosted

Want to keep your debug data on your own server? Use the DebugPHP Server:

Option A — PHP built-in server

git clone https://github.com/CallMeLeon167/debugphp-server.git
cd debugphp-server
composer install
php -S localhost:8787

Then point your configuration to your local server:

Debug::init('your-session-token', [
    'host' => 'http://localhost:8787',
]);

Option B — Docker

git clone https://github.com/CallMeLeon167/debugphp-server.git
cd debugphp-server
docker compose up

Enable auto-detection so the client finds the server automatically:

Debug::init('your-session-token', [
    'dockerized' => true,
]);

How It Works

1. Your PHP app sends debug data via HTTP to the DebugPHP server.
2. The server stores the entry and pushes it to the dashboard via SSE.
3. The browser dashboard renders the entry in real-time.

┌──────────────┐     POST /api/debug     ┌──────────────┐     SSE Stream     ┌──────────────┐
│   Your App   │ ──────────────────────→ │   DebugPHP   │ ────────────────→  │  Dashboard   │
│  Debug::send │                         │    Server    │                    │   (Browser)  │
└──────────────┘                         └──────────────┘                    └──────────────┘

Contributing

Please read CONTRIBUTING.md before opening a pull request.

License

MIT — see LICENSE for details.

Links

• Website: debugphp.dev
• Documentation: debugphp.dev/docs
• Server: github.com/CallMeLeon167/debugphp-server
• Dashboard: dashboard.debugphp.dev