Upload Element Previews

Upload a Remotion Element's preview assets to remotion.media and replace local preview URLs. Use when given an Element slug, or when exactly one Element's preview assets are present in the current worktree.

Remotion 11852fb 1.2 KB Updated 3.9k repo stars

File contents

Upload Element Previews

  1. Identify the Element slug. Ask if it is ambiguous.
  2. Choose the source:
    • Use render for fresh files in .element-previews.
    • Use submission for committed files in static/elements.
  3. Upload the previews:
cd packages/docs
bun run upload-element-preview \
  --element=<category>/<slug> \
  --source=<render|submission>

To refresh an already-published preview, add --overwrite. The uploader accepts it only when the Element definition already uses the exact expected https://remotion.media/elements/... PNG and MP4 URLs.

  1. For a new preview, replace image, posterUrl, and videoUrl with the printed remotion.media URLs. An overwritten preview keeps its existing URLs.
  2. If using submission, delete the local review assets. If using render, leave .element-previews uncommitted.
  3. Commit and push when the work belongs on a branch.

remotion-dev/remotion/tree/main/.agents/skills/upload-element-previews commit 11852fbb20

Frequently asked questions

npx skillmds add remotion-dev/upload-element-previews