great-docs freeze

Execute specific pages and persist their freeze cache

great-docs freeze [OPTIONS] [PAGES]...

Renders one or more QMD pages (always executing their code), then copies the resulting _freeze/ entries back to a persistent location so they survive future builds.

PAGES are paths to .qmd files relative to your project root (e.g., docs/user_guide/benchmarks.qmd). Quarto always executes code when rendering individual files, even with freeze enabled (this is how you update frozen outputs).

Use --clean to wipe the entire _freeze/ cache before re-executing. This forces a full refresh of all specified pages from scratch.

Use --info to see the freeze status of all pages without rendering.

After running, the updated _freeze/ entries are ready to commit to version control.

Full --help output

Usage: great-docs freeze [OPTIONS] [PAGES]...

  Execute specific pages and persist their freeze cache

  Renders one or more QMD pages (always executing their code), then copies the
  resulting '_freeze/' entries back to a persistent location so they survive
  future builds.

  PAGES are paths to .qmd files relative to your project root (e.g.,
  'docs/user_guide/benchmarks.qmd'). Quarto always executes code when
  rendering individual files, even with freeze enabled (this is how you update
  frozen outputs).

  Use '--clean' to wipe the entire '_freeze/' cache before re-executing. This
  forces a full refresh of all specified pages from scratch.

  Use '--info' to see the freeze status of all pages without rendering.

  After running, the updated '_freeze/' entries are ready to commit to version
  control.

  Examples:
    great-docs freeze docs/user_guide/benchmarks.qmd
    great-docs freeze docs/user_guide/benchmarks.qmd docs/user_guide/mcmc-demo.qmd
    great-docs freeze docs/user_guide/benchmarks.qmd --freeze-dir cached-results
    great-docs freeze docs/user_guide/benchmarks.qmd --clean
    great-docs freeze --info

Options:
  --project-path DIRECTORY  Path to your project root directory (default:
                            current directory)
  --freeze-dir TEXT         Where to persist execution results (default:
                            '_freeze/' beside the selected configuration)
  --clean                   Delete existing _freeze/ before re-executing
                            (forces full refresh).
  --info                    Show freeze status for all pages (which are
                            frozen, cached, stale).
  --config FILE             Path to the project configuration file
  --help                    Show this message and exit.

Arguments

PAGES: TEXT

Optional.

Options

--project-path: DIRECTORY

Path to your project root directory (default: current directory)

--freeze-dir: TEXT

Where to persist execution results (default: _freeze/ beside the selected configuration)

--clean

Delete existing _freeze/ before re-executing (forces full refresh).

--info

Show freeze status for all pages (which are frozen, cached, stale).

--config: FILE

Path to the project configuration file

Examples

  great-docs freeze docs/user_guide/benchmarks.qmd
  great-docs freeze docs/user_guide/benchmarks.qmd docs/user_guide/mcmc-demo.qmd
  great-docs freeze docs/user_guide/benchmarks.qmd --freeze-dir cached-results
  great-docs freeze docs/user_guide/benchmarks.qmd --clean
  great-docs freeze --info