@flowmetelev/wfkit
v1.7.0
Published
A powerful CLI utility for securely publishing Webflow projects with live development support.
Maintainers
Readme
wfkit
wfkit is a CLI for building and publishing Webflow code projects.
The npm package installs the native Go binary for your platform during setup.
Supported npm targets:
- macOS
x64andarm64 - Linux
x64andarm64 - Windows
x64andarm64
If your platform is outside that matrix, install from source instead of npm.
Install
Run:
npm install -g @flowmetelev/wfkitIf your package manager blocks postinstall scripts, the wfkit launcher will download the native binary automatically on first run.
If you are developing wfkit itself and need a generated project to use your local unreleased binary instead of the latest published release, set WFKIT_BINARY_PATH before running package scripts:
WFKIT_BINARY_PATH=/absolute/path/to/bin/wfkit bun run devQuick start
Create a project:
wfkit init --name my-siteThen:
cd my-site
bun install
bun run startThis starts a local proxy on http://localhost:3000 and injects your Vite scripts into proxied HTML only. The published .webflow.io site stays unchanged for everyone else.
To expose the proxy on your local network, run:
wfkit proxy --host 192.168.1.25When you're ready to ship:
wfkit publish --env prodTo preview the publish plan without changing GitHub or Webflow:
wfkit publish --env prod --dry-runMain commands
wfkit init
Create a new project scaffold, including wfkit.json.
wfkit proxy
Proxy your published .webflow.io site locally and inject local dev scripts.
wfkit publish
Build and publish your code to Webflow.
wfkit doctor
Check config, local tools, auth, and ports.
wfkit update
Check for CLI updates.
Configure the project
wfkit.json is the main project config file.
Example:
{
"appName": "my-site",
"siteUrl": "https://my-site.webflow.io",
"ghUserName": "your-username",
"repositoryName": "your-repo",
"packageManager": "bun",
"branch": "main",
"buildDir": "dist/assets",
"devHost": "localhost",
"devPort": 5173,
"proxyHost": "localhost",
"proxyPort": 3000,
"openBrowser": true,
"globalEntry": "src/global/index.ts"
}Generated projects follow this structure:
src/
global/
pages/
utils/
build/
dist/assets/wfkit builds a wfkit-manifest.json file in dist/assets so page and global publish flows can resolve the right scripts without guessing filenames.
Legacy dev mode
wfkit publish --env dev still works, but wfkit proxy is the recommended development flow.
