Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/llaville/box-manifest

Creates manifests for a PHP Archive (PHAR) and the BOX project (https://github.com/box-project/box)
https://github.com/llaville/box-manifest

box-project manifest phar

Last synced: 3 months ago
JSON representation

Creates manifests for a PHP Archive (PHAR) and the BOX project (https://github.com/box-project/box)

Host: GitHub
URL: https://github.com/llaville/box-manifest
Owner: llaville
License: mit
Created: 2022-02-15T13:25:22.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-10-03T13:21:07.000Z (3 months ago)
Last Synced: 2024-10-11T01:06:18.203Z (3 months ago)
Topics: box-project, manifest, phar
Language: PHP
Homepage: https://llaville.github.io/box-manifest/4.0/
Size: 1.8 MB
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-1.x.md
- Contributing: docs/contributing.md
- License: LICENSE

Awesome Lists containing this project

README

        
# BOX Manifest

[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)

[![GitHub Discussions](https://img.shields.io/github/discussions/llaville/box-manifest)](https://github.com/llaville/box-manifest/discussions)

Main goal of this project is to write a manifest in any [PHP Archive (PHAR)][php-phar] built with the [BOX][box-project] tool.

## Features

Provides a Symfony Console Application with the binary command `box-manifest` that :

- Can generate manifest in [CycloneDX SBOM Standard][cyclonedx] format (`sbom-json` or `sbom-xml`)

- Can generate manifest in a simple key-value pairs `plain` text format (`key: value`)

- Can generate manifest in a decorated text format `console-style` or `console-table` (distinguish direct dependencies requirement and other uses)

- Can generate manifest in a custom user format

- Can generate a stub that should be able to display one or all manifests provided by the PHP Archive

- Can inspect a PHAR to find and display manifests contents

## Version Compatibility

| Version            | Status             | Box Project Compatibility | PHP      |

|--------------------|--------------------|---------------------------|----------|

| `4.0.x`            | Active development | `4.6.x`                   | `>= 8.2` |

| `3.0.x` to `3.5.x` | Active support     | `4.0.x` to `4.3.x`        | `>= 8.1` |

| `2.0.x` to `2.3.x` | End Of Life        | `4.0.x` to `4.2.x`        | `>= 8.1` |

| `1.0.x` to `1.2.0` | End Of Life        | `3.x`                     | `>= 7.4` |

## Documentation

All the documentation is available on [website][docs-website], generated from the [docs][docs-folder] folder.

## Contributors

- Laurent Laville (Lead Developer)

[php-phar]: https://www.php.net/phar

[box-project]: https://github.com/box-project/box

[cyclonedx]: https://github.com/CycloneDX

[docs-folder]: https://github.com/llaville/box-manifest/tree/4.x/docs

[docs-website]: https://llaville.github.io/box-manifest/4.0