octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"> TwirPHP

PHP port of Twitch's Twirp RPC framework

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Installation

Download prebuilt binaries for the protoc plugin from the releases page.

Alternatively, you can use the following oneliner to install the plugin:

curl -Ls https://git.io/twirphp | bash -s -- -b path/to/bin

See the documentation for details.

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Documentation

See the official documentation.

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Development

For an optimal developer experience, it is recommended to install Nix and direnv.

Alternatively, install Go, PHP and Composer on your computer then run make deps to install the rest of the dependencies.

Install dependencies:

go mod download
composer install

If you change something in the protoc plugin, regenerate the examples:

make generate

When all coding and testing is done, please run the test suite:

make check

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">Security

If you discover any security related issues, please contact us at [email protected].

octicon-link" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true">License

The project is licensed under the MIT License.

The original Twirp library is licensed under the Apache 2.0 License.

OPEN ISSUES

RELEASES