Installation

Get started with the WPZylos Scaffold to create production-ready WordPress plugins.

Requirements

Installation Methods

Option 1: Composer Create-Project

cd /path/to/wordpress/wp-content/plugins
composer create-project MyCompanystudio/wpzylos-scaffold your-plugin
cd your-plugin

Option 2: Git Clone

git clone https://github.com/MyCompanyStudio/wpzylos-scaffold.git your-plugin
cd your-plugin
rm -rf .git

Initialize Your Plugin

Use the Scaffold CLI to customize your plugin. Choose the method that matches your environment:

Option 1: PowerShell (Windows 10/11)

Open Windows PowerShell (search "PowerShell" in Start menu):

.\scaffold.ps1              # Interactive menu
.\scaffold.ps1 init         # Initialize directly

Option 2: Command Prompt (Windows)

Open Command Prompt (cmd.exe). Since .ps1 files don't run directly in cmd, use:

powershell -ExecutionPolicy Bypass -File scaffold.ps1
powershell -ExecutionPolicy Bypass -File scaffold.ps1 init

Option 3: Bash (Linux/Mac/Git Bash)

For Linux, macOS, or Git Bash on Windows (install Git for Windows):

chmod +x scaffold.sh        # Make executable (first time only)
./scaffold.sh               # Interactive menu
./scaffold.sh init          # Initialize directly

Git Bash alternative: If ./scaffold.sh doesn't work, try bash scaffold.sh

What the Init Script Does

The intelligent init script handles all scenarios:

Next Steps

• Usage Guide - Customize your plugin
• CLI Reference - Complete CLI documentation
• Configuration - Configure options
• Walkthrough - Complete tutorial