1 <?xml version="1.0" encoding="UTF-8"?>
4 <command id="help" name="help">
6 <usage>help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]</usage>
8 <description>Displays help for a command</description>
9 <help>The <info>help</info> command displays help for a given command:
11 <info>php app/console help list</info>
13 You can also output the help in other formats by using the <comment>--format</comment> option:
15 <info>php app/console help --format=xml list</info>
17 To display the list of available commands, please use the <info>list</info> command.</help>
19 <argument name="command_name" is_required="0" is_array="0">
20 <description>The command name</description>
22 <default>help</default>
27 <option name="--xml" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
28 <description>To output help as XML</description>
30 <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
31 <description>The output format (txt, xml, json, or md)</description>
33 <default>txt</default>
36 <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
37 <description>To output raw command help</description>
39 <option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
40 <description>Display this help message</description>
42 <option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
43 <description>Do not output any message</description>
45 <option name="--verbose" shortcut="-v" shortcuts="-v|-vv|-vvv" accept_value="0" is_value_required="0" is_multiple="0">
46 <description>Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug</description>
48 <option name="--version" shortcut="-V" accept_value="0" is_value_required="0" is_multiple="0">
49 <description>Display this application version</description>
51 <option name="--ansi" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
52 <description>Force ANSI output</description>
54 <option name="--no-ansi" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
55 <description>Disable ANSI output</description>
57 <option name="--no-interaction" shortcut="-n" accept_value="0" is_value_required="0" is_multiple="0">
58 <description>Do not ask any interactive question</description>
62 <command id="list" name="list">
64 <usage>list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]</usage>
66 <description>Lists commands</description>
67 <help>The <info>list</info> command lists all commands:
69 <info>php app/console list</info>
71 You can also display the commands for a specific namespace:
73 <info>php app/console list test</info>
75 You can also output the information in other formats by using the <comment>--format</comment> option:
77 <info>php app/console list --format=xml</info>
79 It's also possible to get raw list of commands (useful for embedding command runner):
81 <info>php app/console list --raw</info></help>
83 <argument name="namespace" is_required="0" is_array="0">
84 <description>The namespace name</description>
89 <option name="--xml" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
90 <description>To output list as XML</description>
92 <option name="--raw" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
93 <description>To output raw command list</description>
95 <option name="--format" shortcut="" accept_value="1" is_value_required="1" is_multiple="0">
96 <description>The output format (txt, xml, json, or md)</description>
98 <default>txt</default>
103 <command id="foo:bar" name="foo:bar">
105 <usage>foo:bar</usage>
106 <usage>afoobar</usage>
108 <description>The foo:bar command</description>
109 <help>The foo:bar command</help>
112 <option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
113 <description>Display this help message</description>
115 <option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
116 <description>Do not output any message</description>
118 <option name="--verbose" shortcut="-v" shortcuts="-v|-vv|-vvv" accept_value="0" is_value_required="0" is_multiple="0">
119 <description>Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug</description>
121 <option name="--version" shortcut="-V" accept_value="0" is_value_required="0" is_multiple="0">
122 <description>Display this application version</description>
124 <option name="--ansi" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
125 <description>Force ANSI output</description>
127 <option name="--no-ansi" shortcut="" accept_value="0" is_value_required="0" is_multiple="0">
128 <description>Disable ANSI output</description>
130 <option name="--no-interaction" shortcut="-n" accept_value="0" is_value_required="0" is_multiple="0">
131 <description>Do not ask any interactive question</description>
137 <namespace id="_global">
138 <command>afoobar</command>
139 <command>help</command>
140 <command>list</command>
143 <command>foo:bar</command>