Skip to content
FrameKit Docs

framekit CLI

Run framekit from the consumer project root. Every command uses process.cwd() as its project root. The executable accepts these commands:

framekit generate
framekit check
framekit dev
framekit build
framekit start
framekit browser install [--with-deps]

Standard commands reject extra arguments. The browser command accepts only the optional --with-deps flag. The CLI has no --help or --version command.

framekit generate

Section titled “framekit generate”

Scans src/templates and writes the project-local generated modules under src/generated/framekit/:

  • templates.ts
  • brands.ts
  • studio-client.tsx
  • render-client.tsx

It also synchronizes discovered template assets under public/framekit/templates/. The command requires at least one discovered template.

Terminal window
pnpm framekit generate

framekit check

Section titled “framekit check”

Runs generate first, then validates every discovered template definition and every declared content variant. It uses a temporary checker under .framekit/, removes that temporary directory after the check, and reports structured validation errors. It is not a TypeScript typecheck and does not render PNG output.

Terminal window
pnpm framekit check

framekit dev

Section titled “framekit dev”

Runs generate before starting the Next.js development server with Turbopack. It watches paths under src/templates and src/brand and regenerates the generated modules when they change. It does not require a production build.

Terminal window
pnpm framekit dev

The development server uses FRAMEKIT_HOST, then HOST, then localhost for its hostname, and PORT with a default of 3000.

framekit build

Section titled “framekit build”

Runs check first. When validation succeeds, it runs next build and prepares the standalone output under .framekit/next/, including the public and Next static assets needed by that server. A separate build is not required before this command.

Terminal window
pnpm framekit build

framekit start

Section titled “framekit start”

Starts the existing production standalone server. It does not run generate, check, or next build; run framekit build successfully first.

Terminal window
pnpm framekit start

The launched standalone server inherits its environment. Next.js reads production HOSTNAME and PORT; FRAMEKIT_HOST and HOST are not mapped to HOSTNAME by start.

framekit browser install

Section titled “framekit browser install”

Installs the Chromium headless shell used by server-side rendering. --with-deps additionally asks Playwright to install system dependencies, which may require root or equivalent package privileges on Linux.

Terminal window
pnpm framekit browser install
pnpm framekit browser install --with-deps

The command honors PLAYWRIGHT_BROWSERS_PATH. The other framekit commands do not download browser binaries.

See create a template, Use Studio, deployment runtime, and the server package API.