juampi92/artisan-cache-debug

Simple artisan command to debug your redis cache

v1.2 2023-03-07 09:12 UTC

README

Simple artisan command to debug your redis cache

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

🚀 Installation

You can install the package via composer:

composer require juampi92/artisan-cache-debug --dev

If you would like to debug the cache in production, you can install it without the --dev flag.

Usage

The simplest usage:

php artisan cache:debug

Options

Option / Flag Description
--key=* Will filter the keys. Can use wildcard. Example: --key=*:translations. Read more
--heavier-than[=HEAVIER-THAN] Will hide keys lighter than X. Use a format like 10bytes, 1kb, 8b
--sort-by[=SORT-BY] Will sort the keys by size or key. [default: "size"]
--sort-dir[=SORT-DIR] Set the sorting direction: asc or desc.
--forever Will only show non-expiring keys.
--with-details Show the type of every cache record.
--store= In case you want to debug a cache store other than the default.

Testing

sail up -d
composer test

Contributing

Please see CONTRIBUTING for details.

To-do

Some ideas to expand this package:

  • Pagination
  • Filter on type
  • Display the TTL (currently can't make it fit in the results)
  • Support memcache?

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.