mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-21 21:45:42 -05:00
49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
---
|
|
title: quartz upgrade
|
|
---
|
|
|
|
The `upgrade` command upgrades the Quartz framework itself to the latest version by pulling changes from the official Quartz repository.
|
|
|
|
## Usage
|
|
|
|
```shell
|
|
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.
|
|
|
|
Quartz automatically handles merge conflicts in `quartz.lock.json` by backing up your lockfile before pulling and restoring it afterward. This prevents the most common source of conflicts during upgrades.
|
|
|
|
For other files, 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|restore]] command to recover your content from the local cache.
|
|
|
|
## Flags
|
|
|
|
The `upgrade` command supports the standard [[cli/index|common flags]] (`--directory`, `--verbose`).
|
|
|
|
## See Also
|
|
|
|
- [[cli/update|quartz update]] — update installed plugins
|
|
- [[getting-started/upgrading|Upgrading Quartz]] — detailed upgrading guide
|
|
- [[cli/restore|quartz restore]] — recover content from cache
|