pro-visu docs

Introduction

pro-visu turns a website into marketing assets — scroll reels, screenshots, media walls, and specimens — from a single config.

For AI / LLMs: View Markdown

pro-visu — a portable CLI that turns the sites you build into marketing/showcase assets: scroll reels, responsive screenshots, looping media walls, font/colour specimens — all from one pro-visu/pro-visu.config.ts.

Install into a repo, point assets at a URL, run pro-visu generate. Everything lives in a pro-visu/ folder: the config, and gitignored output in pro-visu/output/ (+ a manifest.json).

The mental model

Three pieces:

  1. Configpro-visu/pro-visu.config.ts: settings (repo-level CLI behaviour) + assets (what to generate).
  2. Generators — each asset names a generator. Options merge settings.defaults["<generator>"] under the asset's own options.
  3. Manifest — every run writes <outDir>/manifest.json (id, generator, file, dimensions, bytes, durationMs). pro-visu list prints it.

Assets can depend on each other → a small DAG (e.g. a wall of tiles produced by other assets). Deps are derived from the options, never hand-authored.

Generators at a glance

GeneratorOutputWhat it's for
scroll-reelmp4 (+ gif/webp/poster)Deterministic frame-stepped recordings — scroll reels, choreographed section pans, social formats
interactionmp4Scripted realtime demos with a synthetic cursor, or clips cropped to one component
screenshotspng / jpegResponsive full-page and element captures per breakpoint
wallmp4A seamless-looping media wall of your assets (and local files), each column scrolling on its own
specimenmp4A looping type specimen from a font file
palettepngA still colour-palette image
palette-reelmp4A looping colour-palette reveal video

New asset types slot in via a plugin contract — no core changes.

Quick start

Dev-dependency (recommended — typed config, version pinned for reproducible builds):

pnpm add -D pro-visu
npx pro-visu init       # scaffold config, gitignore output, ensure a browser
npx pro-visu generate   # capture the assets

No install (npx/global, JSON config):

npx pro-visu init --json
npx pro-visu generate

On this page