Console

[READ-ONLY] Subtree split of the Symfony Console Component -- clone into Symfony/Component/ (master at symfony/symfony)

Console Component

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

The Application object manages the CLI application:

use Symfony\Component\Console\Application;

$console = new Application();
$console->run();

The run() method parses the arguments and options passed on the command line and executes the right command.

Registering a new command can easily be done via the register() method, which returns a Command instance:

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

$console
    ->register('ls')
    ->setDefinition(array(
        new InputArgument('dir', InputArgument::REQUIRED, 'Directory name'),
    ))
    ->setDescription('Displays the files in the given directory')
    ->setCode(function (InputInterface $input, OutputInterface $output) {
        $dir = $input->getArgument('dir');

        $output->writeln(sprintf('Dir listing for <info>%s</info>', $dir));
    })
;

You can also register new commands via classes.

The component provides a lot of features like output coloring, input and output abstractions (so that you can easily unit-test your commands), validation, automatic help messages, …

Resources

You can run the unit tests with the following command:

phpunit -c src/Symfony/Component/Console/

Related Repositories

kafka-web-console

kafka-web-console

A web console for Apache Kafka (retired) ...

heroku-fucking-console

heroku-fucking-console

When I run heroku console, I want a fucking console, dammit ...

console-dot-frog

console-dot-frog

Forget console logs, console.frog is where its all at! ...

console-object

console-object

documented window.console behavior - console object standard proposal ...

console.snapshot

console.snapshot

An actual useful fork of the console.image. Snapshot the canvas and output it to the console. ...