PHPackages                             konstrui/konstrui - 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. konstrui/konstrui

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

konstrui/konstrui
=================

A build system in PHP.

0.4.1(8y ago)2191[9 issues](https://github.com/shazarre/konstrui/issues)MITPHPPHP ^5.5 || ^7.0

Since Aug 10Pushed 8y ago1 watchersCompare

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

READMEChangelog (1)Dependencies (4)Versions (2)Used By (0)

Konstrui
========

[](#konstrui)

[![Build Status](https://camo.githubusercontent.com/b1bc292162d175931b0afa98294043eea01fa15d99ed41892e12a919d7e1d7d9/68747470733a2f2f7472617669732d63692e6f72672f7368617a617272652f6b6f6e73747275692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/shazarre/konstrui)[![codecov](https://camo.githubusercontent.com/b91d5f792cd506c01f1d5fc38f039f58b099d6df78d6983e4be986e6f790d847/68747470733a2f2f636f6465636f762e696f2f67682f7368617a617272652f6b6f6e73747275692f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/shazarre/konstrui)[![Codacy Badge](https://camo.githubusercontent.com/a6e1d0e3a57a298e238230427d2b257dd7aca9b55d2975ee1b24d2d8d6c0377f/68747470733a2f2f6170692e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f3837326536346333616466303463666439376333633434653165336263663561)](https://www.codacy.com/app/leszek-stachowski/konstrui?utm_source=github.com&utm_medium=referral&utm_content=shazarre/konstrui&utm_campaign=Badge_Grade)

FAQ
---

[](#faq)

### What does "konstrui" mean?

[](#what-does-konstrui-mean)

It means "to build" in Esperanto. Now you can see that connection between the name and purpose of the project is pretty straightforward.

### A build system in PHP?

[](#a-build-system-in-php)

Yes, it's meant to be used with PHP projects. Because it's written in PHP, it's supposed to be super easy for PHP developers to dive in.

What's important is the fact that having a project and build system in same language lets you integrate both seamlessly. In this case, because of Konstrui it is possible to extend built-in tasks or create new ones from scratch inside your project namespace and use them without any issues inside build file. Minimum you have to do is to implement `TaskInterface` and you're ready to go.

Also, keep in mind that sometimes docs can be outdated or not clear enough. In case of Konstrui, if you don't know how something works, just look at the source code. You'll be able to autocomplete task names, parameters, see their logic and it's all without any hassle in your own IDE.

Of course, feel free to use it outside of PHP world, but it's mostly suited there.

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

[](#installation)

### Composer

[](#composer)

```
composer require "konstrui/konstrui" "dev-master"

```

Usage
-----

[](#usage)

```
./vendor/bin/konstrui  [arguments]

```

### Commands

[](#commands)

Commands in Konstrui are prefixed with `--` and their list is predefined. Available commands are:

CommandDescription`--help`Will print out help information.`--list`Will print out list of all available tasks and related information (together with exact cli command to run which you can just copy paste into your terminal)`--version`Will print out version information.### Tasks

[](#tasks)

#### Build file

[](#build-file)

To use tasks, your project needs to include a `.konstrui.php`. Below you can find an example contents of such file.

```