Skip to content

Open, GIF and MP4

SHEET
D5
REV
flowfig 0.8.4
SOURCE
README.md
DATE
2026-10-06

flowfig open shows a figure in your default browser. On macOS, an .svg file often opens in a text editor or in Xcode. Thus open writes an HTML page that holds the SVG, and opens that page.

npx flowfig open docs/checkout.svg
npx flowfig open docs/checkout.svg --html checkout.html # also write the page to checkout.html
npx flowfig docs/checkout.json docs/checkout.svg --open # render, then open

flowfig gif writes an animated GIF of the whole loop. A GIF plays in Slack, Notion, X and slide decks, where an SVG animation does not play.

npx flowfig gif docs/checkout.svg # writes docs/checkout.gif
npx flowfig gif docs/checkout.svg --step 2 # only step 2: writes docs/checkout-step2.gif
npx flowfig gif docs/checkout.svg --dark --mp4 # the dark theme, and also docs/checkout.mp4

gif needs Chrome, Edge, Chromium or Brave in the standard install path. Set CHROME_PATH to use another browser program. --fps sets the frames per second (1 to 50, default 20). --scale sets the pixel scale (default 2). --mp4 needs ffmpeg on the PATH. If a GIF is over 10 MB, gif prints a warning. Use --step, a lower --fps or a lower --scale to make the file smaller.