Console Commands

Gives Matrix content inside Vizy blocks its own owner where older content still relies on the Matrix data stored in the document. Run it after an upgrade, or when Content Recovery reports shared Matrix references. The command checks every element type on every site, resaves only the element and site rows that need a backfill, and preserves their last-updated dates. Its counts refer to element and site rows, so a multisite element can appear more than once.

php craft vizy/anchors/backfill --dry-run
php craft vizy/anchors/backfill --site=default --element-id=123
php craft vizy/anchors/backfill --drafts --revisions --trashed

Matrix in Vizy Blocks explains when a backfill is needed and how to check the result.

Repairs block content saved in the Vizy 3 block format whose field values are keyed by a field UID instead of a field handle. For each value Vizy can't match to a field in the Block Type's layout, the command shows a preview of the content and asks you to choose the field it belongs to, then remembers that choice for the same UID. Run it interactively, and back up your database first, because it writes directly to the content table.

php craft vizy/content/fix-vizy-block-field-uids

Analyses a CKEditor or Redactor field before converting it to Vizy, and prints the JSON plan. It doesn't change Project Config or content. The command exits with an error code when the plan's status is blocked.

php craft vizy/convert/analyze articleBody
php craft vizy/convert/analyze articleBody article 50

Converts a CKEditor or Redactor field to Vizy. It changes the field type through Project Config, writes a content migration to your project's content migration folder, applies it locally and verifies the result. It takes the same arguments as vizy/convert/analyze.

php craft vizy/convert/field articleBody
php craft vizy/convert/field articleBody --allow-lossy

Analyses copying a Vizy field into an existing Plain Text, CKEditor or Redactor field, and prints the JSON plan without changing anything. The command exits with an error code when the plan's status is blocked.

php craft vizy/convert/analyze-from-vizy articleBody articleBodyCkeditor

Copies a Vizy field's content into an existing Plain Text, CKEditor or Redactor field and writes a content migration for the copy. The Vizy field and both field definitions stay unchanged. It takes the same arguments as vizy/convert/analyze-from-vizy.

php craft vizy/convert/from-vizy articleBody articleBodyCkeditor --allow-lossy

Lists Vizy's recovery records as JSON, newest first, for every owner or for one owner element ID.

php craft vizy/recovery/index
php craft vizy/recovery/index 123

Restores one recovery record by its ID. It replaces that Vizy field and its nested content across the record's sites, leaving the owner's other fields unchanged, and captures the content it replaces as a new record.

php craft vizy/recovery/restore 456

Deletes older records captured automatically when an owner is saved, keeping the newest ones for each owner and Vizy field. Records captured before operations such as upgrades, conversions and ownership repairs are always kept.

php craft vizy/recovery/prune
php craft vizy/recovery/prune 5 123

Checks the installation for Vizy 3 fields and upgrades them. When an earlier upgrade didn't finish, the command resumes it instead. It stops with an error when the analysis isn't ready or when more than one unfinished upgrade exists.

php craft vizy/migrations/upgrade-from-v3 --dry-run
php craft vizy/migrations/upgrade-from-v3 --force

Analyses every Vizy 3 field in the current Project Config and prints the upgrade plan without writing anything. By default each Vizy 3 block type keeps its handle as a shared Block Type. When a handle isn't valid, or you want a different one, pass a JSON file as the optional argument that maps {fieldUid}:{blockTypeId} keys to the Block Type handles to use instead.

php craft vizy/migrations/upgrade-analyze
php craft vizy/migrations/upgrade-analyze path/to/handles.json

Checks a saved upgrade plan, and an optional owner-scope file, without writing anything. Both arguments are paths to JSON files and accept Craft aliases.

php craft vizy/migrations/upgrade-dry-run path/to/plan.json path/to/owners.json

Applies a saved upgrade plan and owner-scope file. It writes Project Config and converts the owner content the scope file lists.

php craft vizy/migrations/upgrade-apply path/to/plan.json path/to/owners.json

Lists upgrade runs with their status, stage, last error and next step. Pass a run UID to show one run.

php craft vizy/migrations/upgrade-status

Resumes an unfinished upgrade run from its last completed stage.

php craft vizy/migrations/upgrade-resume a1b2c3d4-e5f6-7890-abcd-ef1234567890

Analyses converting one owner's Vizy field, and applies it when you pass --apply=1. The arguments are the owner's element type class, element ID and site ID, the Vizy field's UID and the path to the mapping file.

php craft vizy/migrations/owner "craft\elements\Entry" 123 1 a1b2c3d4-e5f6-7890-abcd-ef1234567890 path/to/mapping.json
php craft vizy/migrations/owner "craft\elements\Entry" 123 1 a1b2c3d4-e5f6-7890-abcd-ef1234567890 path/to/mapping.json --apply=1

Lists owner migration checkpoints with their next step. Pass a run UID to show the checkpoints for one run.

php craft vizy/migrations/status

Resumes an owner migration from a checkpoint ID listed by vizy/migrations/status.

php craft vizy/migrations/resume 42