Installation

Get started with wfapi by installing it globally on your system.

Requirements

• Node.js version 14 or higher
• npm (comes with Node.js)
• A Webflow account with API access

Global Installation (Recommended)

Install wfapi globally to use it from anywhere on your system:

npm install -g @sygnal/wfapi

This installs the wfapi command on your PATH, making it available from any directory.

Verify Installation

After installation, verify that wfapi is correctly installed:

wfapi --help

You should see the help output with available commands.

Alternative: Local Installation

If you prefer to install wfapi locally within a specific project:

npm install @sygnal/wfapi

Then run it using npx:

npx wfapi sites

Or add it to your package.json scripts:

{
  "scripts": {
    "wf": "wfapi"
  }
}

Getting Your API Token

Before you can use wfapi, you’ll need a Webflow API token:

1. Log in to your Webflow Dashboard 
2. Navigate to Account Settings → Integrations
3. Click Generate API Token
4. Give it a descriptive name (e.g., “CLI Access”)
5. Set permissions:
   • Site: Read-only access
   • CMS: Read-only access
6. Copy your token (you’ll only see it once!)

Quick Setup

Once installed, configure your API token:

wfapi config set your_api_token_here

This saves your token to a global config file in your home directory (~/.wfapi).

Test Your Setup

List your Webflow sites to confirm everything is working:

wfapi sites

You should see a list of all sites accessible with your API token.

Update wfapi

To update wfapi to the latest version:

npm update -g @sygnal/wfapi

Or reinstall:

npm install -g @sygnal/wfapi@latest

Uninstall

To remove wfapi from your system:

npm uninstall -g @sygnal/wfapi

This removes the CLI but leaves your config files intact. To remove config files:

# Remove global config
rm ~/.wfapi
 
# Remove environment configs (if any)
rm ~/.wfapi.*

Troubleshooting

Command Not Found

If you get a “command not found” error after installation:

1. Make sure npm’s global bin directory is in your PATH
2. Find the directory with: npm config get prefix
3. Add it to your PATH in your shell profile (.bashrc, .zshrc, etc.)

Permission Errors

On macOS/Linux, if you get permission errors during installation:

sudo npm install -g @sygnal/wfapi

Or better, configure npm to install packages globally without sudo .

Windows Path Issues

On Windows, ensure that npm’s global directory is in your system PATH:

1. Open Environment Variables settings
2. Check that %APPDATA%\npm is in your PATH
3. Restart your terminal after making changes

Next Steps

Platform-Specific Notes

macOS

Installation works out of the box with Homebrew or standard Node.js installation.

Linux

Works with any Node.js installation. Consider using nvm  for easier Node.js version management.

Windows

Works with Node.js for Windows. PowerShell and Command Prompt are both supported.