Upgrading Quartz

Note

Upgrade Quartz to newer minor/patch versions. For Quartz 3/4 upgrades, see the migration guide.

Upgrading Core

npx quartz upgrade

mechanics:

• mechanism: Pulls updates from the official Quartz GitHub repository via Git.
• lockfile: Auto-resolves quartz.lock.json conflicts by backing up before pull, then restoring after.
• manual_pull: git pull origin upstream

Hint

Quartz caches content before upgrade. On mid-merge conflict, abort the merge, then run npx quartz restore.

conflicts:

• resolve_manually_with: - VSCode - GitHub Desktop - GitHub merge conflict guide flags:
• reference: CLI upgrade reference

Upgrading Plugins

npx quartz plugin install --latest

plugins:

• action: Updates installed plugins.

Cleaning Up Unused Plugins

npx quartz plugin prune --dry-run  # Preview removals
npx quartz plugin prune            # Remove orphaned plugins

cleanup:

• action: Removes leftover files from disabled plugins.
• reference: plugin prune reference