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.
curl -sLO https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar
chmod +x cachetool.pharYou can alternatively download a compressed phar by using the URLs below.
# if your php installation has the zlib extension enabled
https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar.gz
# if your php installation has the bzip2 extension enabled
https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar.bz2CacheTool is also packaged as a docker container available in docker hub and github container registries.
See below for docker usage instructions.
Use tag name in the binary file name. E.g to download cachetool 3.2.2
which is compatible with PHP >=5.5.9 use: cachetool-3.2.2.phar
curl -sO https://gordalina.github.io/cachetool/downloads/cachetool-3.2.2.phar
chmod +x cachetool-3.2.2.pharCacheTool 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-chrootand--tmp-dirparameters
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- Using SymfonyHttpClient
php cachetool.phar opcache:status --web=SymfonyHttpClient --web-path=/path/to/your/document/root --web-url=http://url-to-your-document.rootYou 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 cacheImages are available in docker hub and github container registries:
gordalina/cachetool:latestghcr.io/gordalina/cachetool:latest
This is an example run with the web adapter:
APPDIR="/var/www/example.com"
DOCROOT="/var/www/example.com/current/web"
URL="http://example.com"
docker run --rm -v $APPDIR:$APPDIR -w $DOCROOT gordalina/cachetool cachetool --web --web-url=$URL [options] [arguments]If the website is behind a proxy and/or load balancer you may want to ask directly the webserver instead of the public facing ip. Additionally, the webserver may be listening in another port. This is an example for running cachetool from the webserver host in such a setup:
DOMAIN="example.com"
PORT="8008"
APPDIR="/var/www/example.com"
DOCROOT="/var/www/example.com/current/web"
URL="http://$DOMAIN:$PORT"
docker run --rm --add-host $DOMAIN:172.17.0.1 -v $APPDIR:$APPDIR -w $DOCROOT sbitio/cachetool --web --web-url=$URL [options] [arguments]Thank you to @jonhattan and @NITEMAN for the work with docker.
You can have a configuration file with the adapter configuration, allowing you to
call CacheTool without --fcgi, --cli, or --web option.
You can pass a --config <file> option to the application or it will choose to load
a file automaically.
The file must be named .cachetool.yml or .cachetool.yaml. 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 or /etc/cachetool.yaml 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:9000Will connect to cli (disregarding fastcgi configuration)
adapter: cli
fastcgi: /var/run/php5-fpm.sockCacheTool 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/cachetoolExample for the web adapter:
adapter: web
webClient: SymfonyHttpClient # defaults to FileGetContents
webUrl: http://example.com
webPath: /var/www/example.com/current/web
webBasicAuth: user:passwordYou 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]Add it as a dependency
composer require gordalina/cachetoolIf you want to use it in a Symfony 2.x project, require the 1.x version
composer require gordalina/cachetool:~1.0Create instance
use CacheTool\Adapter\FastCGI;
use CacheTool\CacheTool;
$adapter = new FastCGI('127.0.0.1:9000');
$cache = CacheTool::factory($adapter, '/tmp');You can use apcu and opcache functions
$cache->apcu_clear_cache();
$cache->opcache_reset();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());Running php cachetool.phar self-update will update a phar install with the latest version.
Cachetool uses box to built the phar, see box-project/installation.md on the best way to install it in your situation. To built run box compile, which will output cachetool.phar in the project root directory.
After running composer install, run ./vendor/bin/phpunit
Tests in tests/Adapter/Http/FileGetContentsTest and tests/Adapter/Http/SymfonyHttpClientTest rely on sslip.io to resolve hostnames containing an IP to the IP contained. For this to work a nameserver from sslip.io needs to be in the DNS servers configured on the host which runs those tests, otherwise hostnames like _.127.0.0.1.sslip.io used for testing will not resolve. The IP addresses for the DNS servers can be found on sslip.io, how to configure them depends on the system used to run the tests.
| CacheTool | PHP |
|---|---|
9.x |
>=8.1 |
8.x |
>=8.0 |
7.x |
>=7.3 |
6.x |
>=7.3 |
5.x |
>=7.2 |
4.x |
>=7.1 |
3.x |
>=5.5.9 |
2.x |
>=5.5.9 |
1.x |
>=5.3.3 |
CacheTool is licensed under the MIT License - see the LICENSE for details
