Solo for Laravel

https://github.com/soloterm/solo
Admin
Solo for Laravel is a package that allows you to run multiple commands simultaneously in separate...
Tokens:2,687
Snippets:11
Trust Score:6.8
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure Solo Commands in PHP

Source: https://github.com/soloterm/solo/blob/main/README.md

This PHP code snippet demonstrates how to define various commands within the Solo configuration file (`config/solo.php`). It shows examples of simple string commands, custom command classes, and lazy commands that do not start automatically.

```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(),
]
```

```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(),
]
```

```php
// You might need Reverb, but maybe not always, so don't autostart it.
'Reverb' => Command::from('php artisan reverb')->lazy()
```

--------------------------------

### Publish Solo Configuration

Source: https://github.com/soloterm/solo/blob/main/README.md

After installation, this command publishes the Solo configuration file to the `config/solo.php` path, allowing for customization of Solo's behavior.

```shell
php artisan solo:install
```

--------------------------------

### Install Solo Package

Source: https://github.com/soloterm/solo/blob/main/README.md

This command installs the Solo package for Laravel using Composer. It's a development dependency.

```shell
composer require soloterm/solo --dev
```

--------------------------------

### Run Solo Dump Server

Source: https://github.com/soloterm/solo/blob/main/README.md

The 'solo:dumps' command starts a custom Dump Server that intercepts 'dump' commands from your code. It displays the output within Solo instead of inline, providing a cleaner debugging experience. This command is executed using standard Artisan syntax.

```bash
php artisan solo:dumps
```

--------------------------------

### Run Solo Artisan Command

Source: https://github.com/soloterm/solo/blob/main/README.md

This command initiates the Solo application, allowing you to manage multiple development commands in a unified interface. It requires the pcntl extension and is not compatible with Windows.

```shell
php artisan solo
```

--------------------------------

### Use EnhancedTailCommand for Log Viewing

Source: https://github.com/soloterm/solo/blob/main/README.md

This PHP code snippet demonstrates the usage of `EnhancedTailCommand` to view log files with advanced features like vendor frame collapsing and stack trace formatting. It's configured to tail a specific log file.

```php
'Logs' => EnhancedTailCommand::file(storage_path('logs/laravel.log')),

```

--------------------------------

### Configure Solo Keybindings in PHP

Source: https://github.com/soloterm/solo/blob/main/README.md

This PHP code snippet illustrates how to configure keybindings for Solo in `config/solo.php`. You can choose between default and Vim-style keybindings by setting the `keybinding` option.

```php
'keybinding' => env('SOLO_KEYBINDING', 'default'),

'keybindings' => [
    'default' => Hotkeys\DefaultHotkeys::class,
    'vim' => Hotkeys\VimHotkeys::class,
]
```

--------------------------------

### Run Sail Commands with ANSI Support

Source: https://github.com/soloterm/solo/blob/main/README.md

To execute Sail commands within Solo, particularly those requiring ANSI color support, use the 'vendor/bin/sail artisan' command followed by the specific Artisan command and the '--ansi' flag. This ensures proper formatting and output.

```bash
vendor/bin/sail artisan schedule:work --ansi
```

--------------------------------

### ngrok Session Status

Source: https://github.com/soloterm/solo/blob/main/tests/Fixtures/ngrok_2.txt

Displays the current status of the ngrok session, including connection state, version, web interface URL, and connection statistics like round-trip times and percentiles.

```bash
ngrok
Session Status                connecting
Version                       3.12.1
Web Interface                 http://127.0.0.1:4040
Connections                   ttl     opn     rt1     rt5     p50     p90    
                              0       0       0.00    0.00    0.00    0.00    
```

--------------------------------

### Configure Solo Theme in PHP

Source: https://github.com/soloterm/solo/blob/main/README.md

This PHP code snippet shows how to configure the theme for Solo in the `config/solo.php` file. It allows setting the theme via an environment variable or directly specifying a theme class.

```php
'theme' => env('SOLO_THEME', 'dark'),

'themes' => [
    'light' => Themes\LightTheme::class,
    'dark' => Themes\DarkTheme::class,
]
```

--------------------------------

### Proxy Laravel Make Commands with Solo

Source: https://github.com/soloterm/solo/blob/main/README.md

The 'solo:make' command acts as a central proxy for all of Laravel's 'php artisan make:*' commands, simplifying the process of generating various components. It is implemented within a custom 'MakeCommand' class.

```php
'Make' => new MakeCommand
```
Tokens:
Raw