exp:expmigrationrecordstart

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

Start a recording of changes: one user's own changes (a session recording) or every change of the site (--site-wide), kept as the steps of a YAML migration; a dry run unless --apply

Usage

./console exp:expmigrationrecordstart [options]
php bin/php/expmigrationrecordstart.php [options]
./console exp:migration:record:start [options]

Aliases

exp:migration:record:start

Help

The output of ./console help exp:expmigrationrecordstart (the script run with --help), without the standard options:

Usage: bin/php/expmigrationrecordstart.php [OPTION]...
Start a recording of changes
From now until exp:migration:record:stop, what is changed is recorded at the kernel's operation level
(content published, moved, hidden, removed or translated, classes stored, roles, policies and their
assignments, sections, users and groups, URL aliases, settings written, workflow triggers), as the
steps of a YAML migration with remote ids and identifiers instead of numeric ids. A session recording
keeps the changes of one user (--user, by login; in the administration: the signed-in user), made
anywhere: the administration, the website sidebar, or a command run as that user. --site-wide opens
the site-wide window instead: every change of every user and of the console. One session recording
per user and one site-wide window at a time. The account of a user (login, e-mail, password) and the
fields of user objects are never recorded. --for=<minutes> or --until=<time> gives the recording a
window: it stops by itself when the window ends (at most 31 days). Without --apply it says what it
would start.

./console exp:migration:record:start --label="news section" --apply
./console exp:migration:record:start --user=editor --apply
./console exp:migration:record:start --site-wide --label="release 2.4 setup" --apply
./console exp:migration:record:start --site-wide --for=120 --label="editors' afternoon" --apply
./console exp:migration:record:start --site-wide --until="2026-11-20 18:00" --apply


Options:
  --apply         Make the changes (the default is a dry run that lists them and changes nothing)
  --dry-run       The default, accepted for scripts that pass it: list what would change, change nothing
  --format=VALUE  text (default) or json (the machine output exp-migration/1)
  --site-wide     The site-wide recording: every change of every user and of the console (without it: one user's own changes)
  --label=VALUE   The label of the caption or of the recording (a caption without one: "manual caption" with the time)
  --user=VALUE    The user, by login, whose own changes a session recording keeps (default: [RunSettings] RunAsUser of migration.ini)
  --for=VALUE     A window of this many minutes: the recording stops by itself when it ends
  --until=VALUE   A window until this time (2026-11-20 18:00, the server's time zone): the recording stops by itself then

Options

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/expmigrationrecordstart.php, kernel/private/classes/commands/expmigrationrecordstart.php

See also

Generated example: exp:expmigrationrecordstart

Added to the reference for Exponential 6.0.15.