Command-line scripts in Laravel?

Question

I have some command line scripts that I would like to modify to use Laravel's features (Eloquent etc).

How do I do that? I am aware that Laravel bootstraps from the index.html file. Is there any provision for running command-line apps / scripts?

A good example for Laravel 9: positronx.io/…

shasi kanth
– shasi kanth

2023-04-24 07:57:09 +00:00
Commented Apr 24, 2023 at 7:57 — shasi kanth
– shasi kanth, Commented Apr 24, 2023 at 7:57

Artur Subotkevič · Accepted Answer · 2019-12-16 20:52:45Z

27

Make a command using php artisan make:command FancyCommand.
In /app/Console/Commands/FancyCommand.php find a protected variable $signature and change it's value to your preferred signature:
```
protected $signature = 'fancy:command';
```

Code in the handle() method will be executed:

public function handle()
{
    // Use Eloquent and other Laravel features...

    echo 'Hello world';
}

Register your new command in the /app/Console/Kernel.php by adding your command's class name to $commands array.
```
protected $commands = [
    // ...
    Commands\FancyCommand::class,
];
```
Run your new command: php artisan fancy:command.

edited Dec 16, 2019 at 20:52

answered Dec 6, 2016 at 11:34

Artur Subotkevič

1,9391 gold badge15 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Andrew Over a year ago

Although this is actually the better way of doing it (compared to the closure based method that's being upvoted), you managed to make it seem more complicated that it actually is some how.

Marina Over a year ago

Thank you, very helpful! Also in Laravel7 you don't need to do step 4

Antonio Carlos Ribeiro · Accepted Answer · 2016-12-06 10:57:53Z

11

Yes, you can use Artisan commands:

Artisan::command('my:command', function () {
    // Here you can use Eloquent
    $user = User::find(1);

    // Or execute shell commands
    $output = shell_exec('./script.sh var1 var2');
});

Then run it using

user@ubuntu: php artisan my:command

Check the docs: https://laravel.com/docs/5.3/artisan

You can also use the scheduler: https://laravel.com/docs/5.3/scheduling

answered Dec 6, 2016 at 10:57

Antonio Carlos Ribeiro

87.9k22 gold badges220 silver badges205 bronze badges

2 Comments

daninthemix Over a year ago

Thanks. I should've mentioned I'm actually using Lumen - does the above still apply?

Andrew Over a year ago

Where does one put this command code? Looks like console.php is the place.

Collectives™ on Stack Overflow

Command-line scripts in Laravel?

2 Answers 2

2 Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related