README

Artisan UI is a production-grade Laravel package that provides a secure, modern web-based interface for your Artisan commands. No more typing in the terminal—manage your application through a beautiful graphical UI.

Features

• 🚀 Dynamic Discovery: Automatically finds all your Artisan commands.
• 🛡️ Secure by Default: Standalone authentication system and command filtering.
• 📊 Live Console: See command output in real-time as if you were in the terminal.
• 📱 Modern Design: Built with React and Radix Themes for a premium feel.
• 🕵️ Audit Logs: Full history of every command executed, who ran it, and what the output was.

Requirements

• PHP 8.1+
• Laravel 10.0, 11.0, or 12.0+

Note

PHP Version Support: Artisan UI supports PHP 8.1 and all future versions. If you encounter installation issues with a newer PHP version, see Installation Troubleshooting Guide.

Installation

Getting started is simple. Artisan UI features Zero-Config Installation—it handles everything automatically.

1. Install via Composer

Run the following command in your terminal:

composer require blessedjasonmwanza/artisan-ui

2. Publish Assets and Run migrations

php artisan artisan-ui:install

2. Access the Dashboard

Navigate to /artisan-ui in your browser.

The package will automatically handle:

• Publishing assets and configuration files.
• Running database migrations.
• Setting up your first administrator account on the setup page.

No manual commands needed! Everything runs on first access after installation or update.

Tip

Manual Installation: If you ever need to manually trigger installation, use:

php artisan artisan-ui:install

Or publish assets individually:

php artisan vendor:publish --tag=artisan-ui-assets --force
php artisan vendor:publish --tag=artisan-ui-config --force

Uninstallation: To remove the package completely:

php artisan artisan-ui:install --uninstall

This will remove published assets, configuration files, and optionally drop database tables.

Configuration

You can customize the package by editing config/artisan-ui.php.

Command Whitelist/Blacklist

Control which commands are visible in the UI:

'commands' => [
    'only' => [], // Leave empty to show all
    'exclude' => [
        'tinker',
        'up',
        'down',
    ],
],

Path & Middleware

Change the URL or add your own security layers:

'path' => 'my-custom-artisan-path',
'middleware' => ['web', 'auth'],

Security

• No Shell Execution: We use symfony/process to run only legitimate Laravel commands.
• Standalone Auth: Artisan UI doesn't touch your main users table. It uses its own secure authentication.
• Input Validation: All arguments and options are strictly validated before execution.

License

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