README

A beautiful UI for Laravel Artisan commands that provides a command palette interface to search and execute Artisan commands directly from your browser.

🖼️ Preview

📦 Installation

You can install the package via composer:

composer require laravel-ready/artisan-command-palette-ui

⚙️ Configuration

Publish the configuration file:

php artisan vendor:publish --provider="LaravelReady\ArtisanCommandPaletteUI\ArtisanCommandPaletteUIServiceProvider" --tag="config"

This will create a config/artisan-command-palette-ui.php file where you can modify the package settings.

🚀 Usage

After installation, you can access the command palette UI at /artisan-command-palette (or the custom route prefix you defined in the config).

The UI allows you to:

Search for available Artisan commands
View command descriptions and signatures
Execute commands and see their output in real-time

🔒 Security

By default, the command palette is protected by the auth middleware, meaning only authenticated users can access it.

For additional security:

The package is disabled in production environments by default (can be enabled in config)
You can exclude sensitive commands in the config file

💻 Frontend Development

If you want to modify the frontend assets, you can publish the views:

php artisan vendor:publish --provider="LaravelReady\ArtisanCommandPaletteUI\ArtisanCommandPaletteUIServiceProvider" --tag="views"

🧪 Testing

To run the test suite, you can use the following command:

composer test

📄 License

The MIT License (MIT). Please see License File for more information.

laravel-ready / artisan-command-palette-ui

Maintainers

Details