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

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
}

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
}

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

Hint

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

Practice

1. What is the main purpose of the Laravel Artisan CLI?

easy

A. To write PHP code directly in the terminal

B. To run commands that help build and manage Laravel applications

C. To design the user interface of Laravel apps

D. To host Laravel applications on the internet

Solution

1. Step 1: Understand Artisan CLI role

   Artisan CLI is a command-line tool designed to help developers manage Laravel projects efficiently.

2. Step 2: Identify correct purpose

   It runs commands for tasks like creating files, running migrations, and starting servers, not for writing code or hosting.

3. Final Answer:

   To run commands that help build and manage Laravel applications -> Option B

4. Quick Check:

   Artisan CLI purpose = run helpful commands [OK]

Hint: Artisan runs commands to manage Laravel apps fast [OK]

Common Mistakes:

• Thinking Artisan is for writing code directly
• Confusing Artisan with hosting services
• Assuming Artisan designs app interfaces

2. Which of the following is the correct way to run an Artisan command to start the Laravel development server?

easy

A. php artisan serve

B. php artisan start-server

C. php artisan run server

D. php artisan launch

Solution

1. Step 1: Recall the correct command syntax

   The Laravel command to start the development server is php artisan serve.

2. Step 2: Compare options

   Options B, C, and D are not valid Artisan commands for starting the server.

3. Final Answer:

   php artisan serve -> Option A

4. Quick Check:

   Start server command = php artisan serve [OK]

Hint: Use 'serve' to start Laravel server with Artisan [OK]

Common Mistakes:

• Adding extra words like 'start-server'
• Using 'run server' instead of 'serve'
• Assuming 'launch' is a valid command

3. What will be the output when you run php artisan list in a Laravel project?

medium

A. A list of all available Artisan commands

B. An error saying command not found

C. Starts the Laravel development server

D. Displays the current Laravel version only

Solution

1. Step 1: Understand the 'list' command

   The php artisan list command shows all Artisan commands available in the project.

2. Step 2: Eliminate incorrect options

   It does not start the server, cause an error, or only show the version.

3. Final Answer:

   A list of all available Artisan commands -> Option A

4. Quick Check:

   php artisan list shows commands = true [OK]

Hint: Use 'list' to see all Artisan commands [OK]

Common Mistakes:

• Expecting it to start the server
• Thinking it shows only version info
• Assuming it causes an error

4. You try to run php artisan migratee but get an error. What is the most likely cause?

medium

A. The database is not connected

B. Laravel is not installed

C. You need to run 'php artisan serve' first

D. Typo in the command name; correct is 'migrate'

Solution

1. Step 1: Check the command spelling

   The command migratee is misspelled; the correct command is migrate.

2. Step 2: Understand error cause

   Laravel will throw an error because it does not recognize the misspelled command.

3. Final Answer:

   Typo in the command name; correct is 'migrate' -> Option D

4. Quick Check:

   Misspelled command causes error [OK]

Hint: Check command spelling carefully to avoid errors [OK]

Common Mistakes:

• Assuming server must run before migrate
• Blaming database connection for command error
• Thinking Laravel is not installed without checking

5. You want to create a new controller named ProductController using Artisan. Which command should you run?

hard

A. php artisan new:controller ProductController

B. php artisan create:controller ProductController

C. php artisan make:controller ProductController

D. php artisan generate controller ProductController

Solution

1. Step 1: Recall the correct Artisan command for creating controllers

   The correct command uses the 'make:controller' syntax followed by the controller name.

2. Step 2: Compare options

   Options B, C, and D use incorrect command formats not recognized by Artisan.

3. Final Answer:

   php artisan make:controller ProductController -> Option C

4. Quick Check:

   Create controller command = make:controller [OK]

Hint: Use 'make:controller' to create controllers fast [OK]

Common Mistakes:

• Using 'create:controller' instead of 'make:controller'
• Omitting the colon ':' in the command
• Using 'generate' which is not an Artisan command