Skip to content

Commit f3c2d63

Browse files
committed
Init project
0 parents  commit f3c2d63

17 files changed

+10533
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
vendor

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Laravel Ready
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Artisan Command Palette UI
2+
3+
A beautiful UI for Laravel Artisan commands that provides a command palette interface to search and execute Artisan commands directly from your browser.
4+
5+
## Installation
6+
7+
You can install the package via composer:
8+
9+
```bash
10+
composer require laravel-ready/artisan-command-palette-ui
11+
```
12+
13+
## Configuration
14+
15+
Publish the configuration file:
16+
17+
```bash
18+
php artisan vendor:publish --provider="LaravelReady\ArtisanCommandPaletteUI\ArtisanCommandPaletteUIServiceProvider" --tag="config"
19+
```
20+
21+
This will create a `config/artisan-command-palette-ui.php` file where you can modify the package settings.
22+
23+
## Usage
24+
25+
After installation, you can access the command palette UI at `/artisan-command-palette` (or the custom route prefix you defined in the config).
26+
27+
The UI allows you to:
28+
29+
- Search for available Artisan commands
30+
- View command descriptions and signatures
31+
- Execute commands and see their output in real-time
32+
33+
## Security
34+
35+
By default, the command palette is protected by the `web` and `auth` middleware, meaning only authenticated users can access it.
36+
37+
For additional security:
38+
39+
- The package is disabled in production environments by default (can be enabled in config)
40+
- You can exclude sensitive commands in the config file
41+
42+
## Frontend Development
43+
44+
If you want to modify the frontend assets, you can publish the views:
45+
46+
```bash
47+
php artisan vendor:publish --provider="LaravelReady\ArtisanCommandPaletteUI\ArtisanCommandPaletteUIServiceProvider" --tag="views"
48+
```
49+
50+
## License
51+
52+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"name": "laravel-ready/artisan-command-palette-ui",
3+
"description": "A UI for Laravel Artisan Command Palette",
4+
"type": "library",
5+
"license": "MIT",
6+
"authors": [
7+
{
8+
"name": "Laravel Ready",
9+
"email": "[email protected]"
10+
}
11+
],
12+
"minimum-stability": "dev",
13+
"prefer-stable": true,
14+
"require": {
15+
"php": "^8.0",
16+
"illuminate/support": "^8.0|^9.0|^10.0|^11.0"
17+
},
18+
"require-dev": {
19+
"orchestra/testbench": "^6.0|^7.0|^8.0|^9.0",
20+
"phpunit/phpunit": "^9.0|^10.0"
21+
},
22+
"autoload": {
23+
"psr-4": {
24+
"LaravelReady\\ArtisanCommandPaletteUI\\": "src/"
25+
}
26+
},
27+
"autoload-dev": {
28+
"psr-4": {
29+
"LaravelReady\\ArtisanCommandPaletteUI\\Tests\\": "tests/"
30+
}
31+
},
32+
"extra": {
33+
"laravel": {
34+
"providers": [
35+
"LaravelReady\\ArtisanCommandPaletteUI\\ArtisanCommandPaletteUIServiceProvider"
36+
]
37+
}
38+
},
39+
"scripts": {
40+
"test": "vendor/bin/phpunit"
41+
},
42+
"config": {
43+
"sort-packages": true
44+
}
45+
}

0 commit comments

Comments
 (0)