PHPackages                             api-clients/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. [Parsing &amp; Serialization](/categories/parsing)
4. /
5. api-clients/installer

ActiveLibrary[Parsing &amp; Serialization](/categories/parsing)

api-clients/installer
=====================

YAML based project installer

1.0.0(9y ago)13.2k[3 PRs](https://github.com/php-api-clients/installer/pulls)1MITPHPPHP ^7.0

Since Jun 4Pushed 2y ago1 watchersCompare

[ Source](https://github.com/php-api-clients/installer)[ Packagist](https://packagist.org/packages/api-clients/installer)[ RSS](/packages/api-clients-installer/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (11)Versions (6)Used By (1)

Configurable package installer
==============================

[](#configurable-package-installer)

YAML based project installer inspired by [`IceHawk installer`](https://github.com/icehawk/installer) and [`Koriym.PhpSkeleton`](https://github.com/koriym/Koriym.PhpSkeleton)

[![Build Status](https://camo.githubusercontent.com/65fdc98d6fe56624c788161a8832b2366912cab65cf8c037f5faa1730c2040d0/68747470733a2f2f7472617669732d63692e6f72672f7068702d6170692d636c69656e74732f696e7374616c6c65722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/php-api-clients/installer)[![Latest Stable Version](https://camo.githubusercontent.com/f03516abb18b2ebc643710b6cc8e4ff7a95251471df0c00341f1392dbbf37ed0/68747470733a2f2f706f7365722e707567782e6f72672f6170692d636c69656e74732f696e7374616c6c65722f762f737461626c652e706e67)](https://packagist.org/packages/api-clients/installer)[![Total Downloads](https://camo.githubusercontent.com/3a045e8e6fab050b0832ce8ba2f5475ecd9871a4ee6336bd0c65b5ec5df565b7/68747470733a2f2f706f7365722e707567782e6f72672f6170692d636c69656e74732f696e7374616c6c65722f646f776e6c6f6164732e706e67)](https://packagist.org/packages/api-clients/installer)[![Code Coverage](https://camo.githubusercontent.com/f6386039a2ce2bdf23397fa13ed0bc848cfcc0c771cfbcbe83e3498dc9fe1154/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7068702d6170692d636c69656e74732f696e7374616c6c65722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/php-api-clients/installer/?branch=master)[![License](https://camo.githubusercontent.com/49449eabc2fe069f994dac1b28b15420854020372fa8ac3956f5b4399644fbe0/68747470733a2f2f706f7365722e707567782e6f72672f6170692d636c69656e74732f696e7374616c6c65722f6c6963656e73652e706e67)](https://packagist.org/packages/api-clients/installer)[![PHP 7 ready](https://camo.githubusercontent.com/0d9d0f4e8a439b29107e4d38996feba96e5da7999f7074abc8439601789e74cf/687474703a2f2f7068703772656164792e74696d6573706c696e7465722e63682f7068702d6170692d636c69656e74732f696e7374616c6c65722f62616467652e737667)](https://travis-ci.org/php-api-clients/installer)

Usage
-----

[](#usage)

require api-clients/installer
-----------------------------

[](#require-api-clientsinstaller)

Add `api-clients/installer` to `require` of your `composer.json`.

post-create-project-cmd
-----------------------

[](#post-create-project-cmd)

It is recommended to use the following `post-create-project-cmd` script. This is the bare minimum require for the installer to work. [`api-clients/skeleton` for example also runs resource generation, code style fixes, and QA checks after install.](https://github.com/php-api-clients/skeleton/blob/30a2d61453a014052ab84ba11687d3cd5fe23a4f/composer.json#L97-L104):

```
{

    "scripts": {
        "post-create-project-cmd": [
            "ApiClients\\Tools\\Installer\\Installer::postCreateProject",
            "composer update --no-autoloader --ansi",
            "composer update --ansi"
        ]
    }
}
```

installer.yml
-------------

[](#installeryml)

Create an `installer.yml` in the project root of the package you want to create use the installer for. The following configuration is from `api-clients/skeleton`:

```
package: api-clients/skeleton
text:
  welcome: "Welcome to the API Clients new client installer."
  ascii_art_file:
    - ascii.small.art
    - ascii.medium.art
    - ascii.large.art
  ascii_art_package: api-clients/branding
config:
  current_ns: "ApiClients\\Skeleton"
  current_ns_tests: "ApiClients\\Tests\\Skeleton"
  require:
    - installer
    - installer-client-operations
  scripts:
    - post-create-project-cmd
questions:
  author_name:
    description: "Author name"
    question: "What is your name?"
  author_email:
    description: "Author email"
    question: "What is your email address?"
    validate: "Assert\\Assertion::email"
  package_name:
    description: "Your package"
    question: "What is your package name?"
    default: "vendor-name/package-name"
  path_src:
    description: "Your project sources location"
    question: "What is your project sources location?"
    default: "src/"
  path_tests:
    description: "Your project tests location"
    question: "What is your project tests location?"
    default: "tests/"
  ns_vendor:
    description: "Your namespace"
    question: "What is your vendor namespace?"
    default: "MyVendor"
  ns_tests_vendor:
    description: "Your test namespace"
    question: "What is your vendor test namespace?"
    default: "MyVendor\\Tests"
  ns_project:
    description: "Your project namespace"
    question: "What is your project namespace?"
    default: "MyProject"
operations:
  - "ApiClients\\Tools\\Installer\\Operation\\ComposerJson::create"
  - "ApiClients\\Tools\\Installer\\Operation\\UpdateNamespaces::create"
```

Lets break that down and describe what each section does:

### package

[](#package)

The name of the skeleton package.

### text

[](#text)

Text options used to create a welcome at the start of the installer.

##### text.welcome

[](#textwelcome)

Welcome message.

##### text.ascii\_art\_file

[](#textascii_art_file)

Array with ASCII files.

##### text.ascii\_art\_package

[](#textascii_art_package)

ASCII art package, if not provided the skeleton is searched for the ASCII art files.

### config

[](#config)

Array with additional configuration options.

### questions

[](#questions)

The questions asked used for gathering the information needed to perform the operations.

### operations

[](#operations)

Operations run after all the questions have been answered.

License
=======

[](#license)

The MIT License (MIT)

Copyright (c) 2017 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 74.8% 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

Unknown

Total

1

Last Release

3314d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/147145?v=4)[Cees-Jan Kiewiet](/maintainers/WyriHaximus)[@WyriHaximus](https://github.com/WyriHaximus)

---

Top Contributors

[![WyriHaximus](https://avatars.githubusercontent.com/u/147145?v=4)](https://github.com/WyriHaximus "WyriHaximus (92 commits)")[![dependabot-support](https://avatars.githubusercontent.com/u/112581971?v=4)](https://github.com/dependabot-support "dependabot-support (19 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (12 commits)")

---

Tags

hacktoberfestinstallerphpphp7reactphpyaml

### Embed Badge

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

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

###  Alternatives

[behat/behat

Scenario-oriented BDD framework for PHP

4.0k101.8M2.2k](/packages/behat-behat)[roave/backward-compatibility-check

Tool to compare two revisions of a public API to check for BC breaks

6003.7M96](/packages/roave-backward-compatibility-check)[jolicode/castor

A lightweight and modern task runner. Automate everything. In PHP.

54642.4k4](/packages/jolicode-castor)[shopware/platform

The Shopware e-commerce core

3.4k1.5M3](/packages/shopware-platform)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k13](/packages/tempest-framework)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M551](/packages/shopware-core)

PHPackages © 2026

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