Skip to content
pageflare

Quick Start

This guide gets you from zero to a fully optimized site in two minutes.

Step 1 — Install pageflare

Section titled “Step 1 — Install pageflare”
npm install -g @pageflare/cli

The tab above auto-selects the method that matches your OS. npm works everywhere; Homebrew is the easiest path on macOS; the curl installer covers Linux servers and CI environments.

Confirm the install worked:

Terminal window
pageflare --version

Step 2 — Build your site

Section titled “Step 2 — Build your site”

Run your normal build command first. Pageflare works on the output of your build, not the source:

Terminal window
# Examples — use whichever applies to your project
npm run build        # Astro, Next.js, Vite, etc.
hugo                 # Hugo
jekyll build         # Jekyll

Step 3 — Run pageflare

Section titled “Step 3 — Run pageflare”

Point pageflare at your build output directory. The --output flag controls where the optimized files are written (defaults to <input>/.appz if omitted).

Terminal window
pageflare dist/ --output dist/

Pageflare reads from dist/, applies optimizations, and writes the results back to dist/. When --output matches the input directory the files are updated in place.

pageflare dist/ 
  pageflare  → dist/.appz

Done  145.2 KB saved (38.1%)  1.2s
Files  42 total, 38 optimized, 4 unchanged, 0 errors
Size  381 KB → 235 KB
Features
  ✓ minify_html  ✓ minify_css  ✓ minify_js  ✓ js_defer  ✓ lazy_images  ✓ img_dimensions
  ✓ font_swap  ✗ self_host_fonts  ✗ critical_css  ✗ youtube_facades

The summary lines tell you:

LineMeaning
DoneTotal bytes saved and wall-clock time
FilesCounts of optimized, unchanged, and errored files
SizeBefore and after total payload
FeaturesWhich optimizations ran (✓) and which were skipped or unavailable (✗)

Features marked ✗ are either disabled in your config or require a Pro license. See the feature list for details.

That’s it

Section titled “That’s it”

Your site is optimized. Deploy the contents of your output directory as you normally would.

Next steps

Section titled “Next steps”