https://github.com/infureal/artisan-gui
Simple but yet powerful library for running almost all artisan commands.
https://github.com/infureal/artisan-gui
artisan artisan-gui laravel packagist php
Last synced: 7 months ago
JSON representation
Simple but yet powerful library for running almost all artisan commands.
- Host: GitHub
- URL: https://github.com/infureal/artisan-gui
- Owner: infureal
- Created: 2020-11-02T23:27:28.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-18T21:39:30.000Z (about 2 years ago)
- Last Synced: 2025-06-16T10:20:02.645Z (7 months ago)
- Topics: artisan, artisan-gui, laravel, packagist, php
- Language: Vue
- Homepage: https://packagist.org/packages/infureal/artisan-gui
- Size: 924 KB
- Stars: 361
- Watchers: 4
- Forks: 58
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> This package now in very slow development. It's not abandoned, you can still use it.
>
> Currently, started development of the new package. [#34](https://github.com/infureal/artisan-gui/issues/36)
# 
:artisan gui
Simple but yet powerful library for running some [artisan](https://laravel.com/docs/8.x/artisan) commands.
## Requirements
- **Laravel** 8.*
- **php** ^7.3
## Installation
Just install package:
```bash
composer require infureal/artisan-gui
```
### Installing 2.0.0@beta
```bash
composer require infureal/artisan-gui:2.0.0@beta
```
### Vendor publishing
By default package has predefined config and inline styles and scripts.
Since version `1.4` you can publish vendors like css and js files in `vendor/artisan-gui`:
```bash
php artisan vendor:publish --provider="Infureal\Providers\GuiServiceProvider"
```
Publish only config:
```bash
php artisan vendor:publish --tag="artisan-gui-config"
```
Publish only styles and scripts:
```bash
php artisan vendor:publish --tag="artisan-gui-css-js"
```
## Running command
By default, you can access this page only in local environment. If you wish
you can change `local` key in config.
Simply go to `http://you-domain.com/~artisan` and here we go!
Select needed command from list, fill arguments and options/flags and hit `run` button.
## What's new in v2
- Moved to SPA/Vue
- UI changed to more readable (IMHO)
- 
- Implementing search (with new design it's hard to find some command without search)
- Added permission field to config (for more flexible adjustment)
- Added array option fields
## Configuration
Default config is:
```php
[
'web',
// 'auth'
],
/*
|--------------------------------------------------------------------------
| Route prefix
|--------------------------------------------------------------------------
|
| Prefix for gui routes. By default url is [/~artisan-gui].
| For your wish you can set it for example 'my-'. So url will be [/my-artisan-gui].
|
| Why tilda? It's selected for prevent route names correlation.
|
*/
'prefix' => '~',
/*
|--------------------------------------------------------------------------
| Home url
|--------------------------------------------------------------------------
|
| Where to go when [home] button is pressed
|
*/
'home' => '/',
/*
|--------------------------------------------------------------------------
| Only on local
|--------------------------------------------------------------------------
|
| Flag that preventing showing commands if environment is on production
|
*/
'local' => true,
/*
|--------------------------------------------------------------------------
| List of command permissions
|--------------------------------------------------------------------------
|
| Specify permissions to every single command. Can be a string or array
| of permissions
|
| Example:
| 'make:controller' => 'create-controller',
| 'make:event' => ['generate-files', 'create-event'],
|
*/
'permissions' => [
],
/*
|--------------------------------------------------------------------------
| List of commands
|--------------------------------------------------------------------------
|
| List of all default commands that has end of execution. Commands like
| [serve] not supported in case of server side behavior of php.
| Keys means group. You can shuffle commands as you wish and add your own.
|
*/
'commands' => [
// ...
]
];
```
## Issues
If have any issue please [write me](https://github.com/inFureal/artisan-gui/issues).