Reframe CLI

Install published Framer components into a React project as local JSX or TSX source with the Reframe CLI.

Requirements

• Node.js 22 or newer
• An existing React project with a package.json
• A Reframe component export ID from the Reframe Framer plugin

Commands

Run commands from the directory containing your project’s package.json:

pnpx @reframejs/cli login
pnpx @reframejs/cli init
pnpx @reframejs/cli add <component-id>

List installed components to find the Reframe ID recorded for a local file:

pnpx @reframejs/cli list
pnpx @reframejs/cli list pricing

Remove an installed component and the generated files tracked for it:

pnpx @reframejs/cli remove <component-id>

When you need a local name different from the published component name, pass --name. The name is converted to a safe file name and is used for the local component, stylesheet, and metadata files:

pnpx @reframejs/cli add <component-id> --name marketing-navbar

The CLI stores your local credential in the operating system’s Reframe config directory. status checks the current account and logout removes the local credential:

pnpx @reframejs/cli status
pnpx @reframejs/cli logout

init detects the project structure and lets you choose where the managed framer/ directory belongs. add downloads the selected component, its assets, and its component stylesheet. JavaScript projects receive JSX output; TypeScript projects receive a typed TSX facade alongside the generated runtime.

Use --yes to accept an update without a prompt:

pnpx @reframejs/cli add <component-id> --yes

Create a small Vite preview app for an exported component with:

pnpx @reframejs/cli create --component <component-id>

Pass --out <directory> to choose the preview directory or --no-install to skip installing its generated dependencies.

Generated files include inline comments that point to the Reframe documentation. The documentation URL is configured by the CLI release, so users do not need to edit generated source or project configuration when the documentation domain changes.

Run pnpx @reframejs/cli --help for the complete command list.