GitHub/quartz
1
0
Fork 2
mirror of https://github.com/jackyzha0/quartz.git synced 2026-03-21 21:45:42 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
2694c3306d
quartz/docs/cli/upgrade.md
saberzero1 a156d90dc0
feat: update and upgrade commands
2026-02-26 00:42:53 +01:00

1.9 KiB
Raw Blame History

title
quartz upgrade

The upgrade command upgrades the Quartz framework itself to the latest version by pulling changes from the official Quartz repository.

Usage

npx quartz upgrade

How it Works

When you run npx quartz upgrade, Quartz performs the following steps:

  1. Backs up your content — your content folder is cached locally to prevent data loss.
  2. Pulls the latest Quartz code — fetches and merges from the official upstream repository (upstream/v5) using Git.
  3. Shows version changes — displays the version transition (e.g., v5.0.0 → v5.1.0) or confirms you're already up to date.
  4. Updates dependencies — runs npm install to ensure all packages match the new version.
  5. Restores plugins — reinstalls plugins from quartz.lock.json to ensure compatibility.
  6. Checks plugin compatibility — verifies that installed plugins are compatible with the new Quartz version.

Handling Conflicts

Because Quartz allows you to customize almost every part of the code, upgrades can sometimes result in merge conflicts. This happens if you have modified a file that the Quartz team has also updated.

If a conflict occurs:

  1. Git will mark the conflicting sections in the affected files.
  2. You will need to open these files and manually choose which changes to keep.
  3. After resolving the conflicts, you can commit the changes.

Recovery

If an upgrade goes wrong or leaves your project in an unusable state, you can use the cli/restore command to recover your content from the local cache.

Flags

The upgrade command supports the standard cli/index (--directory, --verbose).

See Also