Warning: You are browsing the documentation for Symfony 3.0, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

The Console Component

3.0 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

The Console Component

The Console Component¶

The Console component eases the creation of beautiful and testable command line interfaces.

The Console component allows you to create command-line commands. Your console commands can be used for any recurring task, such as cronjobs, imports, or other batch jobs.

Installation¶

You can install the component in 2 different ways:

Install it via Composer (symfony/console on Packagist);
Use the official Git repository (https://github.com/symfony/console).

Then, require the vendor/autoload.php file to enable the autoloading mechanism provided by Composer. Otherwise, your application won’t be able to find the classes of this Symfony component.

Creating a Console Application¶

First, you need to create a PHP script to define the console application:

#!/usr/bin/env php
<?php
// application.php

require __DIR__.'/vendor/autoload.php';

use Symfony\Component\Console\Application;

$application = new Application();

// ... register commands

$application->run();

Then, you can register the commands using add():

// ...
$application->add(new GenerateAdminCommand());

See the Console Commands article for information about how to create commands.

Learn more¶

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.