spinxphp/installer

The official application installer for the Spinx PHP Framework.

v1.0.2 2026-08-27 22:23 UTC

Requires

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

Requires (Dev)

• phpunit/phpunit: ^11.0

MIT

• iamdevroyal

• framework
• php
• cli
• installer
• spinx

Published on Packagist.org on 2026-08-27 22:23 UTC

README

The official global application installer for the Spinx PHP Framework.

Installation

Install the global installer once:

composer global require spinxphp/installer

Ensure your Composer global bin directory is in your PATH. On most systems this is:

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

Verify the installation:

spinx --version
# Spinx Installer 1.0.0

Creating a New Application

spinx new my-app

An interactive wizard guides you through:

1. Frontend adapter (Vue 3 / React 19)
2. Database driver (SQLite, MySQL, PostgreSQL)
3. Runtime driver (RoadRunner / Swoole)
4. App URL

Once complete:

cd my-app
php spinx serve

Visit http://localhost:8080.

Frontend Presets

# Vue 3 + Vite (default)
spinx new my-app --frontend=vue

# React 19 + Vite
spinx new my-app --frontend=react

# No frontend (API / server-side only)
spinx new my-app --frontend=none

Specific Framework Version

spinx new my-app --version=1.0.0

Non-Interactive Mode (CI/CD)

spinx new my-app --frontend=vue --no-interaction

All prompts are skipped. Defaults used:

• DB: SQLite (zero-config)
• Runtime: RoadRunner
• URL: http://localhost:8080

All Commands

spinx new <name>     # Create a new Spinx application
spinx version        # Display installer version
spinx about          # Display framework information
spinx --version      # Alias for version
spinx --help         # List all commands

Alternative Installation (without global installer)

The global installer delegates to Composer internally. You can also install directly:

composer create-project spinxphp/framework my-app

The same interactive wizard runs either way.

After Installation

The local Spinx CLI provides all development commands inside your project:

cd my-app

php spinx serve                        # Start development server
php spinx make:module Orders --all     # Scaffold DDD module
php spinx migrate                      # Run migrations
php spinx queue:work                   # Start queue worker
php spinx ai:build "Build a CMS"       # AI-powered feature generation

Requirements

Requirement	Version
PHP	>= 8.2
Composer	>= 2.0
Extensions	mbstring, pdo, json

License

MIT — see LICENSE.