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
| Option | What it does |
|---|---|
--port <port> | Port for the app on 127.0.0.1. Default 3000. |
--no-start | Stop after the production build. |
--no-verify | Start 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. |
--json | Print 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
| Option | What it does |
|---|---|
--port <port> | Port of the running app. Starts it from its build when nothing listens. Default 3000. |
--json | Print 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
| Option | What it does |
|---|---|
--no-browser | Print 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.
| Option | What 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.
| Option | What it does |
|---|---|
--server <url> | deframer server to use. Defaults to DEFRAMER_SERVER, then the built-in server. |
Environment variables
| Variable | What it does |
|---|---|
DEFRAMER_SERVER | deframer server to use when --server is not given. |
DEFRAMER_TOKEN | A login token, used instead of the login saved on this computer. |