PHPackages                             benconstable/quick-configure - 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 & Serialization](/categories/parsing)
4. /
5. benconstable/quick-configure

AbandonedArchivedLibrary[Parsing & Serialization](/categories/parsing)

benconstable/quick-configure
============================

Simple configuration generator for PHP projects

v0.1.0(12y ago)213MITPHPPHP >=5.3.0

Since Feb 17Pushed 12y ago1 watchersCompare

[ Source](https://github.com/BenConstable/quick-configure)[ Packagist](https://packagist.org/packages/benconstable/quick-configure)[ Docs](http://github.com/BenConstable/quick-configure)[ RSS](/packages/benconstable-quick-configure/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (4)Versions (2)Used By (0)

\#QuickConfigure

[![Build Status](https://camo.githubusercontent.com/2ce5176e0057b251738a2fbfefb60a8afd671f1be66f5288451b295944931ab7/68747470733a2f2f7472617669732d63692e6f72672f42656e436f6e737461626c652f717569636b2d636f6e6669677572652e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/BenConstable/quick-configure)[![Latest Stable Version](https://camo.githubusercontent.com/7fdd631dd6bc3e6c8c5901fa8a020f842add06290565925fdddc30f284bb80bf/68747470733a2f2f706f7365722e707567782e6f72672f62656e636f6e737461626c652f717569636b2d636f6e6669677572652f762f737461626c652e706e67)](https://packagist.org/packages/benconstable/quick-configure)[![Latest Unstable Version](https://camo.githubusercontent.com/2684c78b4d4a0f20d1bde43fbd9b3fc55906f3f255942d7c7e9357358b660eb2/68747470733a2f2f706f7365722e707567782e6f72672f62656e636f6e737461626c652f717569636b2d636f6e6669677572652f762f756e737461626c652e706e67)](https://packagist.org/packages/benconstable/quick-configure)[![Dependency Status](https://camo.githubusercontent.com/d14b207a1f800823f1685faec04b13b680c00a7eecbb590e612270d343fc1807/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f757365722f70726f6a656374732f3533303630616337656331333735613765653030303137622f62616467652e706e67)](https://www.versioneye.com/user/projects/53060ac7ec1375a7ee00017b)

QuickConfigure makes the tedious process of setting configuration options in your builds quick and easy (for you and the people using your code!).

\##Why?

Often frameworks or libraries require you to specify some basic config to get started. This could be setting database details for example, or setting the base URL for an application.

Usually, this involves either modifying a config file that's under version control or manually creating a file (like [Laravel's .env files](http://laravel.com/docs/configuration#protecting-sensitive-configuration)). This is slow and unweildy, and makes automating builds difficult.

QuickConfigure allows you to specify a simple JSON schema from which required config can be generated. No manually creating config files, no dirty work tree, and a simple script that can be incorporated into your build process. Easy!

\##Installation

QuickConfigure is installed via [Composer](http://getcomposer.org):

```
{
    "require": {
        "benconstable/quick-configure": "~0.1"
    }
}
```

\##Basic usage

\###quick-configure.json

QuickConfigure generates config from a `quick-configure.json` file. This file has the format:

```
{
    "field": {
        "description": "This field is important, please set it"
    },

    "other_field": {
        "description": "We need this to be configured, too"
    }
}
```

Each listed field will be configured and accessible in your app.

\###Generating config

Generating config is done via the `configure` command. Just run:

```
$ vendor/bin/quick-configure configure
```

That's it!

\###Using config

QuickConfigure provides a simple API for accessing generated config in your application:

```