How To Create a Custom Console Command in Magento 2.x

There are following below steps to create custom console command or custom command to perform some complex data manipulation operation.

custom console command by using custom module

Here, we are considering as
Namespace / ModuleName = Mage2db/John

Magento 2 Custom Module

Step [1.1] – Create registration.php file under your module [ Namespace / ModuleName ]

File Path=Mage2db/John/registration.php

Add below content in this file.

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Mage2db_John',
    __DIR__
);

Step [1.2] – Create module.xml file under your module [ Namespace / ModuleName ]

File Path=Mage2db/John/etc/module.xml

Add below content in this file.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Mage2db_John" setup_version="1.0.0" />
</config>

Step [2] – Create di.xml file under your module etc directory. Add below content in this file.

File Path=Mage2db/John/etc/di.xml

<?xml version="1.0"?>

    <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <type name="Magento\Framework\Console\CommandList">

       <arguments>

           <argument name="commands" xsi:type="array">

               <item name="Mage2dbHelloCustomer" xsi:type="object">Mage2db\John\Console\Hellocustomer</item>

           </argument>

       </arguments>

   </type>

</config>

Step [3] – Create Hellocustomer.php class file under your module Console directory. Add below code in this file.

File Path=Mage2db/John/Console/Hellocustomer.php

<?php
namespace Mage2db\John\Console;


use Symfony\Component\Console\Command\Command;

use Symfony\Component\Console\Input\InputInterface;

use Symfony\Component\Console\Output\OutputInterface;

 

class Hellocustomer extends Command

{

   protected function configure()

   {

       $this->setName('mage2db:hellocustomer');

       $this->setDescription('Demo Custom command line');

      

       parent::configure();

   }

   protected function execute(InputInterface $input, OutputInterface $output)

   {

    $output->writeln("Hello Customer,Custom Module For Custom Console Command");

   }

}

Step[4] – Finally, Custom module with Console Command has been done.

Run command