Add new console command in Magento 2

12 comments

1. Follow below steps to access command line argument.

   1] use below class in command file.
   use Symfony\Component\Console\Input\InputArgument;

   2] create below constant

   const YOUR_ARGUMENT = ‘test_value’;

   3] In configure method write below code :

   $this->setName(‘inchoo:hello_world’)
   ->setDescription(‘Prints hello world.’)
   ->setDefinition([
   new InputArgument(
   self::YOUR_ARGUMENT, //param_name
   InputArgument::OPTIONAL,
   ‘Name of file to input’ // description
   ),

   ]);

   parent::configure();

   4] To get command line parameter use below code in execute method

   $argValue = $input->getArgument(self::YOUR_ARGUMENT);

   Reply

   1. It is easier just using the Symfony 3 practice:

      use Symfony\Component\Console\Command\Command;
      use Symfony\Component\Console\Input\InputInterface;
      use Symfony\Component\Console\Output\OutputInterface;
      
      // for arguments
      use Symfony\Component\Console\Input\InputArgument;

      protected function configure()
          {
              $this->setName('webburza:test')->setDescription('Test command to see if everything works.')
                  ->addArgument('argument_name', InputArgument::REQUIRED, 'Description for required argument')
                  ->addArgument('another_argument_name', InputArgument::OPTIONAL, 'Description for optional argument');
          }

      To access the argument just use:

      protected function execute(InputInterface $input, OutputInterface $output)
          {
              $value = $input->getArgument('argument_name');
              // ... rest of the code goes here
          }

      I find this a lot easier than using constants and defining options. Anyway, my two cents.

2. damn formatting thing – it broke my previous comment and there is no preview on ot – lets see if this one works

   HelloWorldCommand.php

   
setName('inchoo:hello_world')->setDescription('Prints hello world.');
}

   protected function execute(InputInterface $input, OutputInterface $output)
{
$output->writeln('Hello World!');
}

   }


   di.xml
   

   Inchoo\Helloworld\Console\Command\HelloWorldCommand

   HelloWorldCommand.php

   setName('inchoo:hello_world')->setDescription('Prints hello world.');
       }
   
       protected function execute(InputInterface $input, OutputInterface $output)
       {
           $output->writeln('Hello World!');
       }
   
   }
   

   di.xml

   
   
       
           
               
                   Inchoo\Helloworld\Console\Command\HelloWorldCommand
               
           
       
   
   

   Reply

3. To be honest I haven’t seen such an unfinished and misleading tutorial for a while. If any newbie would try to follow it, he/she would never have it working. Lemme bring my 5 cents here:

   1) you are creating a di.xml with this element

   <item name="hello_world" xsi:type="object">Inchoo\Console\Console\Command\HelloWorldCommand</item>

   and then later you are referring to it as to

   <item name="hello_world" xsi:type="object">Inchoo\Nassau\Console\Command\HelloWorldCommand</item>

   are you kidding me? with all the respect but that is such a stupid typo/ copy paste? what was that? somebody should figure out on its own what the hell the module name should be? more attention to such things please, we have enough BAD tutorials.. but it is not that bad.. the worst is that you are mentioning a command file

   “Let’s see this HelloWorldCommand class (it is located in Console directory in our module).”

   where it came from? was it brought in by Santa maybe? If that would have been a part of module creation which you have mentioned, it would be understandable you had not explained when you created it but it had not! it is a part of THIS tutorial, so you had to explain at which step it is being created since you are referring to it as to “this HelloWorldCommand class”.

   Also it is NOT in Console directory, it should be in Console/Command directory – so even its location is wrong

   but again it is not the worst thing here.. have you even tested this command? it wont work because
   a) it has no namespace – how the hell it would be reached by di?
   b) it refers to Command, InputInterface and OutputInterface – it would fail because such classes would not be found…

   oh my God I cant believe I am writing this.. I don’t ususally blame other peoples tutorials but here I had to. Really BAD.

   SO to make a long story short – for all folks who would try it:

   1) Assuming module name you create is Helloworld and it is in Inchoo namespace, so you would need to create a file Inchoo\Helloworld\Console\Command\HelloWorldCommand.php with this content

   
   setName('inchoo:hello_world')->setDescription('Prints hello world.');
       }
   
       protected function execute(InputInterface $input, OutputInterface $output)
       {
           $output->writeln('Hello World!');
       }
   }
   

   and your Inchoo\Helloworld\etc\di.xml should look like

   
   
   
       
           
               
                   Inchoo\Helloworld\Console\Command\HelloWorldCommand
               
           
       
   
   

   and then yes, it would work..

   author , please update this tutorial and test it before publishing it. thank you

   Reply

   1. Hi Oleksandr,

      1. This indeed was a typo
      2. “Let’s see this HelloWorldCommand class”
      – class has been mentioned in the XML file and the assumption is people following the tutorial read the files they’re copy-pasting (or using in their own code)
      3. It has no namespaces for formatting reasons, to be more readable and succinct
      4. InputInterface and OutputInterface do not exist – check point 3.

      Thanks for the comment. The typo is now fixed. Also, while we’re at it, your comment contains the same code as ours, and does not contribute anything new (it does not have namespaces as well, so it would not work 🙂 ). Check the original repository for more info: https://bitbucket.org/lurajcevi/inchoo_console/src

      Luka

   2. I would have to agree here… Your example isn’t complete (and is still incorrect with regards to the folder location- it should be namespace/module/Console/Command)

      Also, you should really include the namespace as well to make this a fully-working example:

      <?php
      namespace Inchoo\Console\Console\Command;
      use Symfony\Component\Console\Command\Command;
      use Symfony\Component\Console\Input\InputInterface;
      use Symfony\Component\Console\Output\OutputInterface;

      …

4. “Pepperidge Farm remembers.”

   Hahahahaha best line of entire article.

   Reply

5. Hi, Thank you for the great tut, but I have one question, How to pass param into the command line?
   Ex: bin/magento inchoo:hello_world file_name
   The execute can read file_name then read the content of file_name, the file_name is the CSV file
   Thank you again

   Reply

   1. Oh, I find out the way use Symfony\Component\Console\Input\InputArgument;

      $options = [
                  new InputArgument(
                      self::FILE_NAME,  //param_name
                      InputArgument::REQUIRED,  //optiosn or required param
                      'Name of file to input'   // description
                  ),
              ];

   2. Hello.
      Could you please describe what is the $options array? How you use it?

      I working on the same issue as you. When I add some argument like bin/magento inchoo:hello_world file_name I see:
      [RuntimeException]
      Too many arguments.
      in console. What did you do for passing argument?

6. Very nice article, very helpful for me and it will definitely helps to other Magento 2 developers as well.
   Thank you once again.

   Reply

7. Very good, I have several scripts that will apply in this way, thank Luka.

   Reply