remotion-best-practices

Files (139)

• SKILL.md
• openai.yaml · agents/
• remotion-icon.svg · assets/
• REFERENCE.md · remotion-captions/
• openai.yaml · remotion-captions/agents/
• remotion-icon.svg · remotion-captions/assets/
• display-captions.md · remotion-captions/
• import-srt-captions.md · remotion-captions/
• transcribe-captions.md · remotion-captions/
• REFERENCE.md · remotion-create/
• openai.yaml · remotion-create/agents/
• remotion-icon.svg · remotion-create/assets/
• tailwind.md · remotion-create/
• video-layout.md · remotion-create/
• REFERENCE.md · remotion-docs/
• openai.yaml · remotion-docs/agents/
• remotion-icon.svg · remotion-docs/assets/
• REFERENCE.md · remotion-interactivity/
• openai.yaml · remotion-interactivity/agents/
• remotion-icon.svg · remotion-interactivity/assets/
• REFERENCE.md · remotion-maps/
• openai.yaml · remotion-maps/agents/
• remotion-icon.svg · remotion-maps/assets/
• TECHNIQUE.md · remotion-maps/techniques/cesium/
• CesiumFlythrough.tsx · remotion-maps/techniques/cesium/assets/
• cesium-path.json · remotion-maps/techniques/cesium/assets/
• city-path.json · remotion-maps/techniques/cesium/assets/
• example-Root.tsx · remotion-maps/techniques/cesium/assets/
• flight-path.ts · remotion-maps/techniques/cesium/assets/
• sample-river.geojson · remotion-maps/techniques/cesium/assets/
• 3d-data-sources.md · remotion-maps/techniques/cesium/references/
• 3d-flyover-architecture.md · remotion-maps/techniques/cesium/references/
• 3d-troubleshooting.md · remotion-maps/techniques/cesium/references/
• prep-cesium-path.mjs · remotion-maps/techniques/cesium/scripts/
• TECHNIQUE.md · remotion-maps/techniques/mapbox/
• render-stability.md · remotion-maps/techniques/mapbox/references/
• TECHNIQUE.md · remotion-maps/techniques/maplibre/
• render-stability.md · remotion-maps/techniques/maplibre/references/
• TECHNIQUE.md · remotion-maps/techniques/maptiler/
• CountryLabel.tsx · remotion-maps/techniques/maptiler/assets/
• MapTilerVectorElement.ts · remotion-maps/techniques/maptiler/assets/
• RiverReveal.tsx · remotion-maps/techniques/maptiler/assets/
• example-Root.tsx · remotion-maps/techniques/maptiler/assets/
• country-meta.json · remotion-maps/techniques/maptiler/assets/sample-data/
• yarlung-flow.json · remotion-maps/techniques/maptiler/assets/sample-data/
• tokens.ts · remotion-maps/techniques/maptiler/assets/
• map-data-sources.md · remotion-maps/techniques/maptiler/references/
• map-explainer-architecture.md · remotion-maps/techniques/maptiler/references/
• map-geo-prep.md · remotion-maps/techniques/maptiler/references/
• render-stability.md · remotion-maps/techniques/maptiler/references/
• prep-geo.mjs · remotion-maps/techniques/maptiler/scripts/
• TECHNIQUE.md · remotion-maps/techniques/static-map/
• 3d.md · remotion-markup/
• REFERENCE.md · remotion-markup/
• openai.yaml · remotion-markup/agents/
• remotion-icon.svg · remotion-markup/assets/
• audio-visualization.md · remotion-markup/
• audio.md · remotion-markup/
• calculate-metadata.md · remotion-markup/
• compositions.md · remotion-markup/
• …and 79 more

SKILL.md (first lines)

## DSH package context

This skill is bundled with dsh-remotion. DSH plugin management owns updates to these skill files; do not run standalone `skills add`, `skills update`, or `remotion skills` commands to replace this bundle. Project dependencies and lockfiles are separate: preserve existing projects, and only upgrade their Remotion dependencies when the user requests it, then verify the project. Run commands in the user project, never in this installed plugin directory. The official instructions below apply within these package boundaries.


## Preserve user changes

Users may make edits in the code outside of the conversation.

If you detect a surprising change made in the meanwhile, don't overwrite it, assume it was intentional or ask for confirmation.

## Creating a video

If the user asks to make, create, or build a new video or composition, load [Create a new Remotion video](./remotion-create/REFERENCE.md), whether or not a Remotion project already exists.

## New project setup

If no Remotion project currently exists, load [Create a new Remotion project](./remotion-create/REFERENCE.md)

## React Markup Best Practices

If you are writing Remotion React Markup, load [Remotion Markup Best Practices](./remotion-markup/REFERENCE.md)

## Maps

For static maps, animated routes and markers, geographic explainers, Mapbox, MapLibre, MapTiler, GeoJSON, or 3D geographic flyovers, load [Remotion Maps](./remotion-maps/REFERENCE.md).

## Multimedia

For achieving multimedia tasks in the browser, such as trimming, cropping videos, or getting metadata from them, load [Remotion Multimedia](./remotion-multimedia/REFERENCE.md)

## Improving Interactivity

By structuring the Remotion markup well, we can allow users to interactively change things in the Studio and write back to code. If relevant: [Interactivity Best Practices](./remotion-interactivity/REFERENCE.md)

## Open the preview

If the user asks to "make" a video, "create" a video, etc.
Don't render the video by default unless they are very explicit. They want to instead see an interactive preview.
As soon as the project can run, start Studio and open the preview in the browser before building or editing the composition. Keep it open while you work so the user can watch progress and steer.

### If you are using Cursor

Run Studio without `--no-open` so it opens the browser automatically:

```bash
npx remotion studio
```

### If you are using another agent client with an in-app browser

You can use the command above to let Studio open the browser, or run:

```bash
npx remotion studio --no-open
```

This will start a long-running process and print the server URL for the preview.  
If the server is already started, it will print the URL.
If you use `--no-open`, open the exact printed URL in the in-app browser and verify that Studio loads. Once a composition exists, verify that its video preview loads. If you cannot open it there, run Studio without `--no-open`.
You can visit a specific composition by navigating to `/[composition-id]`, for example `http://localhost:3000/MapAnimation`.

:::note
The Studio supports WebMCP tools.
:::

### If you do not have an in-app browser

This will open the Studio in the browser or refocus it if it is already open.

```bash
npx remotion studio
```

### More options

To launch a project in Remotion Studio, open its exact local URL, or configure Studio CLI flags, load [Remotion Studio](./remotion-studio/REFERENCE.md).

## Render the video

Only render if the user is very explicit in asking for it.  
E.g. "Render the video", "Export", "Give me the MP4".

The preview also has a more intuitive rendering interface, so consider using it instead of the command line for rendering.

```
npx remotion render
```

For more options, see [Rendering](./remotion-render/REFERENCE.md).

For advanced rendering beyond simple `npx remotion render`, see: [Rendering Best Practices](./remotion-render/REFERENCE.md)

## Captions

When working with Captions, load [Remotion Captions](./remotion-captions/REFERENCE.md).

## Creating a SaaS, automation or application

Use the [Remotion SaaS skill](./remotion-saas/REFERENCE.md) for knowledge about Remotion-powered SaaS apps, such as `<Player>`, rendering on Lambda, Vercel, Cloudflare, via Express.js, client-side rendering, or for finding the right SaaS template.

## Looking up Remotion APIs and documentation

To find and read current Remotion documentation, load [Remotion Docs](./remotion-docs/REFERENCE.md).

## Upgrading

To upgrade Remotion, related packages, compatible Mediabunny packages, and installed Remotion Agent Skills, load [Remotion Upgrade](./remotion-upgrade/REFERENCE.md).

From STARDUSTLC666/dsh-remotion, MIT.

More from STARDUSTLC666/dsh-remotion