diff --git a/docs/cli/index.md b/docs/cli/index.md index c72076975..1cdf15c93 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -27,7 +27,7 @@ You can run the CLI using `npx quartz`. - [[cli/update|update]]: Update installed plugins to their latest versions. - [[cli/restore|restore]]: Recover your content folder from the local cache. - [[cli/migrate|migrate]]: Convert older configuration files to the new YAML format. -- [[cli/plugin|plugin]]: Install, add, remove, and configure plugins from the command line. +- [[cli/plugin|plugin]]: Install, add, remove, prune, resolve, and configure plugins from the command line. - [[cli/tui|tui]]: Use a terminal interface to manage plugins and layout. ## Help and Versioning diff --git a/docs/cli/plugin.md b/docs/cli/plugin.md index a844efa4d..1a58d8333 100644 --- a/docs/cli/plugin.md +++ b/docs/cli/plugin.md @@ -86,6 +86,34 @@ Check if any of your installed plugins have updates available. npx quartz plugin check ``` +### prune + +Remove installed plugins that are no longer referenced in your `quartz.config.yaml`. This is useful for cleaning up after removing plugin entries from your configuration. + +```shell +npx quartz plugin prune +``` + +Use `--dry-run` to preview which plugins would be removed without making changes: + +```shell +npx quartz plugin prune --dry-run +``` + +### resolve + +Install plugins that are listed in your `quartz.config.yaml` but missing from the lockfile. This is the inverse of `prune` — it ensures your installed plugins match your configuration. + +```shell +npx quartz plugin resolve +``` + +Use `--dry-run` to preview which plugins would be installed without making changes: + +```shell +npx quartz plugin resolve --dry-run +``` + ## Common Workflows ### Adding and Enabling a Plugin @@ -111,6 +139,25 @@ If you want to change a plugin setting without opening the YAML file: npx quartz plugin config explorer --set useSavedState=true ``` +### Cleaning Up Unused Plugins + +If you've removed plugins from your config and want to clean up leftover files: + +```shell +npx quartz plugin prune --dry-run # preview first +npx quartz plugin prune # remove orphaned plugins +``` + +### Setting Up from Config + +When setting up on a new machine or in CI, resolve any plugins referenced in your config that aren't yet installed: + +```shell +npx quartz plugin resolve +``` + +Both `prune` and `resolve` will fall back to `quartz.config.default.yaml` if no `quartz.config.yaml` is present. + ## Interactive Mode Running the plugin command without any subcommand will launch the [[cli/tui|TUI]], which provides a visual interface for all these operations.