Cachetool

Manage your caches through the cli

View the Project on GitHub gordalina/cachetool

CacheTool - Manage cache in the CLI

CacheTool allows you to work with apc and opcache through the cli. It will connect to a fastcgi server (like php-fpm) and operate it's cache.

Why is this useful?

Installation

$ curl -sO http://gordalina.github.io/cachetool/downloads/cachetool.phar
$ chmod +x cachetool.phar

Usage (as an application)

You can connect to a automatically guessed fastcgi server (if /var/run/php5-fpm.sock is a file or 127.0.0.1:9000)

$ php cachetool.phar apc:cache:info --fcgi

You can connect to a fastcgi server through ip

$ php cachetool.phar apc:cache:info --fcgi=127.0.0.1:9000

Or by socket

$ php cachetool.phar opcache:status --fcgi=/var/run/php5-fpm.sock

Or to the cli

$ php cachetool.phar opcache:status --cli

You have some useful commands that you can you

apc
  apc:bin:dump             Get a binary dump of files and user variables
  apc:bin:load             Load a binary dump into the APC file and user variables
  apc:cache:clear          Clears APC cache (user, system or all)
  apc:cache:info           Shows APC user & system cache information
  apc:cache:info:file      Shows APC file cache information
  apc:key:delete           Deletes an APC key
  apc:key:exists           Checks if an APC key exists
  apc:key:fetch            Shows the content of an APC key
  apc:key:store            Store an APC key with given value
  apc:sma:info             Show APC shared memory allocation information
opcache
  opcache:configuration    Get configuration information about the cache
  opcache:reset            Resets the contents of the opcode cache
  opcache:status           Show summary information about the opcode cache
  opcache:status:scripts   Show scripts in the opcode cache

Configuration File

You can have a configuration file with the adapter configuration, allowing you to call CacheTool without --fcgi or --cli option.

The file must be named .cachetool.yml. CacheTool will look for this file on the current directory and in any parent directory until it finds one. If the paths above fail it will try to load /etc/cachetool.yml configuration file.

An example of what this file might look like is:

Will connect to fastcgi at 127.0.0.1:9000

adapter: fastcgi
fastcgi: 127.0.0.1:9000

Will connect to cli (disregarding fastcgi configuration)

adapter: cli
fastcgi: /var/run/php5-fpm.sock

Usage (as a library)

Add it as a dependency

$ composer require gordalina/cachetool=~1.0

Create instance

use CacheTool\Adapter\FastCGI;
use CacheTool\CacheTool;

$adapter = new FastCGI('127.0.0.1:9000');
$cache = CacheTool::factory($adapter);

You can use apc and opcache functions

$cache->apc_clear_cache('both');
$cache->opcache_reset();

Proxies

CacheTool depends on Proxies to provide functionality, by default when creating a CacheTool instance from the factory all proxies are enabled ApcProxy, OpcacheProxy and PhpProxy, you can customize it or extend to your will like the example below:

use CacheTool\Adapter\FastCGI;
use CacheTool\CacheTool;
use CacheTool\Proxy;

$adapter = new FastCGI('/var/run/php5-fpm.sock');
$cache = new CacheTool();
$cache->setAdapter($adapter);
$cache->addProxy(new Proxy\ApcProxy());
$cache->addProxy(new Proxy\PhpProxy());

Updating CacheTool

Running php cachetool.phar self-update will update a phar install with the latest version.

Requirements

PHP 5.3.3

License

CacheTool is licensed under the MIT License - see the LICENSE for details