PHPackages                             magebit/module-magento2-configurator - 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 &amp; Helpers](/categories/utility)
4. /
5. magebit/module-magento2-configurator

ActiveMagento2-module[Utility &amp; Helpers](/categories/utility)

magebit/module-magento2-configurator
====================================

Keep magento persistently configured using files

049.1k↓42.7%1[3 issues](https://github.com/magebitcom/magento2-configurator/issues)[1 PRs](https://github.com/magebitcom/magento2-configurator/pulls)PHP

Since May 30Pushed todayCompare

[ Source](https://github.com/magebitcom/magento2-configurator)[ Packagist](https://packagist.org/packages/magebit/module-magento2-configurator)[ RSS](/packages/magebit-module-magento2-configurator/feed)WikiDiscussions magebit Synced 1w ago

READMEChangelog (5)DependenciesVersions (20)Used By (0)

Magento 2 Configurator (Magebit version)
========================================

[](#magento-2-configurator-magebit-version)

[![Build Status](https://camo.githubusercontent.com/3dcbc92839808407520e174cb0fd719cb93ed8812399f397bb4cb8d2eed41e2a/68747470733a2f2f7472617669732d63692e6f72672f6374696469676974616c2f6d6167656e746f322d636f6e666967757261746f722e7376673f6272616e63683d646576656c6f70)](https://travis-ci.org/ctidigital/magento2-configurator)

A Magento module initially created by [CTI Digital](http://www.ctidigital.com/) to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow:

- Install Magento from scratch with important database based configuration ready.
- Share and collaborate configuration with other colleagues using your own versioning system.
- Keep versions of your configurations using your own versioning system.
- Split your configuration based on the environment you're developing on.

Adjustments by Magebit

- Create/Maintain mode functionality
    - Currently support these components
        - Category
        - CMS Pages/Blocks
        - Configuration
- Better templating system for CMS content to allow for phtml files
- Adds version control for Create mode (Usage info: )
    - Currently supports these components
        - CMS Pages/Blocks

If you're interested to find out more about the background of the configurator, watch this lightning talk by [Raj Chevli](https://twitter.com/chevli) at Mage Titans in Manchester on [YouTube](https://www.youtube.com/watch?v=iFkhAzJl2k0).

This is a work in progress and by no means for use with production environments (and probably not even development environments either just yet).

Testing Locally For Development
-------------------------------

[](#testing-locally-for-development)

If you are contributing the module, please run the following commands to stand the best chance with Travis CI liking your code. These test include PHP Code Sniffer, PHP Mess Detector, PHP Copy and Paste Detector, PHP Unit

```
php vendor/bin/phpcs --standard=vendor/magento/magento-coding-standard/Magento2/ruleset.xml vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console/ vendor/ctidigital/magento2-configurator/Test/ vendor/ctidigital/magento2-configurator/Api/ vendor/ctidigital/magento2-configurator/Component/ vendor/ctidigital/magento2-configurator/Exception/
php vendor/bin/phpmd vendor/ctidigital/magento2-configurator/Model/,vendor/ctidigital/magento2-configurator/Console/,vendor/ctidigital/magento2-configurator/Test/,vendor/ctidigital/magento2-configurator/Api/,vendor/ctidigital/magento2-configurator/Component/,vendor/ctidigital/magento2-configurator/Exception/ text cleancode,codesize,controversial,design,naming,unusedcode
php vendor/bin/phpcpd vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console vendor/ctidigital/magento2-configurator/Test/ vendor/ctidigital/magento2-configurator/Api/ vendor/ctidigital/magento2-configurator/Component/ vendor/ctidigital/magento2-configurator/Exception/
php vendor/bin/phpunit vendor/ctidigital/magento2-configurator/Test/Unit/

```

Known issues
------------

[](#known-issues)

- [Media copy error if destination folder does not exists](https://github.com/magebitcom/magento2-configurator/issues/14)

Integration tests
-----------------

[](#integration-tests)

- Configure your [Magento integration test environment](http://devdocs.magento.com/guides/v2.0/test/integration/integration_test_setup.html).
- Add the XML below to dev/tests/integration/phpunit.xml.dist

```

    ../../../vendor/ctidigital/magento2-configurator/Test/Integration

```

- You can run the tests from the correct place on the command line

```
/dev/tests/integration$ ../../../vendor/bin/phpunit --testsuite "magento2-configurator"

```

- You can also add the magento PHP developer tools to your path, so that you do not have to specify location of phpunit

```
export PATH=$PATH:/var/www/magento2/vendor/bin

```

Unit tests
----------

[](#unit-tests)

If you're developing a new component, please ensure you have your corresponding unit test which extends `ComponentAbstractTestCase` as that will test that your component has the required functions. Do also include sample files with your component that works

Travis
------

[](#travis)

We also use Travis CI to automate part of the testing process (we are still looking to add more to this!). It tests the following:

- CodeSniffer
- MessDetector
- Copy &amp; Paste Detection
- Unit Tests
- Run Configurator (we aim to run it on these versions)
    1. Latest 3 minor versions
    2. Latest release candidate (allowed to fail)

Getting Started
---------------

[](#getting-started)

1. Create a `master.yaml` file in `/app/etc/`. (see `Samples/master.yaml`)
2. Enable Modules `CtiDigital_Configurator`,`FireGento_FastSimpleImport`.
3. Run `bin/magento configurator:run --env=""`

### Usage

[](#usage)

- Listing available components `bin/magento configurator:list`
- Running individual components `bin/magento configurator:run --env="" --component="config"`
- Extra logs `bin/magento configurator:run --env="" -v`

Roadmap for components to do
----------------------------

[](#roadmap-for-components-to-do)

ComponentCode WrittenTests WrittenSample FilesWebsites✅❕✅System Configuration✅❕✅Categories✅❕✅Products✅❕✅Attributes✅❕✅Attribute Sets✅❕✅Blocks✅❕✅Admin Roles✅❕✅Admin Users✅❕✅Pages✅❕✅Widgets✅❕✅Customer Groups✅❕✅Media✅❕✅Tax Rules✅❕✅API Integrations✅❕✅Tax Rates✅❕✅Rewrites✅✅✅Review Ratings✅✅✅Related Products✅❕✅Up Sell Products✅❕✅Cross Sell Products✅❕✅Customers✅✅✅SQL✅✅✅Catalog Price Rules✅❌✅Shipping Table Rates✅✅✅Customer Attributes✅❌✅Shopping Cart Price Rules❌❌❌Orders❌❌❌Tiered Prices❌❌❌License
-------

[](#license)

MIT

###  Health Score

40

—

FairBetter than 86% of packages

Maintenance65

Regular maintenance activity

Popularity30

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor2

2 contributors hold 50%+ of commits

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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/10514036?v=4)[magebit](/maintainers/magebit)[@Magebit](https://github.com/Magebit)

---

Top Contributors

[![chevli](https://avatars.githubusercontent.com/u/7550729?v=4)](https://github.com/chevli "chevli (333 commits)")[![paulpartington-cti](https://avatars.githubusercontent.com/u/6105453?v=4)](https://github.com/paulpartington-cti "paulpartington-cti (193 commits)")[![EmilsM](https://avatars.githubusercontent.com/u/1344881?v=4)](https://github.com/EmilsM "EmilsM (62 commits)")[![zxon](https://avatars.githubusercontent.com/u/914678?v=4)](https://github.com/zxon "zxon (32 commits)")[![chrisgan](https://avatars.githubusercontent.com/u/2246778?v=4)](https://github.com/chrisgan "chrisgan (25 commits)")[![furan917](https://avatars.githubusercontent.com/u/15950274?v=4)](https://github.com/furan917 "furan917 (24 commits)")[![aigarsbedeicis](https://avatars.githubusercontent.com/u/66061020?v=4)](https://github.com/aigarsbedeicis "aigarsbedeicis (20 commits)")[![rick-cti](https://avatars.githubusercontent.com/u/6051210?v=4)](https://github.com/rick-cti "rick-cti (7 commits)")[![bartoszherba](https://avatars.githubusercontent.com/u/16045377?v=4)](https://github.com/bartoszherba "bartoszherba (6 commits)")[![herveatcti](https://avatars.githubusercontent.com/u/143798395?v=4)](https://github.com/herveatcti "herveatcti (5 commits)")[![marcis-mb](https://avatars.githubusercontent.com/u/82810886?v=4)](https://github.com/marcis-mb "marcis-mb (4 commits)")[![matthewhaworth](https://avatars.githubusercontent.com/u/920191?v=4)](https://github.com/matthewhaworth "matthewhaworth (4 commits)")[![suresh-cti](https://avatars.githubusercontent.com/u/81560393?v=4)](https://github.com/suresh-cti "suresh-cti (3 commits)")[![SergejsMkrvs](https://avatars.githubusercontent.com/u/178777210?v=4)](https://github.com/SergejsMkrvs "SergejsMkrvs (3 commits)")[![NathanDayFE](https://avatars.githubusercontent.com/u/68845089?v=4)](https://github.com/NathanDayFE "NathanDayFE (3 commits)")[![informaniac](https://avatars.githubusercontent.com/u/9445834?v=4)](https://github.com/informaniac "informaniac (3 commits)")[![Scarraban](https://avatars.githubusercontent.com/u/3777938?v=4)](https://github.com/Scarraban "Scarraban (3 commits)")[![r-stanley](https://avatars.githubusercontent.com/u/7629178?v=4)](https://github.com/r-stanley "r-stanley (3 commits)")[![julienanquetil](https://avatars.githubusercontent.com/u/1108170?v=4)](https://github.com/julienanquetil "julienanquetil (2 commits)")[![franckcharpentier](https://avatars.githubusercontent.com/u/11445024?v=4)](https://github.com/franckcharpentier "franckcharpentier (2 commits)")

### Embed Badge

![Health badge](/badges/magebit-module-magento2-configurator/health.svg)

```
[![Health](https://phpackages.com/badges/magebit-module-magento2-configurator/health.svg)](https://phpackages.com/packages/magebit-module-magento2-configurator)
```

###  Alternatives

[camspiers/porter-stemmer

Porter Stemmer created by Richard Heyes

14459.7k4](/packages/camspiers-porter-stemmer)[nuxtifyts/dash-stack-theme

DashStack theme for filament php

1915.4k](/packages/nuxtifyts-dash-stack-theme)

PHPackages © 2026

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