deframer

Reference

CLI reference

Every deframer command and option.

Run deframer --help, or deframer <command> --help, to see these in your terminal. Every command except login, logout and whoami checks your account first.

deframer create <url> <dir>

Export a published Framer site to a new Next.js app, build it, start it and check it. Guide

OptionWhat it does
--port <port>Port for the app on 127.0.0.1. Default 3000.
--no-startStop after the production build.
--no-verifyStart the app without comparing it with the published site.
--allow-host <host>Extra host to download site code from. Repeatable.
--colors <file>JSON file with the site's Framer color styles, for readable color names.
--jsonPrint the result as JSON.
--server <url>deframer server to use. Defaults to DEFRAMER_SERVER, then the built-in server.

deframer verify <dir>

Compare an app made by deframer create with the published site again. Guide

OptionWhat it does
--port <port>Port of the running app. Starts it from its build when nothing listens. Default 3000.
--jsonPrint the result as JSON.
--server <url>deframer server to use. Defaults to DEFRAMER_SERVER, then the built-in server.

deframer login

Log this computer in to your account through your browser. Guide

OptionWhat it does
--no-browserPrint the login link without opening a browser.
--server <url>deframer server to use. Defaults to DEFRAMER_SERVER, then the built-in server.

deframer logout

Log this computer out and end the login on the server.

OptionWhat it does
--server <url>deframer server to use. Defaults to DEFRAMER_SERVER, then the built-in server.

deframer whoami

Show the logged-in account and whether it can use deframer.

OptionWhat it does
--server <url>deframer server to use. Defaults to DEFRAMER_SERVER, then the built-in server.

Environment variables

VariableWhat it does
DEFRAMER_SERVERdeframer server to use when --server is not given.
DEFRAMER_TOKENA login token, used instead of the login saved on this computer.