Roadrunner Cli Laravel Package

Getting Started

Start by installing the CLI globally or per-project via Composer: composer require --dev spiral/roadrunner-cli. After installation, run rr list to see available commands. The first common use case is initializing RoadRunner for a new project: rr init generates a basic .rr.yaml config and downloads the appropriate binary. This gives you a working server setup in seconds—ideal for standing up a development environment or scaffolding a new microservice.

Implementation Patterns

• Development Workflow: Use rr serve to run RoadRunner in foreground with auto-reload (via rr worker or rr serve -w depending on config) during local development. Pair with rr worker to run long-running workers (e.g., for queues or events) alongside the HTTP server.
• CI/CD Automation: Integrate rr download, rr version, and rr check into pre-deploy scripts to validate environment readiness. rr stop and rr start let you script controlled server restarts without shell-dependent kill/nohup gymnastics.
• Multi-Config Management: Maintain environment-specific configs (e.g., .rr.local.yaml, .rr.prod.yaml) and switch contexts with rr serve -c .rr.local.yaml. The CLI automatically falls back to rr.yaml, .rr.yaml, or config/.rr.yaml if -c is omitted—no hardcoded paths needed.
• Health Checks & Diagnostics: Include rr status and rr diagnostics in monitoring scripts to verify server state or troubleshoot worker failures.

Gotchas and Tips

• Binary caching: RoadRunner binaries are stored in ~/.rr/bin/ by default. If network access is restricted (e.g., CI), use rr download -o ./bin/rr to stage binaries locally and commit them or cache them.
• Config precedence: CLI flags (e.g., -c, -o, -w) override config values at runtime, but don’t modify the config file. Don’t expect persistent changes—use rr init -c .rr.prod.yaml to bootstrap config, not rr serve -c .rr.prod.yaml for ad hoc tweaks.
• Worker restart behavior: rr serve -w watches files for changes, but ignores vendor/ and hidden files unless explicitly overridden via watch config or --watch flag with comma-separated paths.
• Permission issues: On Unix systems, if rr serve fails silently, ensure the binary is executable (chmod +x ~/.rr/bin/rr-*) and that your PHP CLI has network access for initial binary download.
• Extensibility: While minimal, the CLI supports plugin-style commands via rr plugin add <vendor>/rr-<name>. Check for community plugins (e.g., rr-laravel, rr-symfony) that extend rr with framework-specific diagnostics or bootstrap helpers.