Console Commands

Create CLI commands for maintenance, data import, or automation tasks.

Basic Command

<?php
namespace Plugins\MyPlugin\Command;

use App\Core\Command\AbstractPluginCommand;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand(
    name: 'my-plugin:greet',
    description: 'Greet a user by name',
)]
class GreetCommand extends AbstractPluginCommand
{
    protected function configure(): void
    {
        $this
            ->addArgument('name', InputArgument::REQUIRED, 'The name to greet')
            ->addOption('uppercase', 'u', InputOption::VALUE_NONE, 'Display in uppercase');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $name = $input->getArgument('name');
        $uppercase = $input->getOption('uppercase');

        $message = sprintf('Hello, %s!', $name);

        if ($uppercase) {
            $message = strtoupper($message);
        }

        $this->io->success($message);
        $this->logInfo('Greeted user', ['name' => $name]);

        return Command::SUCCESS;
    }
}

Command with Services

#[AsCommand(name: 'my-plugin:sync')]
class SyncCommand extends AbstractPluginCommand
{
    public function __construct(
        private readonly MyService $myService,
        private readonly EntityManagerInterface $entityManager,
    ) {
        parent::__construct();
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->io->title('Syncing data...');

        try {
            $result = $this->myService->syncData();

            $this->io->success(sprintf('Synced %d items', $result['count']));
            $this->logInfo('Data sync completed', $result);

            return Command::SUCCESS;
        } catch (\Exception $e) {
            $this->io->error('Sync failed: ' . $e->getMessage());
            $this->logError('Data sync failed', ['error' => $e->getMessage()]);

            return Command::FAILURE;
        }
    }
}

Interactive Commands

protected function execute(InputInterface $input, OutputInterface $output): int
{
    $apiKey = $this->io->ask('Enter your API key');

    if (!$this->validateApiKey($apiKey)) {
        $this->io->error('Invalid API key');
        return Command::FAILURE;
    }

    $confirmed = $this->io->confirm('Do you want to proceed?', false);

    if (!$confirmed) {
        $this->io->note('Operation cancelled');
        return Command::SUCCESS;
    }

    $choice = $this->io->choice('Select option', ['Option 1', 'Option 2', 'Option 3']);

    // Process...

    return Command::SUCCESS;
}

Progress Bars

protected function execute(InputInterface $input, OutputInterface $output): int
{
    $items = $this->myService->getItemsToProcess();

    $this->io->progressStart(count($items));

    foreach ($items as $item) {
        $this->processItem($item);
        $this->io->progressAdvance();
    }

    $this->io->progressFinish();
    $this->io->success('Processing complete');

    return Command::SUCCESS;
}

Input Arguments

protected function configure(): void
{
    $this
        ->addArgument('name', InputArgument::REQUIRED, 'The name argument')
        ->addArgument('optional', InputArgument::OPTIONAL, 'Optional argument')
        ->addArgument('array', InputArgument::IS_ARRAY, 'Multiple values');
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
    $name = $input->getArgument('name');
    $optional = $input->getArgument('optional');
    $array = $input->getArgument('array');

    // ...
}

Usage:

php bin/console my-plugin:command required-value
php bin/console my-plugin:command required-value optional-value
php bin/console my-plugin:command required-value -- item1 item2 item3

Input Options

protected function configure(): void
{
    $this
        ->addOption('format', 'f', InputOption::VALUE_REQUIRED, 'Output format', 'json')
        ->addOption('verbose', 'v', InputOption::VALUE_NONE, 'Verbose output')
        ->addOption('limit', 'l', InputOption::VALUE_OPTIONAL, 'Limit results', 10);
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
    $format = $input->getOption('format');
    $verbose = $input->getOption('verbose');
    $limit = $input->getOption('limit');

    // ...
}

Usage:

php bin/console my-plugin:command --format=xml
php bin/console my-plugin:command -f xml
php bin/console my-plugin:command --verbose
php bin/console my-plugin:command -v
php bin/console my-plugin:command --limit=20
php bin/console my-plugin:command -l 20

Output Formatting

// Success message
$this->io->success('Operation completed successfully');

// Error message
$this->io->error('An error occurred');

// Warning message
$this->io->warning('This is a warning');

// Note message
$this->io->note('This is a note');

// Title
$this->io->title('Section Title');

// Section header
$this->io->section('Processing data');

// Simple text
$this->io->text('Regular text output');

// Table
$this->io->table(
    ['ID', 'Name', 'Status'],
    [
        [1, 'Item 1', 'Active'],
        [2, 'Item 2', 'Inactive'],
    ]
);

// List
$this->io->listing([
    'First item',
    'Second item',
    'Third item',
]);

AbstractPluginCommand Features

The AbstractPluginCommand provides:

• $this->io: SymfonyStyle for formatted output

• $this->logInfo(): Log info messages

• $this->logError(): Log error messages

• $this->logWarning(): Log warning messages

Command Naming Convention

Commands must use {plugin-name}:{command} format:

• my-plugin:greet

• my-plugin:sync

• paypal-payment:verify-webhook

Use kebab-case for both plugin name and command name.

Running Commands

# In Docker environment
docker exec pteroca_web_dev php bin/console my-plugin:greet John

# With options
docker exec pteroca_web_dev php bin/console my-plugin:sync --verbose

# List all plugin commands
docker exec pteroca_web_dev php bin/console list my-plugin

Service Registration

Commands are auto-discovered by Symfony:

services:
    Plugins\MyPlugin\Command\:
        resource: '../../src/Command/'
        tags: ['console.command']

Related Guides

• Cron Tasks - Schedule automated tasks

• Dependencies - Inject services

• Testing - Test commands