Advertising sustains the DA. Ads are hidden for members. Join today

Usage

Last updated on
9 May 2026

This documentation needs review. See "Help improve this page" in the sidebar.

Backstop

Generate a BackstopJS json formatted link file.

Used along with the --dry-mode option for the tidy command, this helps you compare you're site before and after (note: this is intended to help catch any visual changes; since that's what BackstopJS is for).  More detail can be found in the testing.md file in the repo.

drush link_magician:backstop {batchid} > backstoplinks.json

Tidy

Run the Tidy process. Note If this is the first run of Tidy on a site, you are encouraged to run with --dry-run=TRUE.

drush link_magician {source}

source is one of:

  • all
  • block
  • nodeid
  • path
  • section
  • taxonomy

Options

--batch-size

The number of entries to process per batch.  Defaults to 100.

--limit

The maximum number of entries to process. By default, all entries are processed.

--offset

When specified, this is the number of entries to offset processing by (or to put it another way, the number of entries to "skip" at the start).

--nodeid

When specified (and the 'source' is 'nodeid', process just the nodeid provided.

--section

When specified (and the 'source' is 'path'), process node entries that have an alias that starts with the path provided.

--taxonomy

When specified (and the 'source' is 'taxonomy'), use the field and id specified to limit processing to nodes that match.

--dry-run

This runs tag/link update process without saving the changes while logging what it would have updated.

NOTE if you have the Create Media option enabled, it creates new media (if you need to perform a dry-run for what media would be created, you will need to disable the media creation option and make sure the 'Track "skipped" messages' option is enabled. The tracking logs will include messaging that the option is disabled when a match is found)

--tag-list

Specify the list of tags to include in processing.  By default this is set to 'a,img'.

--cookies

Set cookie values (used with along with redirect checking logic).

Purge

Truncates the Link Magician tables.

drush link_magician:purge

Help improve this page

Page status: Needs review

You can: