PHPackages                             pocketframe/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. [Utility & Helpers](/categories/utility)
4. /
5. pocketframe/installer

ActiveProject[Utility & Helpers](/categories/utility)

pocketframe/installer
=====================

PocketFrame application installer

2.1.3(1y ago)033MITPHPPHP ^8.1

Since Mar 27Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Pocketframe/installer)[ Packagist](https://packagist.org/packages/pocketframe/installer)[ RSS](/packages/pocketframe-installer/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (10)Versions (26)Used By (0)

PocketFrame Installer
=====================

[](#pocketframe-installer)

PocketFrame Installer is a command-line tool designed to bootstrap a new PocketFrame application. It automates many steps of project setup by performing the following tasks:

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

[](#installation)

```
composer global require pocketframe/installer
```

Usage
-----

[](#usage)

To create a new PocketFrame application, run:

```
pocketframe new
```

- ``: The name of your new project (required).
- `--config` (`-c`): Optional JSON configuration file to predefine setup options.

Follow the interactive prompts to provide database credentials and select optional features.

Project Creation
----------------

[](#project-creation)

1. **Project Creation:**

    - Clones a Git repository skeleton for a standardized project structure.
    - Creates a new directory based on the provided project name.
2. **Configuration Management:**

    - Loads optional JSON configuration if the `--config` option is provided.
    - Merges user-defined settings with defaults.
3. **System Requirement Checks:**

    - Verifies required PHP extensions (`pdo`, `mbstring`, `openssl`).
    - Optionally checks for Node.js installation for extended functionality.
4. **Dependency Installation:**

    - Installs PHP dependencies using Composer within the new project directory.
5. **Interactive Setup:**

    - Prompts the user for database configuration details.
    - Offers choices for database drivers (MySQL, PostgreSQL, SQLite) and collects credentials accordingly.
6. **Environment Configuration:**

    - Copies the `.env.example` file to `.env` and generates an application key.
7. **Additional Features:**

    - Configures Docker environment if needed.
    - Initializes a Git repository in the new project directory.
    - Executes post-install commands and sends telemetry data.
8. **Error Handling & Rollback:**

    - Catches exceptions during the installation process, displays error messages, and rolls back previously performed steps if necessary.

System Requirements
-------------------

[](#system-requirements)

- PHP with the following extensions: `pdo`, `mbstring`, `openssl`.
- Composer installed.
- Node.js (recommended for some features, though not required).

Error Handling
--------------

[](#error-handling)

If an error occurs during the installation, the installer will:

- Display a descriptive error message.
- Roll back any changes made up to that point (e.g., cloned repository, installed dependencies).

Customization
-------------

[](#customization)

You can customize the installation process by providing a custom configuration file with the `--config` option.

License
-------

[](#license)

This project is licensed under the MIT License.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance46

Moderate activity, may be stable

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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

Every ~0 days

Total

24

Last Release

414d ago

Major Versions

1.0.10 → 2.0.02025-03-28

### Community

Maintainers

![](https://www.gravatar.com/avatar/a574762c42c4aac532a36603bcd5942930718bbaaeff1f59bbaed2a962b79588?d=identicon)[williamug](/maintainers/williamug)

---

Top Contributors

[![Williamug](https://avatars.githubusercontent.com/u/15543507?v=4)](https://github.com/Williamug "Williamug (62 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  Alternatives

[symfony/maker-bundle

Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code.

3.4k111.1M568](/packages/symfony-maker-bundle)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[symplify/monorepo-builder

Not only Composer tools to build a Monorepo.

5205.3M82](/packages/symplify-monorepo-builder)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[ec-cube/ec-cube

EC-CUBE EC open platform.

78527.0k1](/packages/ec-cube-ec-cube)[shlinkio/shlink

A self-hosted and PHP-based URL shortener application with CLI and REST interfaces

4.8k4.3k](/packages/shlinkio-shlink)

PHPackages © 2026

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