Skip to content

Adding another page to the console section with info on general usage #1664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 9, 2012
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions components/console/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Config
======

.. toctree::
:maxdepth: 2

introduction
usage
File renamed without changes.
142 changes: 142 additions & 0 deletions components/console/usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
.. index::
single: Console; Usage

Console Usage
=============

As well as the options you specify for the commands you add there are some
built 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::

#!/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:

.. code-block:: bash

$ php app/console list

You can get the same output by not running any command as well

.. code-block:: bash

$ php app/console

The help command lists the help information for the specified command. For
example, to get the help for the ``list`` command:

.. code-block:: bash

$ php app/console help list

Running ``help`` without specifying a command will list the global options:

.. code-block:: bash

$ php app/console help

Global Options
~~~~~~~~~~~~~~

You can get help information for any command with the ``--help`` option, to
get help for the list command:

.. code-block:: bash

$ php app/console list --help
$ php app/console list -h

You can suppress output with:

.. code-block:: bash

$ php app/console list --quiet
$ php app/console list -q

You can get more verbose messages (where this is supported for a command)
with:

.. code-block:: bash

$ php app/console list -verbose
$ php app/console list -v

If you set the optional arguments to give your application a name and version::

$application = new Application('Acme Console Application', '1.2');

then you can use:

.. code-block:: bash

$ php app/console list -version
$ php app/console list -V

to get this information output:

.. code-block:: text

Acme Console Application version 1.2

If you do not provide both arguments then it will just output:

.. code-block:: text

console tool

You can force turning on ANSI output coloring with:

.. code-block:: bash

$ php app/console list -ansi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is --ansi


or turn it off with:

.. code-block:: bash

$ php app/console list -no-ansi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sale here: --no-ansi


You can suppress any interactive questions from the command you are running with:

.. code-block:: bash

$ php app/console list --no-interaction
$ php app/console list -n

Shortcut 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:

.. code-block:: bash

$ php app/console h

If 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 :doc:`/components/console/introduction` then you
can run it with:

.. code-block:: bash

$ php app/console d:g Fabien

If you choose too short a command so it is ambiguous then no command will be run and
some suggestions of the possible commands to choose from will be output.
5 changes: 3 additions & 2 deletions components/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@
* :doc:`/components/config/caching`
* :doc:`/components/config/definition`

* **The Console Component**
* :doc:`/components/console/index`

* :doc:`/components/console`
* :doc:`/components/console/introduction`
* :doc:`/components/console/usage`

* **The CSS Selector Component**

Expand Down
1 change: 1 addition & 0 deletions redirection_map
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
/components/dependency_injection /components/dependency_injection/introduction
/components/event_dispatcher /components/event_dispatcher/introduction
/components/http_foundation /components/http_foundation/introduction
/components/dependency_injection /components/console/introduction
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks wrong