Skip to content

README.en.md

Latest commit

 

History

History
104 lines (75 loc) · 3.59 KB

README.en.md

File metadata and controls

104 lines (75 loc) · 3.59 KB

framelift

framelift turns a Framer site into a standalone public site: clean, without the badge, on your own domain, and controllable by an AI agent.

French: README.md

TL;DR

Cloudflare Pages (free) can replace paid Framer Basic hosting: your site stays clean, without the badge, on your own domain.

  • Ship Framer cleanly on any domain.
  • Let an AI agent control Framer end to end.
  • Automate exports, checks, and edits without opening the editor.

AI Agent Prompt

Copy-paste this prompt into your agent so it clones the repo and guides the setup step by step:

If the repository is already present in the workspace, use it. Otherwise, clone https://github.com/Azilone/personalize.design.git.
Then inspect the project and guide me through the initial setup step by step.

Goals:
- identify the real prerequisites;
- install dependencies;
- configure environment variables;
- install browser dependencies if needed;
- run the useful checks;
- tell me the next steps if something is missing.
- suggest Cloudflare Pages as the free hosting option when I want to put the site online.

Keep it short, concrete, and practical.
If something is missing, ask one useful question or give the next command to run.

Example AI requests

With this CLI, you can ask an agent to:

  • "Review this landing page and tell me what to fix first."
  • "Export the whole site into dist/, then tell me how to deploy it on Vercel or Cloudflare Pages (free plans) with my own domain, without the Framer badge."
  • "Check whether the Framer API is responding with my credentials."
  • "Update this CMS collection with the new data."
  • "Change this specific node and summarize what changed."
  • "Prepare the repo for release: tests, packaging, and README."

Main commands

framer export page <url> [output]
framer export site <url> [outputDir]
framer pages <url>
framer api <...>

Examples:

framer export page https://example.framer.website/ dist/index.html
framer export site https://example.framer.website/ dist
framer pages https://example.framer.website/ --json
framer api auth test --project "https://framer.com/projects/Website--aabbccdd1122"

framer export site https://example.framer.website/ dist exports the whole site into dist/, with routes like index.html or about/index.html. You can then deploy that folder on Vercel or Cloudflare Pages (free plans), connect your own domain, and end up with a site that works without the Framer badge and without relying on a Framer hosting subscription.

By default, dist/ is ignored by Git. If you want to version that export for CI/CD with Vercel or Cloudflare Pages, simply remove that line from .gitignore in your fork.

Requirements

  • Node.js 22+
  • npm
  • Chromium via Playwright for export and pages
  • FRAMER_API_KEY and FRAMER_PROJECT for api

Install

npm install
cp .env.example .env
npx playwright install chromium
npm run cli -- --help

Configuration

FRAMER_API_KEY="your_framer_api_key"
FRAMER_PROJECT="https://framer.com/projects/Website--aabbccdd1122"
POSTHOG_API_KEY=""
  • Leave POSTHOG_API_KEY empty if you do not want PostHog injected into exports.
  • export and pages need Chromium.
  • api does not need Chromium.

What each mode does

  • export page: exports one published page to static HTML.
  • export site: finds public pages via sitemap.xml or a crawl fallback, then exports the whole site.
  • pages: lists exportable pages without writing files.
  • api: lets you inspect and modify a Framer project from the terminal.

Add --json if you want machine-readable output for scripts or CI.