MIT·npmframlitv0.9.0

Open-source CLI & MCP
for the Framlit platform

A thin client for rendering videos from your terminal or any MCP-enabled IDE. The client is MIT. Rendering runs on the Framlit platform and uses your account credits — 30 included free with every signup.

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

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

Same tools, accessible from your terminal. Agent-friendly with JSON output, dry-run mode, and schema introspection.

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"
# Full render workflow: generate → save → render → poll
$ npx framlit projects create "My Video" --code ./video.tsx
$ npx framlit render <projectId>
$ npx framlit render status <renderId> --poll
# Batch: personalize a whole catalog from one template
$ npx framlit batch create --rows-file rows.json --template-id flash-sale-burst
$ npx framlit batch start <jobId> --poll
# Agent-friendly: JSON output, schema introspection, dry-run
$ npx framlit schema framlit_generate_code
$ npx framlit generate "test" --dry-run --output json

Available Tools

19 tools for the complete video workflow — generate, manage, render, iterate, and batch-personalize entire catalogs.

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_preview_code

Get a shareable preview URL for any code

💳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

📦0.2/video

framlit_batch_create

Personalize a video template across N rows of data

▶️Free

framlit_batch_start

Kick off rendering for a created batch job

📈Free

framlit_batch_status

Check batch progress + collect download URLs

🗂️Free

framlit_batch_list

List all your batch jobs and their status

🛑Free

framlit_batch_cancel

Cancel a pending batch — unprocessed videos refunded

🎭1/variation

framlit_generate_variations

Create style variations of a video for A/B testing

📋Free

framlit_list_variations

List the style variations generated for a project

Free

framlit_apply_variation

Promote a variation as the active project code

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

Just describe what you want. The AI handles the rest.

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

Same Credits, Same Plans

MCP and CLI use your existing Framlit credits. No separate billing.

30
Free credits/mo
500
Pro credits/mo
1
Credit per generation

Ready to Start?

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

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