| commit | author | age | ||
| 2207d6 | 1 | My Symfony application v1.0 |
| W | 2 | =========================== |
| 3 | ||
| 4 | * [`alias1`](#descriptorcommand1) | |
| 5 | * [`alias2`](#descriptorcommand1) | |
| 6 | * [`help`](#help) | |
| 7 | * [`list`](#list) | |
| 8 | ||
| 9 | **command4:** | |
| 10 | ||
| 11 | * [`command4:descriptor`](#descriptorcommand4) | |
| 12 | ||
| 13 | **descriptor:** | |
| 14 | ||
| 15 | * [`descriptor:alias_command4`](#descriptorcommand4) | |
| 16 | * [`descriptor:command1`](#descriptorcommand1) | |
| 17 | * [`descriptor:command2`](#descriptorcommand2) | |
| 18 | * [`descriptor:command4`](#descriptorcommand4) | |
| 19 | ||
| 20 | `help` | |
| 21 | ------ | |
| 22 | ||
| 23 | Displays help for a command | |
| 24 | ||
| 25 | ### Usage | |
| 26 | ||
| 27 | * `help [--format FORMAT] [--raw] [--] [<command_name>]` | |
| 28 | ||
| 29 | The help command displays help for a given command: | |
| 30 | ||
| 31 | php app/console help list | |
| 32 | ||
| 33 | You can also output the help in other formats by using the --format option: | |
| 34 | ||
| 35 | php app/console help --format=xml list | |
| 36 | ||
| 37 | To display the list of available commands, please use the list command. | |
| 38 | ||
| 39 | ### Arguments | |
| 40 | ||
| 41 | #### `command_name` | |
| 42 | ||
| 43 | The command name | |
| 44 | ||
| 45 | * Is required: no | |
| 46 | * Is array: no | |
| 47 | * Default: `'help'` | |
| 48 | ||
| 49 | ### Options | |
| 50 | ||
| 51 | #### `--format` | |
| 52 | ||
| 53 | The output format (txt, xml, json, or md) | |
| 54 | ||
| 55 | * Accept value: yes | |
| 56 | * Is value required: yes | |
| 57 | * Is multiple: no | |
| 58 | * Default: `'txt'` | |
| 59 | ||
| 60 | #### `--raw` | |
| 61 | ||
| 62 | To output raw command help | |
| 63 | ||
| 64 | * Accept value: no | |
| 65 | * Is value required: no | |
| 66 | * Is multiple: no | |
| 67 | * Default: `false` | |
| 68 | ||
| 69 | #### `--help|-h` | |
| 70 | ||
| 71 | Display this help message | |
| 72 | ||
| 73 | * Accept value: no | |
| 74 | * Is value required: no | |
| 75 | * Is multiple: no | |
| 76 | * Default: `false` | |
| 77 | ||
| 78 | #### `--quiet|-q` | |
| 79 | ||
| 80 | Do not output any message | |
| 81 | ||
| 82 | * Accept value: no | |
| 83 | * Is value required: no | |
| 84 | * Is multiple: no | |
| 85 | * Default: `false` | |
| 86 | ||
| 87 | #### `--verbose|-v|-vv|-vvv` | |
| 88 | ||
| 89 | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | |
| 90 | ||
| 91 | * Accept value: no | |
| 92 | * Is value required: no | |
| 93 | * Is multiple: no | |
| 94 | * Default: `false` | |
| 95 | ||
| 96 | #### `--version|-V` | |
| 97 | ||
| 98 | Display this application version | |
| 99 | ||
| 100 | * Accept value: no | |
| 101 | * Is value required: no | |
| 102 | * Is multiple: no | |
| 103 | * Default: `false` | |
| 104 | ||
| 105 | #### `--ansi` | |
| 106 | ||
| 107 | Force ANSI output | |
| 108 | ||
| 109 | * Accept value: no | |
| 110 | * Is value required: no | |
| 111 | * Is multiple: no | |
| 112 | * Default: `false` | |
| 113 | ||
| 114 | #### `--no-ansi` | |
| 115 | ||
| 116 | Disable ANSI output | |
| 117 | ||
| 118 | * Accept value: no | |
| 119 | * Is value required: no | |
| 120 | * Is multiple: no | |
| 121 | * Default: `false` | |
| 122 | ||
| 123 | #### `--no-interaction|-n` | |
| 124 | ||
| 125 | Do not ask any interactive question | |
| 126 | ||
| 127 | * Accept value: no | |
| 128 | * Is value required: no | |
| 129 | * Is multiple: no | |
| 130 | * Default: `false` | |
| 131 | ||
| 132 | `list` | |
| 133 | ------ | |
| 134 | ||
| 135 | Lists commands | |
| 136 | ||
| 137 | ### Usage | |
| 138 | ||
| 139 | * `list [--raw] [--format FORMAT] [--] [<namespace>]` | |
| 140 | ||
| 141 | The list command lists all commands: | |
| 142 | ||
| 143 | php app/console list | |
| 144 | ||
| 145 | You can also display the commands for a specific namespace: | |
| 146 | ||
| 147 | php app/console list test | |
| 148 | ||
| 149 | You can also output the information in other formats by using the --format option: | |
| 150 | ||
| 151 | php app/console list --format=xml | |
| 152 | ||
| 153 | It's also possible to get raw list of commands (useful for embedding command runner): | |
| 154 | ||
| 155 | php app/console list --raw | |
| 156 | ||
| 157 | ### Arguments | |
| 158 | ||
| 159 | #### `namespace` | |
| 160 | ||
| 161 | The namespace name | |
| 162 | ||
| 163 | * Is required: no | |
| 164 | * Is array: no | |
| 165 | * Default: `NULL` | |
| 166 | ||
| 167 | ### Options | |
| 168 | ||
| 169 | #### `--raw` | |
| 170 | ||
| 171 | To output raw command list | |
| 172 | ||
| 173 | * Accept value: no | |
| 174 | * Is value required: no | |
| 175 | * Is multiple: no | |
| 176 | * Default: `false` | |
| 177 | ||
| 178 | #### `--format` | |
| 179 | ||
| 180 | The output format (txt, xml, json, or md) | |
| 181 | ||
| 182 | * Accept value: yes | |
| 183 | * Is value required: yes | |
| 184 | * Is multiple: no | |
| 185 | * Default: `'txt'` | |
| 186 | ||
| 187 | `descriptor:command1` | |
| 188 | --------------------- | |
| 189 | ||
| 190 | command 1 description | |
| 191 | ||
| 192 | ### Usage | |
| 193 | ||
| 194 | * `descriptor:command1` | |
| 195 | * `alias1` | |
| 196 | * `alias2` | |
| 197 | ||
| 198 | command 1 help | |
| 199 | ||
| 200 | ### Options | |
| 201 | ||
| 202 | #### `--help|-h` | |
| 203 | ||
| 204 | Display this help message | |
| 205 | ||
| 206 | * Accept value: no | |
| 207 | * Is value required: no | |
| 208 | * Is multiple: no | |
| 209 | * Default: `false` | |
| 210 | ||
| 211 | #### `--quiet|-q` | |
| 212 | ||
| 213 | Do not output any message | |
| 214 | ||
| 215 | * Accept value: no | |
| 216 | * Is value required: no | |
| 217 | * Is multiple: no | |
| 218 | * Default: `false` | |
| 219 | ||
| 220 | #### `--verbose|-v|-vv|-vvv` | |
| 221 | ||
| 222 | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | |
| 223 | ||
| 224 | * Accept value: no | |
| 225 | * Is value required: no | |
| 226 | * Is multiple: no | |
| 227 | * Default: `false` | |
| 228 | ||
| 229 | #### `--version|-V` | |
| 230 | ||
| 231 | Display this application version | |
| 232 | ||
| 233 | * Accept value: no | |
| 234 | * Is value required: no | |
| 235 | * Is multiple: no | |
| 236 | * Default: `false` | |
| 237 | ||
| 238 | #### `--ansi` | |
| 239 | ||
| 240 | Force ANSI output | |
| 241 | ||
| 242 | * Accept value: no | |
| 243 | * Is value required: no | |
| 244 | * Is multiple: no | |
| 245 | * Default: `false` | |
| 246 | ||
| 247 | #### `--no-ansi` | |
| 248 | ||
| 249 | Disable ANSI output | |
| 250 | ||
| 251 | * Accept value: no | |
| 252 | * Is value required: no | |
| 253 | * Is multiple: no | |
| 254 | * Default: `false` | |
| 255 | ||
| 256 | #### `--no-interaction|-n` | |
| 257 | ||
| 258 | Do not ask any interactive question | |
| 259 | ||
| 260 | * Accept value: no | |
| 261 | * Is value required: no | |
| 262 | * Is multiple: no | |
| 263 | * Default: `false` | |
| 264 | ||
| 265 | `descriptor:command2` | |
| 266 | --------------------- | |
| 267 | ||
| 268 | command 2 description | |
| 269 | ||
| 270 | ### Usage | |
| 271 | ||
| 272 | * `descriptor:command2 [-o|--option_name] [--] <argument_name>` | |
| 273 | * `descriptor:command2 -o|--option_name <argument_name>` | |
| 274 | * `descriptor:command2 <argument_name>` | |
| 275 | ||
| 276 | command 2 help | |
| 277 | ||
| 278 | ### Arguments | |
| 279 | ||
| 280 | #### `argument_name` | |
| 281 | ||
| 282 | * Is required: yes | |
| 283 | * Is array: no | |
| 284 | * Default: `NULL` | |
| 285 | ||
| 286 | ### Options | |
| 287 | ||
| 288 | #### `--option_name|-o` | |
| 289 | ||
| 290 | * Accept value: no | |
| 291 | * Is value required: no | |
| 292 | * Is multiple: no | |
| 293 | * Default: `false` | |
| 294 | ||
| 295 | #### `--help|-h` | |
| 296 | ||
| 297 | Display this help message | |
| 298 | ||
| 299 | * Accept value: no | |
| 300 | * Is value required: no | |
| 301 | * Is multiple: no | |
| 302 | * Default: `false` | |
| 303 | ||
| 304 | #### `--quiet|-q` | |
| 305 | ||
| 306 | Do not output any message | |
| 307 | ||
| 308 | * Accept value: no | |
| 309 | * Is value required: no | |
| 310 | * Is multiple: no | |
| 311 | * Default: `false` | |
| 312 | ||
| 313 | #### `--verbose|-v|-vv|-vvv` | |
| 314 | ||
| 315 | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | |
| 316 | ||
| 317 | * Accept value: no | |
| 318 | * Is value required: no | |
| 319 | * Is multiple: no | |
| 320 | * Default: `false` | |
| 321 | ||
| 322 | #### `--version|-V` | |
| 323 | ||
| 324 | Display this application version | |
| 325 | ||
| 326 | * Accept value: no | |
| 327 | * Is value required: no | |
| 328 | * Is multiple: no | |
| 329 | * Default: `false` | |
| 330 | ||
| 331 | #### `--ansi` | |
| 332 | ||
| 333 | Force ANSI output | |
| 334 | ||
| 335 | * Accept value: no | |
| 336 | * Is value required: no | |
| 337 | * Is multiple: no | |
| 338 | * Default: `false` | |
| 339 | ||
| 340 | #### `--no-ansi` | |
| 341 | ||
| 342 | Disable ANSI output | |
| 343 | ||
| 344 | * Accept value: no | |
| 345 | * Is value required: no | |
| 346 | * Is multiple: no | |
| 347 | * Default: `false` | |
| 348 | ||
| 349 | #### `--no-interaction|-n` | |
| 350 | ||
| 351 | Do not ask any interactive question | |
| 352 | ||
| 353 | * Accept value: no | |
| 354 | * Is value required: no | |
| 355 | * Is multiple: no | |
| 356 | * Default: `false` | |
| 357 | ||
| 358 | `descriptor:command4` | |
| 359 | --------------------- | |
| 360 | ||
| 361 | ### Usage | |
| 362 | ||
| 363 | * `descriptor:command4` | |
| 364 | * `descriptor:alias_command4` | |
| 365 | * `command4:descriptor` | |
| 366 | ||
| 367 | ||
| 368 | ### Options | |
| 369 | ||
| 370 | #### `--help|-h` | |
| 371 | ||
| 372 | Display this help message | |
| 373 | ||
| 374 | * Accept value: no | |
| 375 | * Is value required: no | |
| 376 | * Is multiple: no | |
| 377 | * Default: `false` | |
| 378 | ||
| 379 | #### `--quiet|-q` | |
| 380 | ||
| 381 | Do not output any message | |
| 382 | ||
| 383 | * Accept value: no | |
| 384 | * Is value required: no | |
| 385 | * Is multiple: no | |
| 386 | * Default: `false` | |
| 387 | ||
| 388 | #### `--verbose|-v|-vv|-vvv` | |
| 389 | ||
| 390 | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | |
| 391 | ||
| 392 | * Accept value: no | |
| 393 | * Is value required: no | |
| 394 | * Is multiple: no | |
| 395 | * Default: `false` | |
| 396 | ||
| 397 | #### `--version|-V` | |
| 398 | ||
| 399 | Display this application version | |
| 400 | ||
| 401 | * Accept value: no | |
| 402 | * Is value required: no | |
| 403 | * Is multiple: no | |
| 404 | * Default: `false` | |
| 405 | ||
| 406 | #### `--ansi` | |
| 407 | ||
| 408 | Force ANSI output | |
| 409 | ||
| 410 | * Accept value: no | |
| 411 | * Is value required: no | |
| 412 | * Is multiple: no | |
| 413 | * Default: `false` | |
| 414 | ||
| 415 | #### `--no-ansi` | |
| 416 | ||
| 417 | Disable ANSI output | |
| 418 | ||
| 419 | * Accept value: no | |
| 420 | * Is value required: no | |
| 421 | * Is multiple: no | |
| 422 | * Default: `false` | |
| 423 | ||
| 424 | #### `--no-interaction|-n` | |
| 425 | ||
| 426 | Do not ask any interactive question | |
| 427 | ||
| 428 | * Accept value: no | |
| 429 | * Is value required: no | |
| 430 | * Is multiple: no | |
| 431 | * Default: `false` | |
