valkyrja / sindri
The Valkyrja Sindri build tool.
Requires
- php: >=8.4
- nikic/php-parser: ^5.7.0
- valkyrja/valkyrja: 26.x-dev
This package is auto-updated.
Last update: 2026-04-17 01:01:21 UTC
README
Sindri
Sindri is the build tool for the Valkyrja PHP framework for web and console applications.
About Valkyrja
This repository contains the core code of the Valkyrja Sindri build tool.
Sindri is the dwarf in Norse Mythology who is responsible for crafting magical items and tools for the gods. In a similar sense, the Sindri build tool crafts your application and builds out data cache files for your application to run even faster.
Build Status
| Linting |
|
|
| Coding Rules |
|
|
| Static Analysis |
|
|
| Testing |
|
Documentation
The Sindri documentation is baked into the repo so you can access it even when working offline.
Installation
There are two ways to install the Sindri build tool.
Composer
You can either choose to install via composer as a dependency to a new or existing project.
Run the command below to require Sindri in your existing composer json:
composer require valkyrja/sindri
You can even add Sindri to a completely empty project and allow it to generate the base files for your project and give you a head start.
Phar
Versioning and Release Process
Sindri uses semantic versioning with a major release every year, and support for each major version for 2 years from the date of release.
For more information view our Versioning and Release Process documentation.
Supported Versions
Bug fixes will be provided until 3 months after the next major release. Security fixes will be provided for 2 years after the initial release.
| Version | PHP (*) | Release | Bug Fixes Until | Security Fixes Until |
|---|---|---|---|---|
| 26 | 8.4 - 8.6 | March 31, 2026 | Q2 2027 | Q1 2028 |
| 27 | 8.5 - 8.6 | Q1 2027 | Q2 2028 | Q1 2029 |
| 28 | 8.6+ | Q1 2028 | Q2 2029 | Q1 2030 |
(*) Supported PHP versions (**) Pre-release that is not supported once v26 is released
Contributing
Sindri is an Open Source, community-driven project.
Thank you for your interest in helping us develop, maintain, and release the Sindri build tool!
You can find more information in our Contributing documentation.
Security Issues
If you discover a security vulnerability within Sindri, please follow our disclosure procedure.
License
The Sindri build tool is open-sourced software licensed under the MIT license. You can view the Valkyrja License here.