CacheTool - Manage cache in the CLI
CacheTool allows you to work with APCu, OPcache, and the file status cache through the CLI. It will connect to a FastCGI server (like PHP-FPM) and operate on its cache.
Why is this useful?
Maybe you want to clear the bytecode cache without reloading php-fpm or using a web endpoint
Maybe you want to have a cron which deals with cache invalidation
Maybe you want to see some statistics right from the console
And many more...
Note that, unlike APCu and Opcache, the file status cache is per-process rather than stored in shared memory. This means that running stat:clear against PHP-FPM will only affect whichever FPM worker responds to the request, not the whole pool. Julien Pauli has written a post with more details on how the file status cache operates.
Compatibility
CacheTool 5.x works with PHP >=7.2
CacheTool 4.x works with PHP >=7.1
CacheTool 3.x works with PHP >=5.5.9
CacheTool 2.x works with PHP >=5.5.9
CacheTool 1.x works with PHP >=5.3.3
Installation - Latest version
curl -sO https://gordalina.github.io/cachetool/downloads/cachetool.phar
chmod +x cachetool.phar
Installation - old versions
Use tag name in the binary file name. E.g to download cachetool 3.2.1 which is compatible with PHP >=5.5.9 use: cachetool-3.2.1.phar
curl -sO https://gordalina.github.io/cachetool/downloads/cachetool-3.2.1.phar
chmod +x cachetool-3.2.1.phar
Usage (as an application)
CacheTool requires an adapter to connect to, it can be cli, fcgi, and web. The fcgi adapter is the most common, as it connects directly to php-fpm.
You can pass an IP address or a unix socket to the --fcgi adapter, or leave it blank and CacheTool will try to find the php-fpm socket for you. If it can't find it, it will default to 127.0.0.1:9000.
You can let CacheTool find the unix socket for you, or default to IP.
php cachetool.phar apcu:cache:info --fcgi
You can connect to a fastcgi server using an IP address
php cachetool.phar apcu:cache:info --fcgi=127.0.0.1:9000
You can connect to a fastcgi server using a unix socket
php cachetool.phar opcache:status --fcgi=/var/run/php5-fpm.sock
To connect to a chrooted fastcgi server you need to set --fcgi-chroot and --tmp-dir parameters
php cachetool.phar opcache:status --fcgi=/var/run/php5-fpm.sock --fcgi-chroot=/path/to/chroot --tmp-dir=/path/to/chroot/tmp
Using the CLI
php cachetool.phar opcache:status --cli
Using an HTTP interface
php cachetool.phar opcache:status --web --web-path=/path/to/your/document/root --web-url=http://url-to-your-document.root
You have some useful commands that you can use
apcu
apcu:cache:clear Clears APCu cache
apcu:cache:info Shows APCu user & system cache information
apcu:cache:info:keys Shows APCu keys cache information
apcu:key:delete Deletes an APCu key
apcu:key:exists Checks if an APCu key exists
apcu:key:fetch Shows the content of an APCu key
apcu:key:store Store an APCu key with given value
apcu:regexp:delete Deletes all APCu key matching a regexp
apcu:sma:info Show APCu shared memory allocation information
opcache
opcache:compile:script Compile single script from path to the opcode cache
opcache:compile:scripts Compile scripts from path to the opcode cache
opcache:configuration Get configuration information about the cache
opcache:invalidate:scripts Remove scripts from the opcode cache
opcache:reset Resets the contents of the opcode cache
opcache:reset:file-cache Deletes all contents of the file cache directory
opcache:status Show summary information about the opcode cache
opcache:status:scripts Show scripts in the opcode cache
stat
stat:clear Clears the file status cache, including the realpath cache
stat:realpath_get Show summary information of realpath cache entries
stat:realpath_size Display size of realpath cache
Configuration File
You can have a configuration file with the adapter configuration, allowing you to call CacheTool without --fcgi, --cli, or --web 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
CacheTool writes files to the system temporary directory (given by sys_get_temp_dir()) but if you want to change this, for example, if your fastcgi service is run with PrivateTemp you can set it on the config file:
adapter: fastcgi
fastcgi: /var/run/php5-fpm.sock
temp_dir: /dev/shm/cachetool
You can define the supported extensions in the config file. By default, apcu, and opcache are enabled. To disable apcu, add this to your config file:
extensions: [opcache]
Usage (as a library)
Add it as a dependency
composer require gordalina/cachetool
If you want to use it in a Symfony 2.x project, require the 1.x version
composer require gordalina/cachetool:~1.0
Create instance
use CacheTool\Adapter\FastCGI;
use CacheTool\CacheTool;
$adapter = new FastCGI('127.0.0.1:9000', $tempDir = '/tmp');
$cache = CacheTool::factory($adapter);
You can use apcu and opcache functions
$cache->apcu_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 ApcuProxy, 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\ApcuProxy());
$cache->addProxy(new Proxy\PhpProxy());
Updating CacheTool
Running php cachetool.phar self-update will update a phar install with the latest version.
Testing
After running composer install, run ./vendor/bin/phpunit
Troubleshooting
[RuntimeException] Error: Unable to open primary script: /dev/shm/cachetool-584743c678dbb.php (No such file or directory) Status: 404 Not Found Content-type: text/html; charset=UTF-8 No input file specified.
This means that cachetool could not write to /dev/shm provide a directory that cachetool can write to through php cachetool.phar --tmp-dir=/writable/dir or configuration.
License
CacheTool is licensed under the MIT License - see the LICENSE for details