Getting Started

Introduction

Welcome to the official WPF CLI documentation! This CLI tool simplifies the creation of WordPress plugins, Gutenberg blocks, and custom templates.

Installation

Prerequisites

Before you begin, ensure your environment is properly set up:

• Node.js: Version 18 or higher (download here).
• Package Manager: npm
• Text Editor: VSCode is recommended.

Global Installation

To install WPF CLI globally, use one of the following commands based on your preferred package manager:

npm

$ npm install -g wpf-create

Setup Wizard

VitePress ships with a command line setup wizard that will help you scaffold a basic project. After installation, start the wizard by running:

npm

$ wpf create

You will be greeted with a few simple questions:

┌  Welcome to WPForge!
│
◆  What do you want to create? 
│  ● Block
│  ○ Plugin
└