Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:velocity

The command exp:velocity (bin/php/velocity.php).

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/velocity.md

On this page

exp:velocity

Script bin/php/velocity.php, code in kernel/private/classes/commands/velocity.php. Run it from the installation root, as the user the web server runs as:

./console exp:velocity --help
./console exp:vc --help
php bin/php/velocity.php --help

Options

OptionValueHelp
--jsonReport as JSON, for a caller that is not a person
--keep-globalrequiredMore globals to keep between requests (comma-separated), appended to the built-in defaults and velocity.ini KeepGlobals[]; for start, restart and command
--enginerequiredphp, frankenphp or qbix -- or several, comma-separated -- for this command only, instead of [ServerSettings] Engine
--fromrequiredinstall: take the binary from this file instead of downloading it (still verified)
--forceinstall: download again even if the binary is already there
--checkinstall: re-hash the installed binary against its SHA-256
--trust-github-digestinstall: with no Sha256 pinned for the version, accept the digest GitHub publishes for the release
--allstart, stop, restart, graceful, kill or status every engine, one after the other
--https
--no-https
--rebuild-pharstart, restart, graceful, deploy: rebuild the engine archive even when it is current
--kerneldeploy: regenerate the kernel autoload array too (kernel/ and lib/ only)
--applyconfig set|unset, cache clear, layout migrate, site|conf|mod, ssl renew, watchdog install|remove, install: make the change (without it they are a dry run that changes nothing)
--dry-runthe default of the commands that write (kept for scripts that pass it); deploy: print the steps and what each would do, and do nothing
--no-fpmdeploy: leave PHP-FPM alone (no reload, no wait)
--fpm-reloaddeploy: reload PHP-FPM even when its OPcache revalidates the files (php.ini or pool changed, files renamed)
--no-velocitydeploy: do not restart Velocity
--no-autoloaddeploy: do not regenerate autoload arrays
--packerdeploy: clear the packed scripts and styles too (ezjscore-packer, right before template-block)
--clear-contentdeploy: clear the content, exphttpcache, template-block and response caches even when no template, design file, setting or translation changed
--all-cachesdeploy: clear every cache, whatever changed since the last deploy
--cachesrequireddeploy: clear these caches too, whatever changed (ids or tags of ezcache, comma-separated: the list a migration run reports)
--migratedeploy: run the pending migrations (exp:migration:migrate --apply) before PHP-FPM and Velocity run the new code, whatever [DeploySettings] Migrate says
--no-migratedeploy: do not run the pending migrations, whatever [DeploySettings] Migrate says

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).

Arguments: [command].


Generated by ./console exp:help:examples from bin/php/velocity.php, kernel/private/classes/commands/velocity.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x