gordalina / cachetool
Manage your OPcache & APCu cache through the CLI
Fund package maintenance!
gordalina
Installs: 2 873 148
Dependents: 8
Suggesters: 0
Security: 0
Stars: 1 649
Watchers: 34
Forks: 154
Open Issues: 17
Requires
- php: >=8.1.0
- consolidation/self-update: ~2.1.0
- hollodotme/fast-cgi-client: ^3.0
- monolog/monolog: ^3.0
- psr/log: ^2.0 || ^3.0
- symfony/console: ^6.0
- symfony/dependency-injection: ^6.0
- symfony/finder: ^6.0
- symfony/http-client: ^6.0
- symfony/http-foundation: ^6.0
- symfony/process: ^6.0
- symfony/yaml: ^6.0
Requires (Dev)
- phpunit/phpunit: ^9.0
- dev-main
- 9.1.0
- 9.0.4
- 9.0.3
- 9.0.2
- 9.0.1
- 9.0.0
- 8.x-dev
- 8.6.1
- 8.5.1
- 8.5.0
- 8.4.1
- 8.4.0
- 8.3.1-alpha.0
- 8.3.0
- 8.2.0
- 8.1.0
- 8.1.0-alpha.1
- 8.1.0-alpha.0
- 8.0.3-alpha.0
- 8.0.2
- 8.0.1
- 8.0.1-alpha.1
- 8.0.1-alpha.0
- 8.0.0
- 7.x-dev
- 7.1.0
- 7.0.0
- 7.0.0-alpha.3
- 6.x-dev
- 6.6.0
- 6.6.0-alpha.0
- 6.5.0
- 6.4.0
- 6.4.0-alpha.1
- 6.4.0-alpha.0
- 6.3.1
- 6.3.0
- 6.2.0
- 6.1.2
- 6.1.1
- 6.1.0
- 6.0.0
- 5.x-dev
- 5.1.3
- 5.1.2
- 5.1.1
- 5.1.0
- 5.0.0
- 4.x-dev
- 4.1.1
- 4.1.0
- 4.0.1
- 4.0.0
- 3.x-dev
- 3.2.2
- 3.2.1
- 3.1.0
- 3.0.0
- 2.x-dev
- 2.1.0
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.x-dev
- 1.12.0
- 1.11.0
- 1.10.2
- 1.10.1
- 1.10.0
- 1.9.1
- 1.9.0
- 1.8.1
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.1
- 1.6.0
- 1.5.0
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.6
- 1.3.5
- 1.3.4
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-dependabot/composer/symfony/http-foundation-6.4.14
- dev-dependabot/composer/symfony/process-6.4.14
This package is auto-updated.
Last update: 2024-11-06 16:25:23 UTC
README
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.
Installation - Latest version
curl -sLO https://github.com/gordalina/cachetool/releases/latest/download/cachetool.phar chmod +x cachetool.phar
You 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.bz2
CacheTool is also packaged as a docker container available in docker hub and github container registries.
See below for docker usage instructions.
Installation - old versions
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.phar
Usage
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
- Using SymfonyHttpClient
php cachetool.phar opcache:status --web=SymfonyHttpClient --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
Usage via Docker
Images are available in docker hub and github container registries:
gordalina/cachetool:latest
ghcr.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.
Configuration File
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: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
Example for the web adapter:
adapter: web webClient: SymfonyHttpClient # defaults to FileGetContents webUrl: http://example.com webPath: /var/www/example.com/current/web webBasicAuth: user:password
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'); $cache = CacheTool::factory($adapter, '/tmp');
You can use apcu
and opcache
functions
$cache->apcu_clear_cache(); $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.
Building cachetool.phar
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.
Testing
After running composer install
, run ./vendor/bin/phpunit
Troubleshooting test failures
sslip.io
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.
Version Compatibility
License
CacheTool is licensed under the MIT License - see the LICENSE for details