Sign In View demo Free Trial

Wayfront CLI

The Wayfront CLI lets you pull your workspace templates to your local machine, edit them in your preferred code editor, and push changes back to your workspace — giving you full version control over your client portal's look and feel.

Requirements

Node.js 18 or higher. If you're unsure, run node -v in your terminal to check.

Installation

You can use the CLI without installing globally:

npx wayfront

Or install it globally so you can run wayfront directly:

npm install -g wayfront

You'll be prompted to enter your Wayfront username. A browser tab will open automatically — log in to your account, generate your API token from there, and paste it back into the terminal. Once confirmed, you're connected and ready to go.

Once connected, running wayfront will confirm your workspace status.

Important: If you’re installing via npx, all commands must append npx, for example wayfront templates:pull.

Managing API keys

  1. Go to Settings → Templates → ⚙️ at the bottom

  2. Click Generate new token

  3. Keep this handy — you'll need it during setup

Working with templates

Templates can be saved and modified locally.

Pulling templates

To download all templates from your workspace:

wayfront templates:pull

This creates a templates/ folder in your current directory containing all your workspace templates as .twig files.

To pull a single template:

wayfront templates:pull layouts.main

Editing templates

Templates use dot-notation that maps to a folder structure. For example, portal.dashboard becomes templates/portal/dashboard.twig. Open and edit these files in any code editor.

Pushing changes

To push a specific template back to your workspace:

wayfront templates:push layouts.main

To push all modified templates at once:

wayfront templates:push

Changes go live immediately. You can verify by logging in as a client to preview the updated template.

Resetting a template

To restore a template to its default state:

wayfront templates:reset dashboard

Working with multiple workspaces

You can connect more than one workspace and switch between them:

wayfront init clientco
wayfront use acme

Visit the Wayfront CLI repository on GitHub for the latest updates.