pro-visu docs

Introduction

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

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

Install it into a website repo, point assets at a URL, and run pro-visu generate. Output is written into a gitignored pro-visu/ folder alongside a manifest.json.

The mental model

Three pieces:

  1. Config — a pro-visu.config.ts with two blocks: settings (repo-level CLI behaviour) and assets (the list of things to generate).
  2. Generators — each asset names a generator that knows how to produce one kind of output. Options are merged from settings.defaults["<generator>"] and the asset's own options.
  3. Manifest — every run writes <outDir>/manifest.json recording what was produced (id, generator, file, dimensions, bytes, duration). pro-visu list prints it.

Assets can also depend on each other through inputs, forming a small DAG — for example, a wall whose tiles are images, screenshots, and clips produced by other assets (the wall derives those dependencies from the asset names in its columns).

Generators at a glance

GeneratorOutputWhat it's for
scroll-reelmp4 (+ gif/webp/poster)Deterministic frame-stepped recordings — scroll reels, choreographed tours, scripted interactions, social formats
screenshotspng / jpegResponsive full-page and element captures per breakpoint
wallmp4A seamless-looping media wall of your assets, each column scrolling on its own
image(passthrough)Register an existing image file as an asset (e.g. a wall tile)
specimenmp4A looping type specimen from a font file
palettepngA still colour-palette image
palette-reelmp4A looping colour-palette reveal video

The pipeline is a plugin contract, so new asset types slot in without core changes.

Quick start

As a project dev-dependency (recommended — typed config + a version pinned for reproducible builds):

pnpm add -D pro-visu   # adds it to your repo
npx pro-visu init           # scaffold config, gitignore the output dir, ensure a browser
npx pro-visu generate       # capture the assets in your config

Or with no install at all, via npx or a global install, using a JSON config:

npx pro-visu init --json   # scaffold pro-visu.config.json + a JSON Schema
npx pro-visu generate

Continue with Getting started for the full comparison of both modes (and using an unreleased build), or jump to Configuration.

Captures run in a managed Chromium (downloaded once on first use) and encode with a bundled ffmpeg — no global installs required.

On this page