PHPackages                             spryker-sdk/spryk - 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. spryker-sdk/spryk

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

spryker-sdk/spryk
=================

Spryk module

0.7.1(7mo ago)42.4M↓16.5%10[4 PRs](https://github.com/spryker-sdk/spryk/pulls)7proprietaryPHPPHP &gt;=8.3CI passing

Since Feb 18Pushed 7mo ago16 watchersCompare

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

READMEChangelog (10)DependenciesVersions (38)Used By (7)

Spryk Module
============

[](#spryk-module)

[![CI](https://github.com/spryker-sdk/spryk/workflows/CI/badge.svg?branch=master)](https://github.com/spryker-sdk/spryk/actions?query=workflow%3ACI+branch%3Amaster)[![Latest Stable Version](https://camo.githubusercontent.com/9665c44401c8c425daf3e816852b4540b83286ebc9d30c5656677595c834246f/68747470733a2f2f706f7365722e707567782e6f72672f737072796b65722d73646b2f737072796b2f762f737461626c652e737667)](https://packagist.org/packages/spryker-sdk/spryk)[![Minimum PHP Version](https://camo.githubusercontent.com/9c50dc780fa576f5c39b4feff00c05345c1471be0808881a09e750b91220dc54/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230382e332d3838393242462e737667)](https://php.net/)[![PHPStan](https://camo.githubusercontent.com/441b5874ce4df0a2defc892979c96c46889b69cb32119d04f0b48626349f8bc9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d656e61626c65642d627269676874677265656e2e7376673f7374796c653d666c6174)](https://github.com/phpstan/phpstan)

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

[](#installation)

```
composer require --dev spryker-sdk/spryk

```

This is a development only "require-dev" module. Please make sure you include it as such.

What are Spryks?
================

[](#what-are-spryks)

Spryks are some sort of code generators for Spryker. Writing code is often a very repetitive task and you often need to write a lot code just to follow Spryker's clean and complex architecture. To take a way the monkey work from writing wir up code and move faster towards writing business code Spryks are born.

Spryks are written with the help of yml files. The filename of the yml file represents also the Spryk name. In most cases the Spryk yml contains arguments which are needed to fullfill the Spryk build run. Almost all Spryks need the module name to run properly. Some Spryks require much more arguments.

The vast majority of the Spryks need to execute other Spryks before the called Spryk can run. For example Add a Zed Business Facade needs to have a properly created module before the Facade itself can be created. Therefore Spryks have pre and post Spryks and with the call of one Spryk many things can and will be created for you.

How to use Spryks?
==================

[](#how-to-use-spryks)

- `vendor/bin/spryk-run` - Runs Spryks in your project
- `vendor/bin/spryk-dump` - Lists all available Spryks
- `vendor/bin/spryk-build` - Builds a cache file for all Spryk arguments

Examples:

1. To get a list of top level spryks run `vendor/bin/spryk-dump`.
2. To get a list of all available spryks run `vendor/bin/spryk-dump --level=all`.
3. To get a list of all options available for a specific spryk run `vendor/bin/spryk-dump {SPRYK NAME}`.
4. To execute one Spryk run `vendor/bin/spryk-run {SPRYK NAME}`.
5. To reflect changes in Spryk arguments and generate a new cache for them run `vendor/bin/spryk-build`.

When you run a Spryk, the console will ask you for all needed arguments to build the Spryk. You also have the ability to pass all known arguments on the console by using `--{argument name}={argument value}`.

Extending Spryk
===============

[](#extending-spryk)

Adding Spryks
-------------

[](#adding-spryks)

You can add your own Spryks by creating a Spryk definition in your projects `config/spryk/spryks/` directory.

Spryk definitions in this directory will be found by the tool and can be executed as usually.

Adding Spryk templates
----------------------

[](#adding-spryk-templates)

You can add your own Spryk templates by creating a template in your projects `config/spryk/templates/` directory.

Spryk templates in this directory will be found by the tool and can be used in your Spryks.

Configuration
=============

[](#configuration)

Spryks need some project related configurations. These are passed automatically to the tool.

The following configurations will be passed to the Spryk tool:

- `Spryker\Shared\Kernel\KernelConstants::PROJECT_NAMESPACE`
- `Spryker\Shared\Kernel\KernelConstants::PROJECT_NAMESPACES`
- `Spryker\Shared\Kernel\KernelConstants::CORE_NAMESPACES`

###  Health Score

58

—

FairBetter than 98% of packages

Maintenance63

Regular maintenance activity

Popularity47

Moderate usage in the ecosystem

Community34

Small or concentrated contributor base

Maturity77

Established project with proven stability

 Bus Factor3

3 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.

###  Release Activity

Cadence

Every ~78 days

Recently: every ~198 days

Total

32

Last Release

228d ago

PHP version history (8 changes)0.1.0PHP &gt;=7.1

0.2.4PHP &gt;=7.2

0.2.9PHP &gt;=7.3

0.3.2PHP &gt;=7.4

0.5.0PHP &gt;=8.0

0.6.0PHP &gt;=8.1

0.7.0PHP &gt;=8.2

0.7.1PHP &gt;=8.3

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/10738957?v=4)[Spryker Bot](/maintainers/spryker-bot)[@spryker-bot](https://github.com/spryker-bot)

---

Top Contributors

[![stereomon](https://avatars.githubusercontent.com/u/1382877?v=4)](https://github.com/stereomon "stereomon (228 commits)")[![dereuromark](https://avatars.githubusercontent.com/u/39854?v=4)](https://github.com/dereuromark "dereuromark (111 commits)")[![zyuzka](https://avatars.githubusercontent.com/u/12764988?v=4)](https://github.com/zyuzka "zyuzka (97 commits)")[![limeeugenia](https://avatars.githubusercontent.com/u/25685017?v=4)](https://github.com/limeeugenia "limeeugenia (82 commits)")[![AsonUnique](https://avatars.githubusercontent.com/u/20453760?v=4)](https://github.com/AsonUnique "AsonUnique (46 commits)")[![olhalivitchuk](https://avatars.githubusercontent.com/u/77281282?v=4)](https://github.com/olhalivitchuk "olhalivitchuk (28 commits)")[![m7moud](https://avatars.githubusercontent.com/u/3217954?v=4)](https://github.com/m7moud "m7moud (16 commits)")[![gechetspr](https://avatars.githubusercontent.com/u/42143273?v=4)](https://github.com/gechetspr "gechetspr (12 commits)")[![asmarovydlo](https://avatars.githubusercontent.com/u/15832795?v=4)](https://github.com/asmarovydlo "asmarovydlo (11 commits)")[![Nidhognit](https://avatars.githubusercontent.com/u/13098647?v=4)](https://github.com/Nidhognit "Nidhognit (10 commits)")[![spryker-bot](https://avatars.githubusercontent.com/u/10738957?v=4)](https://github.com/spryker-bot "spryker-bot (6 commits)")[![vlunov-spryker](https://avatars.githubusercontent.com/u/17848943?v=4)](https://github.com/vlunov-spryker "vlunov-spryker (5 commits)")[![spryker-release-bot](https://avatars.githubusercontent.com/u/26904324?v=4)](https://github.com/spryker-release-bot "spryker-release-bot (5 commits)")[![pushokwhite](https://avatars.githubusercontent.com/u/4017411?v=4)](https://github.com/pushokwhite "pushokwhite (4 commits)")[![romanhavrylko](https://avatars.githubusercontent.com/u/70894038?v=4)](https://github.com/romanhavrylko "romanhavrylko (4 commits)")[![newLoki](https://avatars.githubusercontent.com/u/461574?v=4)](https://github.com/newLoki "newLoki (4 commits)")[![a-sabaa](https://avatars.githubusercontent.com/u/1667759?v=4)](https://github.com/a-sabaa "a-sabaa (4 commits)")[![yaroslav-spryker](https://avatars.githubusercontent.com/u/80392698?v=4)](https://github.com/yaroslav-spryker "yaroslav-spryker (3 commits)")[![vol4onok](https://avatars.githubusercontent.com/u/5063777?v=4)](https://github.com/vol4onok "vol4onok (3 commits)")[![Kyrylo-Meretskyi](https://avatars.githubusercontent.com/u/86324025?v=4)](https://github.com/Kyrylo-Meretskyi "Kyrylo-Meretskyi (2 commits)")

### Embed Badge

![Health badge](/badges/spryker-sdk-spryk/health.svg)

```
[![Health](https://phpackages.com/badges/spryker-sdk-spryk/health.svg)](https://phpackages.com/packages/spryker-sdk-spryk)
```

PHPackages © 2026

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