Calling laravel artisan command from console

Title: Calling Laravel Artisan Command from Console Body:

Learning and understanding Laravel's command line interface (CLI) is crucial for developers who want to automate their tasks and create efficient workflows. This blog post aims at providing a comprehensive guide on how to call a custom Laravel artisan command from the console. We will go through the basics, the necessary files involved, and finally, how to execute the commands from the shell.

Kernel file

    namespace App\Console;

    use Illuminate\Console\Scheduling\Schedule;
    use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

    class Kernel extends ConsoleKernel
    {
        /**
         * The Artisan commands provided by your application.
         *
         * @var array
         */
        protected $commands = [
            //
            'App\Console\Commands\FooCommand',      
        ];

        /**
         * Define the application's command schedule.
         *
         * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
         * @return void
         */
        protected function schedule(Schedule $schedule)
        {
            // $schedule->command('inspire')
            //          ->hourly();
            $schedule->command('App\Console\Commands\FooCommand')->hourly();
        }

        /**
         * Register the Closure based commands for the application.
         *
         * @return void
         */
        protected function commands()
        {
            require base_path('routes/console.php');
        }
    }

The kernel file is responsible for defining your custom artisan commands and their respective schedules. The $commands array contains all the artisan commands available in your application, including the FooCommand we will use later in this tutorial. The schedule method configures command execution intervals, which you can choose based on your requirements.

Command file

namespace App\Console\Commands;

use Illuminate\Console\Command;

class FooCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'command:name';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        //
    }

    public function fire()
    {

        $this->info('Test has fired.');
    }}

The FooCommand file represents the actual artisan command that we want to execute. It includes information like its name, description, and a handle method containing your desired functionality. The fire() method is responsible for displaying our desired output when the command runs successfully.

Calling the command from shell

To test the FooCommand from the console, you can use the artisan tinker:

php artisan tinker
(Pry) => App\Console\Commands\FooCommand::fire();
Test has fired.

You can also run it directly with Artisan:

php artisan command:name
Running command 'command:name'
Applying value to 'command_name' from argument 'name' (input)
Test has fired.

In both cases, the output should display "Test has fired." as our fire() method specifies. You can now customize your commands or schedule them for automated execution using Laravel's powerful and flexible CLI framework.