PHPackages                             club/kickoff-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. club/kickoff-installer

ActiveLibrary

club/kickoff-installer
======================

Kickoff application installer.

v2.1.0(8y ago)1548MITPHP

Since Jun 6Pushed 8y ago1 watchersCompare

[ Source](https://github.com/clubstudioltd/kickoff-installer)[ Packagist](https://packagist.org/packages/club/kickoff-installer)[ RSS](/packages/club-kickoff-installer/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (7)Used By (0)

Kickoff Installer
=================

[](#kickoff-installer)

Kick start the development of your new website or web application. Hit the ground running with pre-configured Gulp tasks, linter configurations, a sensible directory structure and default meta files.

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

[](#installation)

The Kickoff Installer requires the PHP package manager. Visit the [Composer website](https://getcomposer.org/) for instructions on how to install it on your system.

Once you have Composer installed, you will need to require the installer as a global dependency:

`composer global require "club/kickoff-installer"`

Make sure that you've added the composer bin directory (`~/.composer/vendor/bin` or similar) to your PATH, otherwise your system will not be able to find the installer.

A quick Google search should help you find out how to add to your PATH. If you use fish shell it's as easy as running `set --universal fish_user_paths $fish_user_paths ~/.composer/vendor/bin` in your terminal.

Framework Support
-----------------

[](#framework-support)

The installer supports the following frameworks:

- [CraftCMS](http://craftcms.com)

It is built so you can easily add support for additional frameworks/platforms without much fuss.

Kickoff + CraftCMS Usage Example
--------------------------------

[](#kickoff--craftcms-usage-example)

Create a new project directory and navigate into it:

```
$ mkdir my-new-site && cd my-new-site

```

then run:

```
$ kickoff new CraftCms

```

This will download and install [Kickoff](https://github.com/clubstudioltd/kickoff), followed by CraftCMS and then configure the default CraftCMS install to work with [Kickoff](https://github.com/clubstudioltd/kickoff) – including updating the default directory structure.

Clean Installs
--------------

[](#clean-installs)

If you would rather omit Kickoff and get you a clean install of the framework/platform you can use the `--clean` option.

e.g.

```
$ kickoff new CraftCms --clean

```

Custom Configuration
--------------------

[](#custom-configuration)

Each framework installer has it's own configuration. If you would like to make changes to the default settings you can use the `config` command. This will generate a configuration file (`kickoff.json`) for the specified framework installation script.

An example use case would be configuring the directory structure of a CraftCMS installation. Running `kickoff config CraftCms` would generate the necessary config file, which you can then customise to your individual needs.

Remember, you need to run `kickoff config framework-name` and make your changes before running `kickoff new framework-name`.

Credits
-------

[](#credits)

Inspired by Laravel and the Laravel Installer.

Roadmap
-------

[](#roadmap)

- Have `kickoff new CraftCms --clean` command restructure directories if a config file is present
- Add support for a skeleton Symfony application

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity67

Established project with proven stability

 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 ~96 days

Total

5

Last Release

3238d ago

Major Versions

v1.0.2 → v2.0.02016-08-01

### Community

Maintainers

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

---

Top Contributors

[![scottwakefield](https://avatars.githubusercontent.com/u/4173571?v=4)](https://github.com/scottwakefield "scottwakefield (24 commits)")

---

Tags

craftcmscraftcmskickoff

### Embed Badge

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

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

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M17.0k](/packages/laravel-framework)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M647](/packages/sylius-sylius)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M255](/packages/laravel-dusk)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19462.3M1.3k](/packages/drupal-core)[laravel/vapor-cli

The Laravel Vapor CLI

31310.7M8](/packages/laravel-vapor-cli)[magento/magento2-functional-testing-framework

Magento2 Functional Testing Framework

15511.5M30](/packages/magento-magento2-functional-testing-framework)

PHPackages © 2026

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