The Quartz CLI is the primary way to interact with your Quartz project. It provides commands for creating new projects, building static sites, syncing with GitHub, and managing plugins.
You can run the CLI using npx quartz.
Quick Reference
| Command | Description | Example |
|---|---|---|
create | Initialize a new Quartz project with template selection | npx quartz create |
build | Generate static HTML files | npx quartz build |
sync | Sync content with GitHub | npx quartz sync |
upgrade | Upgrade Quartz to the latest version (alias: update) | npx quartz upgrade |
plugin | Manage Quartz plugins (install, add, remove, etc.) | npx quartz plugin list |
tui | Launch the interactive plugin manager | npx quartz tui |
Commands
- create: Initialize a new Quartz project with a choice of templates (default, obsidian, ttrpg, blog) and base URL configuration.
- build: Build your Quartz site into static HTML. Includes a development server.
- sync: Push and pull changes between your local machine and GitHub.
- upgrade: Upgrade the Quartz framework to the latest version. Also available as
npx quartz update. - restore: Recover your content folder from the local cache.
- plugin: Install, add, remove, prune, and configure plugins. Use
plugin installwith flags for lockfile/config sync, updates, and checks. - tui: Use a terminal interface to manage plugins and layout.
Help and Versioning
To see a full list of available flags for any command, use the --help flag.
npx quartz --help
npx quartz build --helpTo check which version of Quartz you are currently running, use the --version flag.
npx quartz --version