SuperImg

Programmatic video generation. TypeScript in, MP4 out.

Quick Start

npm install superimg

Note: Rendering requires Chromium. Run npx superimg setup once to download it.

Create a template:

// hello.video.ts
import { defineScene } from 'superimg'

export default defineScene({
  config: { width: 1920, height: 1080, fps: 30, duration: 3 },
  render(ctx) {
    return `
      <div style="
        width: ${ctx.width}px; height: ${ctx.height}px;
        background: linear-gradient(135deg, #667eea, #764ba2);
        display: flex; align-items: center; justify-content: center;
      ">
        <h1 style="font-size: 80px; color: white;">Hello, SuperImg</h1>
      </div>
    `
  },
})

Render it:

npx superimg render hello.video.ts -o hello.mp4

That's it. A function that returns HTML → an MP4 file.

What You Can Build

200 product videos for an e-commerce catalog. Personalized onboarding walkthroughs. Automated social clips from a data feed. Anything where video needs to scale beyond one-at-a-time.

• Deterministic — Same input, same output. Every frame is testable.
• Composable — Import functions, reuse components, version control everything.
• Scalable — One template, any amount of data. Render 1 or 10,000.

Add Animation

Every frame receives a context with a standard library for animation. std.score() breaks the scene into enter/hold/exit phases and t.motion() gives each element a fade-in, transform, and fade-out automatically:

import { defineScene } from 'superimg'

export default defineScene({
  config: { width: 1920, height: 1080, fps: 30, duration: 5 },
  render(ctx) {
    const { std, width, height } = ctx

    // Phases default to enter 15% / hold 70% / exit 15%
    const t = std.score()

    // scale 0.8 → 1 on enter, hold, then auto fade + scale back on exit
    const card = t.motion({ scale: 0.8, easing: 'easeOutCubic' })

    return `
      <div style="
        width: ${width}px; height: ${height}px;
        background: linear-gradient(135deg, #667eea, #764ba2);
        display: flex; align-items: center; justify-content: center;
      ">
        <h1 style="font-size: 80px; color: white; ${card.style}">Hello, SuperImg</h1>
      </div>
    `
  },
})

std.score handles phase timing. For custom-progress math (loops, non-phase curves) reach for std.interpolate(progress, inputRange, outputRange, easing?). See the full API →

Data-Driven Templates

Pass data at render time. Same template, different content:

export default defineScene({
  data: {
    productName: 'Widget',
    price: '$99',
  },
  render(ctx) {
    const { data } = ctx
    return `<div>${data.productName} — ${data.price}</div>`
  },
})

# Single video with inline data
npx superimg render template.video.ts --data '{"productName": "Gadget", "price": "$149"}'

# Batch render from a JSON file — one video per entry. Filenames pick a slug
# from each entry's `slug` / `name` / `title` / `id` field (else array index).
npx superimg render template.video.ts --data products.json -y

# Composes with --presets: 10 entries × 2 presets = 20 MP4s in one Playwright session.
npx superimg render template.video.ts --data products.json --presets -y

Multi-Format Output

One template, every platform:

await render(template, { format: 'youtube.video' })        // 1920×1080
await render(template, { format: 'youtube.video.short' })  // 1080×1920
await render(template, { format: 'instagram.post' })       // 1080×1080
await render(template, { format: 'tiktok.video' })         // 1080×1920

Where It Runs

CLI — Render locally or in CI. This is the primary workflow:

npx superimg render hello.video.ts -o video.mp4

# Render every video in the project. Multi-output templates (those declaring
# config.outputs) automatically render all presets; single-output templates
# render once at their default config.
npx superimg render --all -y

Browser — Live preview at 60fps while you edit. Run npx superimg dev hello to start the dev server.

React — Embed videos anywhere with the <Player /> component:

import { Player } from 'superimg/react'
import template from './template'

<Player template={template} width={1280} height={720} />

Packages

Package	Description
superimg	Core library, CLI, browser player, and React APIs

npm install superimg           # Core + CLI

With AI Coding Agents

SuperImg ships a skill that teaches your AI coding agent the framework. One command installs it across hosts (Claude Code, Cursor, Codex, Gemini, OpenCode, Pi, Aider, Continue, Windsurf, Copilot):

npx superimg skill install

Codex users can also install the official plugin (skill + MCP tools, versioned, no AGENTS.md edits):

codex marketplace add github.com/anaptfox/superimg
codex plugin install superimg@anaptfox

Documentation

• API Reference — RenderContext, std.score, std.interpolate, and the full standard library
• Project Configuration — Cascading config and video discovery
• Templates & Data — Creating templates with data
• Examples — Working templates to copy from

License

MIT