soloterm/dumps

A Laravel command to intercept dumps from your Laravel application.

Maintainers

Details

github.com/soloterm/dumps

Source

Issues

Fund package maintenance!
aarondfrancis
aaronfrancis.com/backstage

Installs: 1 143

Dependents: 2

Suggesters: 0

Security: 0

Stars: 8

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.1 2025-03-20 17:41 UTC

Requires

Requires (Dev)

MIT a1946b0a9b8038a1d4ef4da5a4f0d25604f68d1b

  • Aaron Francis <aarondfrancis.woop@gmail.com>

This package is auto-updated.

Last update: 2025-03-20 17:48:32 UTC

README

Latest Version on Packagist Total Downloads License

Solo Dumps for Laravel is a package that intercepts and collects dump() calls from your Laravel application and displays them in a dedicated terminal window. This eliminates the need to clutter your browser or API responses with debug output.

Screenshot

This library was built to support Solo, your all-in-one Laravel command to tame local development.

This package is especially useful when:

  • You're working with APIs where you can't see dumps in the browser
  • You want to keep your browser console clean
  • You want to centralize all your debugging output in one place
  • You need source file information for your dumps

Installation

  1. Require the package:
composer require soloterm/dumps --dev

The package will automatically register the service provider.

Usage

Simply run:

php artisan solo:dumps

This will start a server that intercepts all dump() calls from your Laravel application. The command will keep running and display any dumps in real-time.

Now when you use dump() anywhere in your application, the output will be sent to this terminal window instead of your browser or API response.

Features

  • Intercepts all dump() calls from your Laravel application
  • Shows the exact file and line number where the dump was called
  • Formats the output using Laravel's CLI dumper for better readability
  • Works with APIs, background jobs, and other contexts where dumps are normally hard to see
  • Preserves all the functionality of Laravel's dump helper
  • Restores regular dump functionality when the command is stopped

Works with Solo for Laravel

If you're using Solo for Laravel, you can add the dumps command to your configuration:

// config/solo.php

'commands' => [
    // ... other commands
    'Dumps' => 'php artisan solo:dumps',
],

Configuration

You can configure the dump server host in your config/solo.php file:

// config/solo.php

return [
    // ... other configurations
    'dump_server_host' => 'tcp://127.0.0.1:9984',
];

There is no dedicated dumps config file. You can either create a solo.php and put the dump_server_host in there, or add it to your existing solo.php file.

How It Works

The package works by:

  1. Registering a custom var dumper handler that captures dump calls
  2. Resolving the source file and line number of the dump before sending to the server
  3. Sending the dump data to a server running in a separate process
  4. Displaying the formatted dump with source information in the terminal

FAQ

Does this work with dd()?

No, this package only intercepts dump() calls. The dd() function will still halt execution as normal.

Can I use this with APIs?

Yes! This is one of the main benefits. Your API responses will remain clean while all dumps go to the dedicated terminal window.

Will this affect my application in production?

The package is designed to be used in development only. It's recommended to install it with the --dev flag to ensure it's not included in production.

Support

This is free! If you want to support me:

Credits

Dumps for Laravel was developed by Aaron Francis. If you like it, please let me know!