spiral / roadrunner-cli

v2.7.2 2025-12-14 19:18 UTC

Requires

• php: >=8.1
• ext-json: *
• composer/semver: ^3.4
• spiral/roadrunner-worker: ^2 || ^3
• spiral/tokenizer: ^2.13 || ^3.15
• symfony/console: ^5.3 || ^6.0 || ^7.0 || ^8.0
• symfony/http-client: ^4.4.51 || ^5.4.49 || ^6.4.17 || ^7.2 || ^8.0
• symfony/yaml: ^5.4.49 || ^6.4.17 || ^7.2 || ^8.0

Requires (Dev)

• jetbrains/phpstorm-attributes: ^1.2
• spiral/code-style: ^2.2.2
• spiral/dumper: ^3.3
• vimeo/psalm: ^6.0

MIT

• Anton Titov (wolfy-j)
• RoadRunner Community

Published on Packagist.org on 2025-12-14 19:20 UTC

README

Command line tool to install RoadRunner binaries and generate configs

This package provides the rr console command for PHP projects that run on RoadRunner: it downloads the RoadRunner server binary and protoc-gen-php-grpc plugin built for your environment and generates a starter .rr.yaml configuration.

Note

Version 3.x of roadrunner/cli targets RoadRunner v3: rr get downloads RoadRunner 3 by default. For RoadRunner 2025.x, use spiral/roadrunner-cli 2.x.

Get Started

Installation

composer require roadrunner/cli

Getting the RoadRunner binary

Download the latest RoadRunner binary for your operating system and architecture into the project root, along with an example .rr.yaml:

vendor/bin/rr get-binary

Then start the server:

./rr serve

See the RoadRunner documentation for the configuration reference.

Commands

• get-binary (or get) - allows to install the latest version of the RoadRunner compatible with your environment (operating system, processor architecture, runtime, etc...). Also, this command creates an example .rr.yaml configuration file. If the command is used without the plugin and preset options, a configuration with the default plugins (rpc, server, http, jobs, kv, metrics) is created. Using the plugin option (shortcut p) can create an example configuration file with only plugins needed. For example, with http plugin only: get-binary -p http, http and jobs: get-binary -p http -p jobs. Available plugins: amqp, beanstalk, boltdb, broadcast, endure, fileserver, grpc, http, jobs, kv, logs, metrics, nats, otel, redis, reload, rpc, server, service, sqs, status, tcp, temporal, websockets. Using the preset option can create an example configuration file with popular plugins for different typical tasks. For example, with web preset: get-binary --preset web. Available presets: web (contains plugins http, jobs). Use --no-config to skip the configuration file.
• make-config - creates the .rr.yaml configuration file without downloading the binary. Accepts the same plugin and preset options.
• download-protoc-binary - allows to install the latest version of the protoc-gen-php-grpc file compatible with your environment (operating system, processor architecture, runtime, etc...).
• versions - displays a list of available RoadRunner binary versions.

Common options

The binary commands accept --filter (-f, version constraint), --stability (-s), --os (-o), --arch (-a) and --location (-l, target directory) options. Releases are fetched from the GitHub API; set the GITHUB_TOKEN environment variable to avoid its rate limits, and RR_GITHUB_API_URL to use another API endpoint (GitHub Enterprise, a mirror; defaults to https://api.github.com).