Skip to content

Dev Preview

The pellicule dev command starts a live preview server that lets you see your video composition in the browser as you work. Changes are hot-reloaded instantly — no need to render a full video just to check an animation.

Usage

bash
npx pellicule dev

This starts a dev server and opens your browser with an interactive preview of Video.vue.

Preview a Specific Component

bash
npx pellicule dev MyVideo

Override Resolution

bash
npx pellicule dev MyVideo -w 1280 -h 720

All standard CLI options work with pellicule dev — resolution, fps, duration, bundler, server-url, etc.

Preview Controls

The preview overlay appears at the bottom of the browser window with playback controls:

ControlAction
Play / Pause buttonStart or stop auto-playback
Previous frame buttonStep back one frame
Next frame buttonStep forward one frame
Timeline scrubberSeek to any frame
Frame counterShows current frame and time

Keyboard Shortcuts

KeyAction
SpacePlay / Pause
Previous frame
Next frame
HomeJump to first frame
EndJump to last frame

How It Works

pellicule dev reuses the same rendering pipeline as pellicule but skips the Playwright + FFmpeg step. Under the hood:

  1. Starts a Vite (or Rsbuild) dev server — same as during a render
  2. Opens your browser instead of launching headless Chromium
  3. Injects the preview overlay controls into the page
  4. Uses the same window.__PELLICULE_SET_FRAME__() mechanism as the renderer

This means what you see in preview is exactly what you'll get in the final render.

Hot Module Replacement

Since the preview runs on Vite's dev server, file changes are hot-reloaded automatically. Edit your .vue file, save, and the preview updates instantly without losing your current frame position.

Framework Support

pellicule dev works with all supported frameworks:

FrameworkHow It Works
StandaloneStarts a built-in Vite dev server
ViteStarts Vite with your existing config merged in
RsbuildStarts Rsbuild with your existing config merged in
The Boring StackStarts Rsbuild with Shipwright config
LaravelStarts Vite with your Laravel config merged in
NuxtConnects to your running Nuxt dev server (BYOS mode)
QuasarConnects to your running Quasar dev server (BYOS mode)

BYOS Projects (Nuxt, Quasar)

For Nuxt and Quasar projects, start your framework's dev server first, then run pellicule dev:

bash
# Terminal 1: Start your dev server
npm run dev

# Terminal 2: Start the preview
npx pellicule dev InvoiceDemo

Pellicule auto-detects the framework and connects to the running server.

Adding a Dev Script

Add a dev script to your package.json for convenience:

json
{
  "scripts": {
    "dev": "pellicule dev",
    "render": "pellicule -o output.mp4"
  }
}

Then simply:

bash
npm run dev

Workflow

The recommended workflow with pellicule dev is:

  1. Start the previewnpx pellicule dev
  2. Edit your component — modify animations, styles, timing
  3. Save — HMR instantly refreshes the preview
  4. Scrub and play — use the controls to check different parts of the video
  5. Render — when you're happy, run npx pellicule to produce the final MP4

All open source projects are released under the MIT License.