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

exp:expimagealias

Image aliases made on demand: status, generate, regenerate, purge, resync and test, in the process or as jobs.

Download as PDF

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

On this page

exp:expimagealias

Image aliases made on demand: status, generate, regenerate, purge, resync and test, in the process or as jobs.

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

./console exp:expimagealias --help
./console exp:image:alias --help
php bin/php/expimagealias.php --help

Options

OptionValueHelp
--formatrequiredtext (the default) or json (the machine output exp-image-alias/1)
--noderequiredthe images of the object at this node
--subtreerequiredthe images of every object below this node (the node included)
--objectrequiredtest: the images of this object
--classrequiredonly objects of these classes (identifiers, separated by commas)
--attributerequiredonly these image attributes (identifiers, separated by commas)
--aliasrequiredonly these aliases (separated by commas; resync: original for the originals); test: make or check this alias
--sincerequiredonly objects changed since: a date (2026-11-01, "2026-11-01 14:30") or a time ago (2d, 12h, 30m, "1 week")
--limitrequiredat most this many images
--dry-rungenerate, regenerate, purge: count the images only; resync: say what would be fetched; test --alias: report only
--overwriteresync: replace files that differ from the source (the default fetches missing files only)
--queuequeue the run as a job and print its id, instead of running it here
--waita run here waits while bulk runs are paused, instead of stopping
--allregenerate, purge: allow a run over every image of the installation
--jobrequiredstatus: one job of image aliases, with its progress
--pauseoptionalstatus: pause bulk runs on every server (an optional reason: --pause="nightly import")
--resumestatus: let paused bulk runs go on
--cancelrequiredstatus: cancel this job (one that waits ends now, one that runs stops after its current image)
--sourceoptionaltest: test the connection to a staging source (default the one SyncFrom names)
--pathrequiredtest --source: a storage path to ask the source for (default its base address)

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: [subcommand].


Generated by ./console exp:help:examples from bin/php/expimagealias.php, kernel/private/classes/commands/expimagealias.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