PHPackages                             miniframework/installer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. miniframework/installer

ActiveLibrary[Framework](/categories/framework)

miniframework/installer
=======================

MiniFramework PHP project installer - Create new projects globally

1.0.2(10mo ago)24MITPHPPHP ^8.4

Since Jul 10Pushed 10mo agoCompare

[ Source](https://github.com/NastMz/mini-php-framework-installer)[ Packagist](https://packagist.org/packages/miniframework/installer)[ RSS](/packages/miniframework-installer/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

MiniFramework PHP Global Installer
==================================

[](#miniframework-php-global-installer)

[![Packagist](https://camo.githubusercontent.com/98d7de25d75ebfcf67fa07e4997e870896a4983550322bdd322d565992f7c867/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d696e696672616d65776f726b2f696e7374616c6c65722e737667)](https://packagist.org/packages/miniframework/installer)[![Downloads](https://camo.githubusercontent.com/91380c837281da424b46b5854066ddba7dec4674cddff5ef42961524639a08ef/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d696e696672616d65776f726b2f696e7374616c6c65722e737667)](https://packagist.org/packages/miniframework/installer)[![License](https://camo.githubusercontent.com/c9ef7c498840f896bb66330f737559b9c61683ca0b98261cfc760aae72cf97be/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6d696e696672616d65776f726b2f696e7374616c6c65722e737667)](https://github.com/NastMz/mini-php-framework-installer/blob/main/LICENSE)[![PHP Version](https://camo.githubusercontent.com/fe8172823af9f37e91bbaa0c453a85a5f1206214d9c8c338f217348fa2ea5999/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6d696e696672616d65776f726b2f696e7374616c6c65722e737667)](https://packagist.org/packages/miniframework/installer)

Global command-line installer for creating new MiniFramework PHP projects from anywhere.

> **⚡ Laravel-style project creation**: Create new MiniFramework projects with a single command, just like `laravel new`!

Installation
------------

[](#installation)

### Global Installation via Composer

[](#global-installation-via-composer)

```
composer global require miniframework/installer
```

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

```
# Add to your ~/.bashrc, ~/.zshrc, or equivalent
export PATH="$PATH:$HOME/.composer/vendor/bin"

# For Windows, add to your PATH environment variable:
# %APPDATA%\Composer\vendor\bin
```

### Manual Installation

[](#manual-installation)

```
# Clone this repository
git clone https://github.com/miniframework/installer.git
cd installer

# Install dependencies
composer install

# Make the script executable (Unix/Linux/macOS)
chmod +x bin/miniframework

# Add to PATH or create symlink
ln -s $(pwd)/bin/miniframework /usr/local/bin/miniframework
```

Usage
-----

[](#usage)

### Create a New Project

[](#create-a-new-project)

```
# Basic project creation
miniframework new my-project

# Create with custom path
miniframework new my-api --path=/var/www/my-api

# Create with custom namespace and description
miniframework new my-blog \
  --namespace=Blog \
  --description="My personal blog built with MiniFramework PHP"

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

# Skip Git initialization
miniframework new my-project --no-git

# Skip dependency installation
miniframework new my-project --no-install

# Include development dependencies
miniframework new my-project --dev
```

### Available Commands

[](#available-commands)

```
# Show help
miniframework help

# Show version
miniframework version

# Create new project (main command)
miniframework new  [options]
```

### Options

[](#options)

OptionDescription`--path=PATH`Custom path for the project (default: current directory + project name)`--namespace=NAMESPACE`Custom namespace (default: generated from project name)`--description=DESC`Project description`--force`Overwrite existing directory`--no-git`Skip Git repository initialization`--no-install`Skip dependency installation`--dev`Install development dependenciesExamples
--------

[](#examples)

### Create a REST API

[](#create-a-rest-api)

```
miniframework new my-api \
  --namespace=MyApi \
  --description="REST API for my application"
```

### Create a Web Application

[](#create-a-web-application)

```
miniframework new my-webapp \
  --path=/var/www/webapp \
  --namespace=WebApp \
  --description="Full-stack web application"
```

### Create a Microservice

[](#create-a-microservice)

```
miniframework new auth-service \
  --namespace=AuthService \
  --description="Authentication microservice"
```

What Gets Created
-----------------

[](#what-gets-created)

The installer creates a complete MiniFramework PHP project with:

### ✅ Project Structure

[](#-project-structure)

- Complete DDD/Clean Architecture structure
- All necessary directories with `.gitkeep` files
- Proper PSR-4 autoloading configuration

### ✅ Configuration Files

[](#-configuration-files)

- `composer.json` with updated namespace and project info
- `.env.example` with all configuration options
- `.gitignore` with appropriate exclusions

### ✅ Customization

[](#-customization)

- Updated namespaces throughout the codebase
- Personalized README.md with project-specific instructions
- Custom package name and description

### ✅ Development Tools

[](#-development-tools)

- Git repository initialized (unless `--no-git`)
- Dependencies installed (unless `--no-install`)
- Ready-to-use CLI commands
- Development server ready to start

Framework Features
------------------

[](#framework-features)

Each created project includes:

- **Domain-Driven Design** architecture
- **Clean Architecture** principles
- **Dependency Injection** container with autowiring
- **Advanced Routing** with attributes and parameters
- **Middleware Pipeline** (PSR-15 compatible)
- **Rate Limiting** with multiple backends
- **CSRF Protection** for forms and AJAX
- **JWT Authentication** with refresh tokens
- **File Upload System** with validation
- **Template Engine** with layouts and components
- **Database Migrations** and seeders
- **CLI Commands** for development

Post-Creation Steps
-------------------

[](#post-creation-steps)

After creating a project:

```
# Navigate to project directory
cd my-project

# Copy environment file (if not done automatically)
cp .env.example .env

# Generate application key
php bin/console key:generate

# Initialize database
php bin/console db:setup
php bin/console migrate

# Start development server
php bin/console serve
```

Requirements
------------

[](#requirements)

- PHP 8.4+
- Composer
- cURL extension (for downloading framework)
- ZIP extension (for extracting framework)
- Git (optional, for repository initialization)

Troubleshooting
---------------

[](#troubleshooting)

### Command not found

[](#command-not-found)

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

```
# Check if it's in PATH
echo $PATH | grep composer

# Add to PATH (add to your shell profile)
export PATH="$PATH:$HOME/.composer/vendor/bin"
```

### Permission denied

[](#permission-denied)

Make the script executable:

```
chmod +x ~/.composer/vendor/bin/miniframework
```

### Download failed

[](#download-failed)

The installer will try Git first, then fall back to ZIP download. Make sure you have either:

- Git installed and available in PATH
- cURL and ZIP extensions enabled

### Force overwrite

[](#force-overwrite)

Use `--force` to overwrite existing directories:

```
miniframework new my-project --force
```

Contributing
------------

[](#contributing)

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

License
-------

[](#license)

This installer is open-sourced software licensed under the [MIT license](LICENSE).

Links
-----

[](#links)

- [MiniFramework PHP Repository](https://github.com/nastmz/mini-php-framework)
- [Documentation](https://github.com/nastmz/mini-php-framework#readme)
- [Report Issues](https://github.com/miniframework/installer/issues)

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance54

Moderate activity, may be stable

Popularity6

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

313d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/618b1965cc2a1bfd3bfa760a3242aa035fa5c90a853002b640399a77ef3a5d41?d=identicon)[NastMz](/maintainers/NastMz)

---

Tags

phpcliframeworkscaffoldinstaller

### Embed Badge

![Health badge](/badges/miniframework-installer/health.svg)

```
[![Health](https://phpackages.com/badges/miniframework-installer/health.svg)](https://phpackages.com/packages/miniframework-installer)
```

###  Alternatives

[utopia-php/cli

A simple CLI library to manage command line applications

41396.4k10](/packages/utopia-php-cli)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
