MIT·npmframlitv0.12.1

Open-source CLI & MCP
for the Framlit platform

Generate, edit and render Framlit videos from your terminal or any MCP-enabled IDE. The client is MIT; generation and rendering run on Framlit and use your account credits.

Same pattern as Stripe CLI or Vercel CLI: open-source tool, hosted backend.

Get API keyView on npm

Quick start

1

Get your API key

Create an API key from your Framlit profile. You'll use this to authenticate requests.

Go to profile
2

Choose your interface

Add MCP to your editor, or use the CLI from your terminal.

.cursor/mcp.json
{
  "mcpServers": {
    "framlit": {
      "command": "npx",
      "args": ["-y", "framlit", "mcp"],
      "env": {
        "FRAMLIT_API_KEY": "your_api_key_here"
      }
    }
  }
}

Replace your_api_key_here with your actual API key. Keep this file private.

CLI for terminal workflows

The same tools from your terminal, with JSON output, a dry-run mode, and schema introspection for agents.

Terminal
# Set your API key (get it at framlit.app/profile)
$ export FRAMLIT_API_KEY=fml_your_api_key_here
# Generate video code
$ npx framlit generate "Logo animation with rotating 3D text"
# Or let your agent design it: scene JSON → editable project (free)
$ npx framlit scene create --file scene.json
# Render a project and poll until the MP4 is ready
$ npx framlit render <projectId>
$ npx framlit render status <renderId> --poll
# Agent-friendly: JSON output, schema introspection, dry-run
$ npx framlit schema framlit_generate_code
$ npx framlit generate "test" --dry-run --output json

Bring your agent

Claude Code, Cursor, or your own script can design a video as a Framlit Scene: plain JSON with a canvas, layers, timing, and motion. Framlit turns it into an editable project, a person polishes it in the editor, and the agent reads their edits back.

1

Agent writes a scene

Positions, text, media, entrance presets, and motion paths as JSON. No Remotion code.

2

People refine it

Drag layers, retime them on the timeline, and record motion in the Framlit editor.

3

Agent reads it back

framlit_get_scene returns the edited scene, ready for the next change or a render.

scene.json
{
  "version": 1,
  "canvas": {
    "width": 1080,
    "height": 1920,
    "fps": 30,
    "durationInFrames": 150
  },
  "background": {
    "gradient": {
      "from": "#0f172a",
      "to": "#1e293b",
      "angle": 160
    }
  },
  "layers": [
    {
      "id": "headline",
      "type": "text",
      "text": "Ship faster",
      "x": 80,
      "y": 300,
      "width": 920,
      "height": 260,
      "style": {
        "fontFamily": "Poppins",
        "fontSize": 120,
        "fontWeight": 800,
        "color": "#ffffff",
        "textAlign": "center"
      },
      "enter": {
        "preset": "rise"
      }
    },
    {
      "id": "cta",
      "type": "text",
      "text": "Order now",
      "x": 240,
      "y": 1560,
      "width": 600,
      "height": 140,
      "frameRange": [
        60,
        149
      ],
      "style": {
        "background": "#22c55e",
        "borderRadius": 70,
        "fontSize": 56,
        "textAlign": "center",
        "color": "#052e16"
      },
      "enter": {
        "preset": "slideLeft"
      }
    }
  ]
}

Full schema: framlit.app/schemas/framlit-scene.v1.json

Available tools

18 tools for the whole video workflow: generate, manage, render and iterate from the CLI or your agent.

✨1 credit

framlit_generate_code

Generate Remotion video code from text description

✏️1 credit

framlit_modify_code

Modify existing code with natural language

🧩Free

framlit_create_scene

Turn a Framlit Scene (JSON your agent writes) into an editable project

🔁Free

framlit_get_scene

Read a project back as a scene, including edits made in the editor

👁️Free

framlit_preview_code

Get a shareable preview URL for code Framlit generated

💳Free

framlit_get_credits

Check your credit balance and plan

📁Free

framlit_list_projects

List and manage your saved projects

📄Free

framlit_get_project

Get project details including code

➕Free

framlit_create_project

Create a new project to save your video

🔄Free

framlit_update_project

Update an existing project

🎬Free

framlit_render_video

Render a project to MP4 via AWS Lambda

📊Free

framlit_get_render_status

Check render progress and get download URL

🎨Free

framlit_list_templates

Browse available video templates

🎙️3 credits

framlit_generate_narrated_ad

Script, voiceover and word-synced visuals in one run (Editor Pro and Studio)

🧮Free

framlit_get_narration_cap

Check this month's narrated-ad usage and remaining cap

🔍Free

framlit_get_narrated_ad_stages

Inspect the script, audio, storyboard and code of a narrated ad

🏷️Free

framlit_get_brand

Get the brand profile used for brand-aware generation

🖌️Free

framlit_set_brand

Save your brand colors, fonts, tone and logo

Full render workflow

Generate, save, render, and download, all from your IDE or terminal.

1

Generate

framlit_generate_code

Describe your video in natural language

2

Save

framlit_create_project

Save to a project for rendering

3

Render

framlit_render_video

Export to MP4 via AWS Lambda

4

Download

framlit_get_render_status

Poll progress and get download URL

Example usage

Describe the video in plain language and Framlit writes the Remotion code.

U

Create a "Hello World" text with fade-in animation, modern dark background

F

Generated Remotion code (1 credit used, 29 remaining):

export const
MyVideo
= () => ...
🎬Preview:https://framlit.app/preview/abc123

Open the link to see the video preview

API billing follows the app account

MCP and CLI calls use the same Framlit account credits as the web app. Motion Editor access is handled through direct-web plans.

Legacy
Credits for API calls
1
Credit per basic generation
Open the editor

Ready to start?

Get an API key and start generating videos from your editor or terminal in minutes.

Create API keyView source

Works with Claude Desktop, Cursor, VS Code, Windsurf, and any MCP-compatible client. CLI works everywhere Node.js runs.