https://github.com/php/pie

The PHP Installer for Extensions
https://github.com/php/pie

Last synced: 3 days ago
JSON representation

The PHP Installer for Extensions

• Host: GitHub
• URL: https://github.com/php/pie
• Owner: php
• License: bsd-3-clause
• Created: 2024-02-29T07:28:59.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-12-11T14:06:42.000Z (19 days ago)
• Last Synced: 2024-12-21T04:02:09.684Z (10 days ago)
• Language: PHP
• Size: 676 KB
• Stars: 837
• Watchers: 27
• Forks: 21
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Support: docs/supported-extensions.md

Awesome Lists containing this project

• awesome-php - Pie - The official PHP installer for extensions. (Table of Contents / Dependency Management)

README

        
# 🥧 PIE (PHP Installer for Extensions)

> [!WARNING]

> PIE is still in early development. We welcome you to try this out, but please

> exercise caution when using PIE, as things may go wrong! If you do encounter

> issues, please do report an issue!

You will need PHP 8.1 or newer to run PIE, but PIE can install an extension to

any installed PHP version.

If you are an extension maintainer wanting to add PIE support to your extension,

please read [extension-maintainers](./docs/extension-maintainers.md).

## Installing PIE

### Manual installation

- Download `pie.phar` either:

  - [latest stable release](https://github.com/php/pie/releases)

  - [latest unstable nightly](https://php.github.io/pie/pie-nightly.phar)

- Verify the PHAR's source with `gh attestation verify pie.phar --repo php/pie`

- You may then invoke PIE with `php pie.phar `

Further installation details can be found in the [usage](./docs/usage.md) docs.

This documentation assumes you have moved `pie.phar` into your `$PATH`, e.g.

`/usr/local/bin/pie` on non-Windows systems.

## Extensions that support PIE

A list of extensions that support PIE can be found on

[https://packagist.org/extensions](https://packagist.org/extensions).

## Installing an extension using PIE

You can install an extension using the `install` command. For example, to

install the `example_pie_extension` extension, you would run:

```shell

$ pie install example/example-pie-extension

This command may need elevated privileges, and may prompt you for your password.

You are running PHP 8.3.10

Target PHP installation: 8.3.10 nts, on Linux/OSX/etc x86_64 (from /usr/bin/php8.3)

Found package: example/example-pie-extension:1.0.1 which provides ext-example_pie_extension

phpize complete.

Configure complete.

Build complete: /tmp/pie_downloader_66e0b1de73cdb6.04069773/example-example-pie-extension-769f906/modules/example_pie_extension.so

Install complete: /usr/lib/php/20230831/example_pie_extension.so

You must now add "extension=example_pie_extension" to your php.ini

$

```

## More documentation...

The full documentation for PIE can be found in [usage](./docs/usage.md) docs.