remotion-create

These are instructions for making a new Remotion project and composition. If this is not the next task, see Remotion Best Practices

Scaffold a project

If a project already exists, skip this. Ensure Node.js and Git is installed, and the current folder is appropriate for starting a new project.

Scaffold one using:

npx create-video@latest --yes --blank --no-tailwind my-video
cd my-video
npm i

Replace my-video with a suitable project name.

Designing a video

Keep the scaffold and add React Markup. Follow Remotion React Markup Best Practices and Video Layout Rules for video-first layout and text sizing guidance.

Is this a multi-scene video?

If this is a video with multiple subsequence videos, follow guidance at Multi-scene videos.

Interactivity Best Practices

By structuring the React Markup following Remotion Interactivity Best Practices, you allow the user to make edits in the Studio which write back to code.

TailwindCSS

If Tailwind is requested, see tailwind.md for using TailwindCSS in Remotion.

Open the preview

After creating or updating the video, start the preview server by default:

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. Open the exact URL in the Codex in-app browser. If no browser tool is available yet, use tool_search for the in-app browser control tool, then navigate to the local URL. You can visit a specific composition by navigating to /[composition-id], for example http://localhost:3000/MapAnimation.

Render the video

Only render if the user explicitly asks for it.

npx remotion render

For more options, see Rendering.

Follow-up

The video creation process has finished. For follow-up prompts, use Remotion Best Practices