PHPackages                             apparat/artefakt - 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. apparat/artefakt

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

apparat/artefakt
================

Artefakt Pattern Library Tool Base Distribution

022

Since Jun 24Pushed 7y ago1 watchersCompare

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

READMEChangelogDependenciesVersions (1)Used By (0)

Artefakt Pattern Library Tool
=============================

[](#artefakt-pattern-library-tool)

Prerequisites
-------------

[](#prerequisites)

- [PHP 7.2+](https://php.net)
- [Composer](http://getcomposer.org/) (PHP dependency manager)

I recommend using the latest available version of PHP as a matter of principle.

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

[](#installation)

Start a new Artefakt Pattern Library by running this on a command prompt (requires [Composer](http://getcomposer.org/) to be available as `composer`):

```
composer create-project --prefer-dist apparat/artefakt
cd
```

Please make sure to replace `` with the path and name of your project.

### Custom directories

[](#custom-directories)

If you want Artefakt to use other directories than the default ones, create a custom `composer.json` in your installation directory:

```
mkdir
cd
composer init

```

Edit your `composer.json` to specify one or more custom directories like this:

```
{
    "name": "your/project",
    "require": {
        "apparat/artefakt": "dev-master"
    },
    "extra": {
        "apparat/artefakt": {
            "components": "cpms", // Component data directory
            "documents": "docs", // Document data directory
            "cache": "/tmp/artefakt" // Cache directory
        }
    }
}
```

Relative paths are resolved against the installation directory (the directory where the `composer.json` resides). Finish the installation with:

```
composer install
vendor/bin/artefakt app:init

```

Dependencies
------------

[](#dependencies)

[![Composer dependency graph](https://camo.githubusercontent.com/2bb57fd7192c633caf6c8f2f05b5edae202a4b85772def29957143334f7fc68b/68747470733a2f2f7261776769742e636f6d2f617070617261742f6172746566616b742f6d61737465722f646f632f646570656e64656e636965732e737667)](https://camo.githubusercontent.com/2bb57fd7192c633caf6c8f2f05b5edae202a4b85772def29957143334f7fc68b/68747470733a2f2f7261776769742e636f6d2f617070617261742f6172746566616b742f6d61737465722f646f632f646570656e64656e636965732e737667)

Quality
-------

[](#quality)

The Artefakt set of libraries attempt to comply with [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md), [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md), and [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md). If you notice compliance oversights, please send a patch for the respective library via pull request.

Contributing
------------

[](#contributing)

Found a bug or have a feature request? [Please have a look at the known issues](https://github.com/apparat/artefakt/issues) first and open a new issue if necessary. Please see [contributing](CONTRIBUTING.md) and [conduct](CONDUCT.md) for details.

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Joschi Kuphal](https://jkphl.is)
- [All Contributors](../../contributors)

License
-------

[](#license)

Copyright © 2018 [Joschi Kuphal](https://jkphl.is) / . Licensed under the terms of the [MIT license](LICENSE).

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/9654aeebce6e58572ec7ee6e8b30a2f8f41a54a3c7a9580d1df090996f5cfdbb?d=identicon)[jkphl](/maintainers/jkphl)

---

Top Contributors

[![jkphl](https://avatars.githubusercontent.com/u/4446936?v=4)](https://github.com/jkphl "jkphl (14 commits)")

### Embed Badge

![Health badge](/badges/apparat-artefakt/health.svg)

```
[![Health](https://phpackages.com/badges/apparat-artefakt/health.svg)](https://phpackages.com/packages/apparat-artefakt)
```

PHPackages © 2026

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