Weave Code
Shell Laravel Package
php-standard-library/shell
Safely run shell commands from PHP with automatic argument escaping and full control over error output. Part of the PHP Standard Library, it offers a clean, predictable API for executing processes while keeping your application secure from injection risks.
Shell command execution with argument escaping and error output management
Frequently asked questions about Shell
- How do I install php-standard-library/shell in a Laravel application?
- Install it with Composer using composer require php-standard-library/shell. It is framework-agnostic, so no Laravel service provider is required; you can instantiate or inject its command runner in your services and console commands. After installation, wrap shell calls in a small Laravel service to keep escaping and error handling consistent.
- Does php-standard-library/shell work with Laravel queues?
- Yes, you can call it inside queued jobs, but the package itself is synchronous. For parallel or background shell work in Laravel, wrap the command in a job and dispatch that job to a queue such as Redis or SQS. Keep streaming output out of long-running queue workers or buffer chunks to Redis, a database, or logs to avoid worker memory issues.
- How does php-standard-library/shell prevent shell command injection?
- It provides argument escaping so you can pass command arguments separately instead of interpolating user input into a single command string. Always pass untrusted values as arguments and never allow user input to choose the executable or bypass validation. Escaping reduces risk but does not replace allowlists and input validation for sensitive commands.
- Which Laravel and PHP versions are supported by php-standard-library/shell?
- The package is framework-agnostic and is not tied to a specific Laravel release, so Laravel support depends on your PHP version and Composer constraints. Check its composer.json for the current PHP requirement and test the package on your Laravel version before adopting it. Because it is dependency-free, it usually integrates cleanly with modern Laravel applications.
- How do I handle failed shell commands and stderr in Laravel?
- Use the package's CommandResult object to inspect exit codes, stdout, and stderr after each run. Call throwIfFailed or check the exit code explicitly, then catch the failure in your Laravel service or command and report it with Laravel's exception handler. Returning structured results makes failed deployments, CI tasks, and docker build errors easier to debug.
- Can I stream real-time shell output in Laravel with php-standard-library/shell?
- The package supports streaming-style output handling, but you should process chunks carefully in Laravel to avoid memory growth. For long-running commands, write chunks to a log channel, Redis pub/sub, or a broadcast event rather than accumulating the full output in memory. Use small chunk sizes and avoid running unbounded streams inside queue workers.
- Is php-standard-library/shell a good alternative to exec or Symfony Process in Laravel?
- It is a lightweight alternative when you want automatic argument escaping and a clean CommandResult API without pulling in a larger framework component. Symfony Process is more mature and widely used, and newer Laravel versions also offer a Process facade. Choose php-standard-library/shell for simple, dependency-free command execution and Symfony Process when you need deeper process control or broader ecosystem support.
- How do I test shell command execution in a Laravel application?
- Wrap php-standard-library/shell calls in your own service or action class, then inject a fake or mock runner in unit tests. Assert on exit codes, stdout, stderr, and exception behavior from CommandResult objects. Use Laravel feature tests for console commands and run real shell integration tests only in disposable CI environments.
- What are the production risks of using php-standard-library/shell in Laravel?
- The main risks are command injection from unsafe input, blocking PHP workers with synchronous commands, and memory growth from streaming large output. Mitigate them with argument escaping, allowlists, queued jobs, chunked output, and timeouts. Also test cross-platform behavior if you deploy to Windows and Linux.
- Is php-standard-library/shell maintained and safe for long-term Laravel projects?
- It is MIT-licensed and dependency-free, which lowers supply-chain and upgrade risk. The repository has low community visibility, so monitor releases, pin versions in composer.json, and be ready to fork or migrate to Symfony Process if maintenance stalls. For critical Laravel systems, keep shell execution behind your own service layer so you can swap implementations later.
Weaver
How can I help you explore Laravel packages today?