mirror of
https://github.com/pxdg-afk/paxad.git
synced 2026-08-23 06:21:08 -04:00
56 lines
3.1 KiB
Markdown
56 lines
3.1 KiB
Markdown
---
|
|
title: CLI Reference
|
|
---
|
|
|
|
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|create]]: Initialize a new Quartz project with a choice of templates (default, obsidian, ttrpg, blog) and base URL configuration.
|
|
- [[build|build]]: Build your Quartz site into static HTML. Includes a development server.
|
|
- [[sync|sync]]: Push and pull changes between your local machine and GitHub.
|
|
- [[upgrade|upgrade]]: Upgrade the Quartz framework to the latest version. Also available as `npx quartz update`.
|
|
- [[restore|restore]]: Recover your content folder from the local cache.
|
|
- [[cli/plugin|plugin]]: Install, add, remove, prune, and configure plugins. Use `plugin install` with flags for lockfile/config sync, updates, and checks.
|
|
- [[tui|tui]]: Use a terminal interface to manage plugins and layout.
|
|
|
|
## Global Flags
|
|
|
|
These flags are accepted by every Quartz command:
|
|
|
|
| Flag | Shorthand | Description | Default |
|
|
| --------------- | --------- | ------------------------------------------------------------------------------------------------------- | -------------- |
|
|
| `--directory` | `-d` | The directory containing your Quartz project | `content` |
|
|
| `--verbose` | `-v` | Enable detailed logging for debugging | `false` |
|
|
| `--concurrency` | `-c` | Max parallel workers for operations that run in parallel (e.g. `build`, `plugin install`, `plugin add`) | CPU core count |
|
|
|
|
Commands that don't perform parallel work accept `-c` as a no-op, so it's always safe to pass. See [[build#Performance Tuning|build]] and [[cli/plugin#Installing on low-end hardware|plugin]] for practical examples.
|
|
|
|
## Help and Versioning
|
|
|
|
To see a full list of available flags for any command, use the `--help` flag.
|
|
|
|
```shell
|
|
npx quartz --help
|
|
npx quartz build --help
|
|
```
|
|
|
|
To check which version of Quartz you are currently running, use the `--version` flag.
|
|
|
|
```shell
|
|
npx quartz --version
|
|
```
|