https://github.com/soloterm/solo
Your all-in-one Laravel command to tame local development
https://github.com/soloterm/solo
Last synced: about 1 year ago
JSON representation
Your all-in-one Laravel command to tame local development
- Host: GitHub
- URL: https://github.com/soloterm/solo
- Owner: soloterm
- License: mit
- Created: 2024-11-06T23:16:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-22T15:22:59.000Z (about 1 year ago)
- Last Synced: 2025-04-30T12:16:58.214Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 1.76 MB
- Stars: 1,133
- Watchers: 7
- Forks: 53
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-php - Solo - A terminal application to manage processes for a Laravel application. (Table of Contents / Development Environment)
- fucking-awesome-php - Solo - A terminal application to manage processes for a Laravel application. (Table of Contents / Development Environment)
README
Your all-in-one Laravel command to tame local development
---
# Solo for Laravel
> [!IMPORTANT]
> This package requires ext-pcntl, so it will not work on Windows. Sorry about that. If you know how to fix that, let me
know!
## About
Solo for Laravel is a package to run multiple commands at once, to aid in local development. All the commands needed to
run your application live behind a single artisan command:
```shell
php artisan solo
```
Each command runs in its own tab in Solo. Use the left/right arrow keys to navigate between tabs and enjoy a powerful,
unified development environment.
## Installation
1. Require the package:
```shell
composer require soloterm/solo --dev
```
2. Install the package:
```shell
php artisan solo:install
```
This will publish the configuration file to `config/solo.php`.
## Configuration
Solo is entirely config-driven through `config/solo.php`. Here's a quick overview of what you can configure:
### Commands
Define your commands in the `commands` array:
```php
'commands' => [
'About' => 'php artisan solo:about',
'Logs' => EnhancedTailCommand::file(storage_path('logs/laravel.log')),
'Vite' => 'npm run dev',
'Make' => new MakeCommand,
// Lazy commands don't start automatically
'Dumps' => Command::from('php artisan solo:dumps')->lazy(),
'Queue' => Command::from('php artisan queue:work')->lazy(),
'Tests' => Command::from('php artisan test --colors=always')->lazy(),
],
```
You can define commands in several ways:
```php
'commands' => [
// A simple string
'About' => 'php artisan solo:about',
// A custom Command class
'Logs' => EnhancedTailCommand::file(storage_path('logs/laravel.log')),
'Make' => new MakeCommand,
// Using the Command::from() static constructor
'Dumps' => Command::from('php artisan solo:dumps')->lazy(),
],
```
A simple string command is the easiest way, but if you need more control you're free to create your own custom class. The `EnhancedTailCommand` is a good example of what you can do in a custom command.
#### Lazy Commands
If you want to define a command that does not start automatically, you can append `lazy()` to a Command instance:
```php
// You might need Reverb, but maybe not always, so don't autostart it.
'Reverb' => Command::from('php artisan reverb')->lazy()
```
### Themes
Solo ships with both light and dark themes. Configure your preference in `config/solo.php`:
```php
'theme' => env('SOLO_THEME', 'dark'),
'themes' => [
'light' => Themes\LightTheme::class,
'dark' => Themes\DarkTheme::class,
],
```
You can define your own theme if you'd like. It's probably easiest to subclass one of the existing themes.
### Keybindings
Choose between default and vim-style keybindings:
```php
'keybinding' => env('SOLO_KEYBINDING', 'default'),
'keybindings' => [
'default' => Hotkeys\DefaultHotkeys::class,
'vim' => Hotkeys\VimHotkeys::class,
],
```
Again, you're welcome to define and register your own keybidings.
## Usage
Start Solo with:
```shell
php artisan solo
```
### Key Controls
> Note these are the default bindings. They will be slightly different if you use the Vim bindings.
- **Navigation**:
- Left/Right arrows to switch between tabs
- Up/Down arrows to scroll output
- Shift + Up/Down to page scroll
- g to quickly jump to any tab
- **Command Controls**:
- s to start/stop the current command
- r to restart
- c to clear output
- p to pause output
- f to resume (follow) output
- **Interactive Mode**:
- i to enter interactive mode
- Ctrl+X to exit interactive mode
- **Global**:
- q or Ctrl+C to quit Solo
## Special Commands
### EnhancedTailCommand
The `EnhancedTailCommand` provides improved log viewing with features like:
- Vendor frame collapsing
- Stack trace formatting
- Toggle vendor frames with v
- File truncating
```php
'Logs' => EnhancedTailCommand::file(storage_path('logs/laravel.log')),
```
### MakeCommand
Solo ships with a special `php artisan solo:make` command that proxies to all of the underlying `php artisan make:*`
commands. It serves as a universal entry point to Laravel's make commands.
It lives in a custom `MakeCommand` class.
```php
'Make' => new MakeCommand,
```
### `solo:dumps`
Solo also ships with a custom "[Dump Server](https://symfony.com/doc/current/components/var_dumper.html)" that will intercept `dump` commands from your code and show them in Solo instead of inline. You can run this as a normal artisan command via `php artisan solo:dumps`.
## FAQ
#### My command isn't working
Try these steps:
1. Test if it works outside of Solo
2. Check if it has an `--ansi` or `--colors=always` option
3. Verify it's writing to STDOUT
4. Look for options to force STDOUT output
#### Can I run Sail commands?
Yes! Use this format: `vendor/bin/sail artisan schedule:work --ansi`
#### Does Solo support Windows?
No, Solo requires `ext-pcntl` and other Unix-specific features. If you know how to fix that, please open a PR.
#### Can I use this in production?
I wouldn't! Use supervisor or similar tools for production environments.
## Support
This is free! If you want to support me:
- Sponsor my open source work: [aaronfrancis.com/backstage](https://aaronfrancis.com/backstage)
- Check out my courses:
- [Mastering Postgres](https://masteringpostgres.com)
- [High Performance SQLite](https://highperformancesqlite.com)
- [Screencasting](https://screencasting.com)
- Help spread the word about things I make
## Credits
Solo was developed by Aaron Francis. If you like it, please let me know!
- Twitter: https://twitter.com/aarondfrancis
- Website: https://aaronfrancis.com
- YouTube: https://youtube.com/@aarondfrancis
- GitHub: https://github.com/aarondfrancis/solo
Special thanks to:
- [Joe Tannenbaum](https://x.com/joetannenbaum) for his [Laracasts course](https://laracasts.com/series/cli-experiments)
- Joe's [Chewie package](https://github.com/joetannenbaum/chewie)
- [Laravel Prompts](https://laravel.com/docs/11.x/prompts)
- [Will King](https://x.com/wking__) for the Solo logo