zephyrphp/installer

ZephyrPHP Project Installer - Create new ZephyrPHP projects with ease

v0.1.0 2026-01-24 21:46 UTC

Requires

• php: >=8.2
• symfony/console: ^7.0
• symfony/process: ^7.0

Requires (Dev)

• phpunit/phpunit: ^11.0

MIT

• Techwonia

• cli
• installer
• project
• scaffold
• zephyrphp

README

Light as a breeze, fast as the wind. Create new ZephyrPHP projects with ease.

  ███████╗███████╗██████╗ ██╗  ██╗██╗   ██╗██████╗ ██████╗ ██╗  ██╗██████╗
  ╚══███╔╝██╔════╝██╔══██╗██║  ██║╚██╗ ██╔╝██╔══██╗██╔══██╗██║  ██║██╔══██╗
    ███╔╝ █████╗  ██████╔╝███████║ ╚████╔╝ ██████╔╝██████╔╝███████║██████╔╝
   ███╔╝  ██╔══╝  ██╔═══╝ ██╔══██║  ╚██╔╝  ██╔══██╗██╔═══╝ ██╔══██║██╔═══╝
  ███████╗███████╗██║     ██║  ██║   ██║   ██║  ██║██║     ██║  ██║██║
  ╚══════╝╚══════╝╚═╝     ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝     ╚═╝  ╚═╝╚═╝

Installation

Global Installation (Recommended)

Install the ZephyrPHP installer globally using Composer:

composer global require zephyrphp/installer

Make sure the Composer global bin directory is in your PATH:

• macOS/Linux: ~/.composer/vendor/bin or ~/.config/composer/vendor/bin
• Windows: %APPDATA%\Composer\vendor\bin

Verify Installation

zephyrphp --version

Usage

Create a New Project

zephyrphp new my-project

This creates a new ZephyrPHP project in the my-project directory.

Available Options

# Create project with Git initialization
zephyrphp new my-project --git

# Create project from development branch
zephyrphp new my-project --dev

# Force overwrite existing directory
zephyrphp new my-project --force

# Skip composer install
zephyrphp new my-project --no-install

# Combine options
zephyrphp new my-project --git --dev

Commands

Command	Description
zephyrphp new <name>	Create a new ZephyrPHP project
zephyrphp list	List all available commands
zephyrphp help <command>	Get help for a specific command

Options Reference

zephyrphp new

Option	Short	Description
--git	-g	Initialize a Git repository
--dev	-d	Install latest development version
--branch	-b	Specify branch for dev mode (default: main)
--force	-f	Overwrite existing directory
--no-install		Skip running composer install

After Installation

Once your project is created:

cd my-project
php craftsman serve

Then open your browser to http://localhost:8000.

Useful Craftsman Commands

# Start development server
php craftsman serve

# Create a controller
php craftsman make:controller UserController

# Create a model
php craftsman make:model User

# List all routes
php craftsman routes:list

# Run migrations
php craftsman migrate

# Clear cache
php craftsman cache:clear

Updating the Installer

Keep your installer up to date:

composer global update zephyrphp/installer

Troubleshooting

Command not found

If zephyrphp is not found, ensure Composer's global bin directory is in your PATH:

# macOS/Linux
export PATH="$HOME/.composer/vendor/bin:$PATH"

# Or add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
echo 'export PATH="$HOME/.composer/vendor/bin:$PATH"' >> ~/.bashrc

Windows

Add to your environment variables:

%APPDATA%\Composer\vendor\bin

Permission errors

On macOS/Linux, you may need to adjust permissions:

chmod +x ~/.composer/vendor/bin/zephyrphp

Composer not found

Ensure Composer is installed globally:

# Check if Composer is installed
composer --version

# If not, install from https://getcomposer.org

Requirements

• PHP 8.2 or higher
• Composer 2.0 or higher
• Git (optional, for --git flag)

Author

Techwonia

• ZephyrPHP: zephyrphp.com
• Company: techwonia.com
• Email: [e-mail]
• GitHub: @Techwonia

License

The ZephyrPHP Installer is open-sourced software licensed under the MIT license.