Quick Start

Get up and running with Laradebug in 5 minutes.

Step 1: Add Your Project

When you first open Laradebug, you'll see an empty project list.

1. Click "Add Project" or use Cmd + O
2. Navigate to your Laravel project folder
3. Select the folder containing your artisan file
4. Click Open

Laradebug will validate your project and detect:

• Laravel version
• PHP version
• Environment (local/production from .env)

Multiple Projects

You can add multiple Laravel projects. Switch between them from the sidebar.

Step 2: Write Your First Command

Once your project is loaded:

1. Click in the Code Editor panel
2. Type some PHP code:

User::where('active', true)->count()

3. Press Cmd + R or click Run

Step 3: View the Output

After execution, you'll see:

• Output Panel — The return value of your code
• SQL Panel — Any database queries that ran
• Timing — How long execution took

Output: 42

SQL Queries (1):
├─ SELECT COUNT(*) FROM users WHERE active = 1
└─ Time: 2.4ms

Step 4: Enable Debug Panels

Toggle the debug panels you need:

Panel	Toggle	Description
SQL	Click "SQL" tab	Database queries
Ray	Click "Ray" tab	Ray/LaraDumps output
Logs	Click "Logs" tab	Laravel log entries
HTTP	Click "HTTP" tab	Outgoing HTTP requests

Step 5: Try Ray Debugging

If you have Spatie Ray installed:

$users = User::with('posts')->limit(5)->get();
ray($users);

The debug output appears instantly in the Ray panel.

Ray Installation

Don't have Ray? You can still use dump() and dd() — output appears in the Output panel.

Example Session

Here's a typical debugging session:

// Find users with recent orders
$users = User::whereHas('orders', function ($q) {
    $q->where('created_at', '>', now()->subDays(7));
})->get();

// Debug the collection
ray($users->pluck('email'));

// Check the query
// (Automatically captured in SQL panel)

What you'll see:

• Output: The user collection
• SQL Panel: The complex query with joins
• Ray Panel: List of email addresses

Keyboard Shortcuts

Shortcut	Action
Cmd + R	Run code
Cmd + K	Clear output
Cmd + S	Save as snippet
Cmd + O	Open project
Cmd + ,	Open settings

Next Steps

• Configuration — Customize Laradebug settings
• SQL Logging — Learn about query logging
• Ray Integration — Set up Ray debugging
• AI Assistant — Get AI-powered help