PeachPie Compiler

The open-source PHP compiler to .NET

PeachPie is a member project of the .NET Foundation.

Continuous Integration

Service	Platform	Build Status
AppVeyor	Visual Studio 2019
Azure DevOps	Windows
GitHub Actions	Ubuntu 18

What is PeachPie?

PeachPie is a modern PHP compiler based on the Microsoft Roslyn compiler platform. It allows PHP to be compiled and executed under the .NET runtime, thereby opening the door for PHP developers into the world of .NET – and vice versa.

Project goals

• Both-way interoperability: the project allows for hybrid applications, where parts are written in C# and others in PHP. The parts will be entirely compatible and can communicate seamlessly, all within the .NET framework.

• Full .NET compatibility: compiled programs run on the reimplemented PeachPie runtime, fully compatibly with the PHP runtime.

• Security: since programs run within the standardized and manageable .NET or .NET Core environment, the code is fully verifiable without any unsafe constructs. In addition, PHP applications can be distributed source-lessly for added security benefits.

• Cross-platform development: the project compiles legacy PHP code into portable class libraries, enabling developers to build cross-platform apps and libraries for Microsoft platforms.

• Increased performance: PeachPie's extensive type analysis and the influence of Microsoft Roslyn should provide an improved performance of PHP applications and components.

How to use PeachPie

There are currently two ways of using PeachPie via dotnet: in your favorite shell or comfortably in Visual Studio using our official extension.

IDEs

You can comfortably work with PeachPie in your favorite IDEs. Download our official Visual Studio extension, which makes working with PeachPie compiler as convenient as possible. The extension allows you to easily create a new project using our templates, build & debug, profile your PHP code using the VS diagnostic tools and deploy your project to Azure:

You can also use VS Code or Rider to build and debug PeachPie projects.

Command line building

Alternatively, you can also work with PeachPie on the command line. Please refer to our short introduction video to see how to run the compiler on the command line and to the Getting Started section in our documentation.

Nightly builds

The most convenient way of using PeachPie is to consume NuGet packages. We provide nightly builds and release builds to our subscribers on Patreon. Become a Patron to get access and get listed as our sponsor!

Status and Compatibility

You can find an up-to-date status of the project in our Roadmap section. Please note that the status is dynamic; PeachPie is a work in progress, which means that the list of finished and planned features frequently changes and will be updated on a regular basis. To see the current status of compatibility with the PHP language, please refer to our Compatibility overview.

How to contribute?

PeachPie is an open source project we maintain in our spare time. We can use all the help we can get. If you believe you have valuable knowledge and expertise to add to this project, please do not hesitate to contribute to our repo via pull requests or issues – your help is much appreciated.

However, please read the Contribution Guidelines first and ensure you are following them. Also, we kindly ask you to respect our Code of Conduct when posting or interacting with other users.

You can also support the project on Patreon, which gives you access to all kinds of perks!

Providing feedback

If you found a bug, have a question or if you have an improvement suggestion, the easiest way of providing feedback is to ask on Discord or submit an issue here on GitHub. We try to respond as quickly as possible.

.NET Foundation

This project is supported by the .NET Foundation.