Artisan CLI overview in Laravel - Mini Project: Build & Apply

Artisan CLI overview

📖 Scenario: You are building a Laravel project and want to understand how to use Artisan CLI commands to manage your application efficiently.

🎯 Goal: Learn to create a simple Artisan command, configure it, and run it to see output in the terminal.

📋 What You'll Learn

Create a new Artisan command class

Configure the command signature and description

Implement the handle method with a simple message

Run the Artisan command from the terminal

💡 Why This Matters

🌍 Real World

Artisan CLI commands help Laravel developers automate tasks like database migrations, clearing caches, and running custom scripts.

💼 Career

Knowing how to create and use Artisan commands is essential for Laravel developers to manage projects efficiently and automate repetitive tasks.

1

Create a new Artisan command class

Create a new Artisan command class called GreetUser inside the app/Console/Commands directory. The class should extend Illuminate\Console\Command.

Laravel

// Create the GreetUser command class extending Illuminate\Console\Command
// Your code here

Need a hint?

Use php artisan make:command GreetUser in a real project to generate this class automatically.

2

Configure the command signature and description

Inside the GreetUser class, add a protected property $signature with the value 'greet:user' and a protected property $description with the value 'Display a greeting message to the user'.

Laravel

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class GreetUser extends Command
{
    // Add the signature and description properties below
    // Your code here
}

Need a hint?

The $signature defines how you call the command in the terminal.

3

Implement the handle method with a simple message

Add a public method handle() inside the GreetUser class that uses $this->info() to display the message 'Hello, welcome to Artisan CLI!'.

Laravel

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class GreetUser extends Command
{
    protected $signature = 'greet:user';

    protected $description = 'Display a greeting message to the user';

    // Add the handle method below
    // Your code here
}

Need a hint?

The handle method runs when you execute the command.

4

Run the Artisan command from the terminal

Run the Artisan command php artisan greet:user in your terminal to see the greeting message displayed.

Laravel

info('Hello, welcome to Artisan CLI!');
    }
}

// Now run `php artisan greet:user` in your terminal to see the message

Need a hint?

Open your terminal in the Laravel project folder and type the command exactly.