PHPackages                             chisnall/squiz - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Debugging &amp; Profiling](/categories/debugging)
4. /
5. chisnall/squiz

ActiveLibrary[Debugging &amp; Profiling](/categories/debugging)

chisnall/squiz
==============

Squiz debugger for Laravel

v1.0.3(1mo ago)034MITPHPPHP ^8.0

Since Nov 9Pushed 6mo agoCompare

[ Source](https://github.com/chisnall/squiz)[ Packagist](https://packagist.org/packages/chisnall/squiz)[ RSS](/packages/chisnall-squiz/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (4)Versions (5)Used By (0)

Squiz Debugger for Laravel
==========================

[](#squiz-debugger-for-laravel)

*squiz* : colloquial (originally Australian and New Zealand).
A look; a glance. Frequently (and in earliest use) in to have (also take) a squiz (at): to have a look (at someone or something).

Squiz is a debugger for Laravel.

It allows you to make use of the Symfony VarDumper component output on a single screen dedicated for debugging and for observing your application.

It works with Laravel versions 9 to 12.
It has not been tested on previous versions.

[![screenshot](https://github.com/chisnall/squiz/raw/main/screenshot.png "Screenshot")](https://github.com/chisnall/squiz/blob/main/screenshot.png)

Installation
------------

[](#installation)

Install with composer:

```
composer require chisnall/squiz --dev

```

Default URL
-----------

[](#default-url)

The debugging page will default to this route in your application:

/squiz

This can be customised. See **Custom Settings** below.

Usage
-----

[](#usage)

### Helper function

[](#helper-function)

To add an entry to the log use the helper function:

```
squiz($var)

```

Providing a string or variable.

Multiple arguments are supported:

```
squiz($var1, $var2, $var3)

```

Any variable is supported: scalars, arrays, objects and resources. Even methods in objects.

This will render the output in the same style as the `dump()` function in VarDumper.

You can use the helper function anywhere in your code. Even in unit testing, feature testing and blade views.

### Log and terminate

[](#log-and-terminate)

If you want to terminate code execution immediately after logging, use this helper function:

```
squizd()

```

That is similar to the `dd()` function in VarDumper.

### Comments

[](#comments)

An optional comment can also be supplied. Prefix with `comment:`

```
squiz($var, 'comment:Comment goes here')

```

### Blade directives

[](#blade-directives)

These are provided:

```
@squiz
@squizd

```

### Backtrace alias

[](#backtrace-alias)

A backtrace alias is provided for convenience: `__backtrace__`

Example:

```
squiz($var, '__backtrace__')

```

### Production environments

[](#production-environments)

If a production environment is detected, the helper functions do not log anything. They simply return.
So it is safe to leave helper function code in your project.

Log Entries
-----------

[](#log-entries)

When the helper function is called, a new entry will be displayed on the debugging page.

Each entry shows:

1. date and time
2. the name of the script the helper function was called from
3. the line number the helper function was called from
4. an optional comment
5. the output of VarDumper

Custom Settings
---------------

[](#custom-settings)

Put these in your .env file to customise settings.

```
SQUIZ_TOKEN=
SQUIZ_POLLING_INTERVAL=1000
SQUIZ_STORAGE_PATH=[your Laravel storage path]
SQUIZ_ROUTE_PATH=/squiz
SQUIZ_TITLE="Squiz"
SQUIZ_HEADING="Squiz"

```

The above values are the defaults if they are not specified in the .env file.

`SQUIZ_TOKEN` optional token to protect the debugging page route and API routes. Ignored on local environments.

`SQUIZ_POLLING_INTERVAL` the polling interval in ms.

`SQUIZ_STORAGE_PATH` the Laravel storage path. **\[1\]**

`SQUIZ_ROUTE_PATH` the route path for the debugging page and API routes.

`SQUIZ_TITLE` title for the debugging page.

`SQUIZ_HEADING` heading text for the debugging page.

**\[1\]** set this if you are running unit or feature tests and you are using a temporary storage path while testing, yet still want to use the squiz() helper function in your tests.

Token
-----

[](#token)

If a token is specified in your .env file, specify the token as follows when visiting the debugging page:

```
/squiz?token=[token goes here]

```

If a token is specified, it is not required for local environments. It will only be used for staging and production environments.

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance77

Regular maintenance activity

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~46 days

Total

4

Last Release

51d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/49f92c6ddbf60ba32df1ba659eb598ce61ff07a920c0a727758a561e97e58858?d=identicon)[Lee C](/maintainers/Lee%20C)

---

Top Contributors

[![chisnall](https://avatars.githubusercontent.com/u/155248915?v=4)](https://github.com/chisnall "chisnall (8 commits)")

---

Tags

laraveldevdebug

### Embed Badge

![Health badge](/badges/chisnall-squiz/health.svg)

```
[![Health](https://phpackages.com/badges/chisnall-squiz/health.svg)](https://phpackages.com/packages/chisnall-squiz)
```

###  Alternatives

[barryvdh/laravel-debugbar

PHP Debugbar integration for Laravel

19.2k124.3M624](/packages/barryvdh-laravel-debugbar)[php-debugbar/php-debugbar

Debug bar in the browser for php application

4.4k21.3M40](/packages/php-debugbar-php-debugbar)[fruitcake/laravel-debugbar

PHP Debugbar integration for Laravel

19.1k662.9k29](/packages/fruitcake-laravel-debugbar)[fruitcake/laravel-telescope-toolbar

Toolbar for Laravel Telescope based on Symfony Web Profiler

8041.6M3](/packages/fruitcake-laravel-telescope-toolbar)[laracraft-tech/laravel-xhprof

Easy XHProf setup to profile your laravel application!

235321.4k](/packages/laracraft-tech-laravel-xhprof)[daylerees/anbu

The Anbu profiler for Laravel 4.

3054.9k](/packages/daylerees-anbu)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
