Reference

Webflow CLI

Learn about the Webflow CLI and how to use it to share and update your component library.
Private Beta

The Webflow CLI is the command line interface for developers to interact with Webflow. Use the CLI to manage your code component libraries by:

  • Authenticating with your Webflow workspace
  • Bundling components into deployable libraries
  • Sharing libraries to your workspace for use across sites

You can use the CLI directly in your project or in CI/CD pipelines to automate library deployment.

Installation

The Webflow CLI is available as a package on npm. You can install it with the following command:

$npm install -g @webflow/webflow-cli

Commands

Share your library

To share your library to your Workspace, use the following command:

$npx webflow library share

This command will:

  • Authorize your workspace: The CLI will check for a Workspace authentication token in your .env file. If one isn’t found, the CLI will prompt you to authenticate by opening a browser window to the Workspace authorization page.
  • Bundle your library: The CLI will bundle your library, and ask you to confirm the components you want to share.
  • Upload your library to your Workspace

Options

You can use the following options to customize sharing:

Command OptionDescriptionDefault
--manifestProvide the path to the webflow.json file.Scans the current directory for webflow.json.
--api-tokenPass a Workspace API token.Uses WEBFLOW_WORKSPACE_API_TOKEN from the .env file.
--no-inputAvoid prompting or doing anything interactive. Useful for CI/CD pipelines.No
--verboseDisplay more information for debugging purposes.No
--devBundle in development mode for debugging purposes. This will disable minification and source maps.No

Bundle your library

Bundle your library locally for debugging and testing. The share command automatically bundles your library, but you can use bundle for local development.

$npx webflow library bundle --public-path http://localhost:4000/

Options

Command OptionDescription
--public-pathRequired. The URL where you can serve your library.
--forceForces the bundler to finish compiling, even if there are warnings.
--devBundle in development mode for debugging purposes. This will disable minification and source maps.
--debug-bundlerPrint the final configuration being used by webpack.

CI/CD workflows

Use the CLI in automated workflows by adding the --no-input option to avoid interactive prompts.

Important: Implement change detection before sharing to avoid unintentionally removing components:

  • Compare current library state with previous deployment
  • Only share when components have actually changed
$npx webflow library share --no-input

Troubleshooting

If you’re having trouble authenticating with your Workspace, try the following:

  • Check your .env file for the WEBFLOW_WORKSPACE_API_TOKEN variable. Be sure to use a Workspace API token, not a Site API token.

  • Try running the share command with the --verbose flag to see if there is additional information in the output.

    $npx webflow library share --verbose

  • If you’re still having trouble, try running the share command with the --api-token flag to manually pass in your API token.

    $npx webflow library share --api-token <your-api-token>

If the CLI is warning you that you’re about to remove components, it’s because the CLI is comparing the current library state with the previous deployment. Be sure your component name matches the name in the previous deployment. Otherwise, the CLI will create a new component and remove the old one.