Using Console Commands, Shortcuts and Built-in Commands
Edit this pageWarning: You are browsing the documentation for Symfony 2.2, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (the current stable version).
Using Console Commands, Shortcuts and Built-in Commands
In addition to the options you specify for your commands, there are some built-in options as well as a couple of built-in commands for the Console component.
Note
These examples assume you have added a file app/console to run at
the cli:
1 2 3 4 5 6 7 8 9
#!/usr/bin/env php
# app/console
<?php
use Symfony\Component\Console\Application;
$application = new Application();
// ...
$application->run();Built-in Commands
There is a built-in command list which outputs all the standard options
and the registered commands:
1
$ php app/console listYou can get the same output by not running any command as well
1
$ php app/consoleThe help command lists the help information for the specified command. For
example, to get the help for the list command:
1
$ php app/console help listRunning help without specifying a command will list the global options:
1
$ php app/console helpGlobal Options
You can get help information for any command with the --help option. To
get help for the list command:
1 2
$ php app/console list --help
$ php app/console list -hYou can suppress output with:
1 2
$ php app/console list --quiet
$ php app/console list -qYou can get more verbose messages (if this is supported for a command) with:
1 2
$ php app/console list --verbose
$ php app/console list -vIf you set the optional arguments to give your application a name and version:
1
$application = new Application('Acme Console Application', '1.2');then you can use:
1 2
$ php app/console list --version
$ php app/console list -Vto get this information output:
1
Acme Console Application version 1.2If you do not provide both arguments then it will just output:
1
console toolYou can force turning on ANSI output coloring with:
1
$ php app/console list --ansior turn it off with:
1
$ php app/console list --no-ansiYou can suppress any interactive questions from the command you are running with:
1 2
$ php app/console list --no-interaction
$ php app/console list -nShortcut Syntax
You do not have to type out the full command names. You can just type the
shortest unambiguous name to run a command. So if there are non-clashing
commands, then you can run help like this:
1
$ php app/console hIf you have commands using : to namespace commands then you just have
to type the shortest unambiguous text for each part. If you have created the
demo:greet as shown in The Console Component then you
can run it with:
1
$ php app/console d:g FabienIf you enter a short command that's ambiguous (i.e. there are more than one command that match), then no command will be run and some suggestions of the possible commands to choose from will be output.
