Laravel Custom Artisan command Example

Hi Friends,

Today,I will learn you how to create custom command in laravel .It's better if we make our own artisan command for like project setup, create new admin Student etc in our laravel application. If we create custom command then we can make project setup like create one admin Student, run migration, run seeder and etc. In this post i give you example, how to create console commands in laravel project.

In this example I will create custom command for create new admin Student. This custom command will ask your name, email and password.

Custom command

php artisan students:create

This command through we will create new admins. So first fire bellow command and create console class file.

php artisan make:command StudentCommand --command=student:create

Next this command you can find one file StudentCommand class in console directory. so one that file and put bellow code. app/Console/Commands/StudentCommand.php

<php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use App\Models\Student;
use Hash;

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

    /**
     * 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 int
     */
    public function handle()
    {
        $input['name'] = $this->ask('Your name?');
        $input['email'] = $this->ask('Your email?');
        $input['password'] = $this->secret('What is the password?');
        $input['password'] = Hash::make($input['password']);

        Student::create($input);

        $this->info('Student Create Successfully.');
    }
}

After, Now I need to register this command class in Kernel.php file, so open file and add class this way:

<?php	
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 = [
        Commands\StudentCommand::class,
    ];
    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        

    }
}

Now we are ready to use or custom command, you fire bellow command and check you can find command in the list this way "students:create".

php artisan list
php artisan students:create

It will help you..