Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svenluijten/artisan-shortcuts
🍰 Register shortcuts to execute multiple artisan commands
https://github.com/svenluijten/artisan-shortcuts
artisan artisan-command cli command-line hacktoberfest laravel laravel-5-package laravel-artisan laravel-framework laravel-package
Last synced: 3 days ago
JSON representation
🍰 Register shortcuts to execute multiple artisan commands
- Host: GitHub
- URL: https://github.com/svenluijten/artisan-shortcuts
- Owner: svenluijten
- License: mit
- Created: 2018-06-23T18:12:40.000Z (over 6 years ago)
- Default Branch: 1.x
- Last Pushed: 2024-03-26T15:49:15.000Z (8 months ago)
- Last Synced: 2024-03-26T16:56:59.881Z (8 months ago)
- Topics: artisan, artisan-command, cli, command-line, hacktoberfest, laravel, laravel-5-package, laravel-artisan, laravel-framework, laravel-package
- Language: PHP
- Homepage: https://git.io/ascts
- Size: 61.5 KB
- Stars: 57
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Artisan Shortcuts
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-tests]][link-tests]
[![StyleCI][ico-styleci]][link-styleci]
Have you ever executed 2 or 3 artisan commands _over_, and _over_, and _over_ in
your Laravel projects? Me too! That's what prompted this package. With it, you can
define "shortcuts" to bundle up those commonly used commands into short, memorable
names (or long, convoluted ones, that's up to you!).
## Installation
You'll have to follow a couple of simple steps to install this package.
### Downloading
Via [composer](http://getcomposer.org):
```bash
$ composer require sven/artisan-shortcuts
```
Or add the package to your dependencies in `composer.json` and run
`composer update` on the command line to download the package:
```json
{
"require": {
"sven/artisan-shortcuts": "^1.0"
}
}
```
### Registering the service provider
If you're [not using auto-discovery](https://laravel.com/docs/5.6/packages#package-discovery),
register `Sven\ArtisanShortcuts\ServiceProvider::class` in your `config/app.php` file.
### Publishing the configuration file
To publish this package's configuration file, execute the following command and pick
`Sven\ArtisanShortcuts\ServiceProvider` from the list:
```bash
$ php artisan vendor:publish
```
## Usage
After publishing the configuration file, you can define your shortcuts in `config/shortcuts.php`. Knowing
that, creating your own artisan shortcuts is fairly straightforward. Take a look at the following
configuration:
```php
return [
'custom-command' => [
FirstCommand::class => [
'--option' => 'value',
],
SecondCommand::class,
],
];
```
Running `php artisan custom-command` will execute `FirstCommand` with the option `--option=value`,
and `SecondCommand` without any arguments or options.
Something I use this for all the time is [Barry van den Heuvel's `laravel-ide-helper` commands](https://github.com/barryvdh/laravel-ide-helper):
```php
return [
'ide' => [
GeneratorCommand::class,
ModelsCommand::class => ['--nowrite' => true],
MetaCommand::class,
],
];
```
Instead of using the FQCN for the command classes, you can also use the command names:
```php
return [
'clear' => [
'cache:clear',
'config:clear',
'view:clear',
],
];
```
## Supported versions
Look at the table below to find out what versions of Laravel are supported on what version
of this package:
| Laravel | Artisan Shortcuts |
|---------------|-------------------|
| `5.5` - `8.x` | `^1.0` |
## Contributing
All contributions (pull requests, issues and feature requests) are
welcome. Make sure to read through the [CONTRIBUTING.md](CONTRIBUTING.md) first,
though. See the [contributors page](../../graphs/contributors) for all contributors.
## License
`sven/artisan-shortcuts` is licensed under the MIT License (MIT). Please see the
[license file](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/sven/artisan-shortcuts.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/sven/artisan-shortcuts.svg?style=flat-square
[ico-tests]: https://img.shields.io/github/actions/workflow/status/svenluijten/artisan-shortcuts/tests.yml?style=flat-square
[ico-styleci]: https://styleci.io/repos/138423783/shield
[link-packagist]: https://packagist.org/packages/sven/artisan-shortcuts
[link-downloads]: https://packagist.org/packages/sven/artisan-shortcuts
[link-tests]: https://github.com/svenluijten/artisan-shortcuts/actions/workflows/tests.yml
[link-styleci]: https://styleci.io/repos/138423783