| commit | author | age | ||
| 2207d6 | 1 | MbString åpplicätion |
| W | 2 | ==================== |
| 3 | ||
| 4 | * [`help`](#help) | |
| 5 | * [`list`](#list) | |
| 6 | ||
| 7 | **descriptor:** | |
| 8 | ||
| 9 | * [`descriptor:åèä`](#descriptoråèä) | |
| 10 | ||
| 11 | `help` | |
| 12 | ------ | |
| 13 | ||
| 14 | Displays help for a command | |
| 15 | ||
| 16 | ### Usage | |
| 17 | ||
| 18 | * `help [--format FORMAT] [--raw] [--] [<command_name>]` | |
| 19 | ||
| 20 | The help command displays help for a given command: | |
| 21 | ||
| 22 | php app/console help list | |
| 23 | ||
| 24 | You can also output the help in other formats by using the --format option: | |
| 25 | ||
| 26 | php app/console help --format=xml list | |
| 27 | ||
| 28 | To display the list of available commands, please use the list command. | |
| 29 | ||
| 30 | ### Arguments | |
| 31 | ||
| 32 | #### `command_name` | |
| 33 | ||
| 34 | The command name | |
| 35 | ||
| 36 | * Is required: no | |
| 37 | * Is array: no | |
| 38 | * Default: `'help'` | |
| 39 | ||
| 40 | ### Options | |
| 41 | ||
| 42 | #### `--format` | |
| 43 | ||
| 44 | The output format (txt, xml, json, or md) | |
| 45 | ||
| 46 | * Accept value: yes | |
| 47 | * Is value required: yes | |
| 48 | * Is multiple: no | |
| 49 | * Default: `'txt'` | |
| 50 | ||
| 51 | #### `--raw` | |
| 52 | ||
| 53 | To output raw command help | |
| 54 | ||
| 55 | * Accept value: no | |
| 56 | * Is value required: no | |
| 57 | * Is multiple: no | |
| 58 | * Default: `false` | |
| 59 | ||
| 60 | #### `--help|-h` | |
| 61 | ||
| 62 | Display this help message | |
| 63 | ||
| 64 | * Accept value: no | |
| 65 | * Is value required: no | |
| 66 | * Is multiple: no | |
| 67 | * Default: `false` | |
| 68 | ||
| 69 | #### `--quiet|-q` | |
| 70 | ||
| 71 | Do not output any message | |
| 72 | ||
| 73 | * Accept value: no | |
| 74 | * Is value required: no | |
| 75 | * Is multiple: no | |
| 76 | * Default: `false` | |
| 77 | ||
| 78 | #### `--verbose|-v|-vv|-vvv` | |
| 79 | ||
| 80 | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | |
| 81 | ||
| 82 | * Accept value: no | |
| 83 | * Is value required: no | |
| 84 | * Is multiple: no | |
| 85 | * Default: `false` | |
| 86 | ||
| 87 | #### `--version|-V` | |
| 88 | ||
| 89 | Display this application version | |
| 90 | ||
| 91 | * Accept value: no | |
| 92 | * Is value required: no | |
| 93 | * Is multiple: no | |
| 94 | * Default: `false` | |
| 95 | ||
| 96 | #### `--ansi` | |
| 97 | ||
| 98 | Force ANSI output | |
| 99 | ||
| 100 | * Accept value: no | |
| 101 | * Is value required: no | |
| 102 | * Is multiple: no | |
| 103 | * Default: `false` | |
| 104 | ||
| 105 | #### `--no-ansi` | |
| 106 | ||
| 107 | Disable ANSI output | |
| 108 | ||
| 109 | * Accept value: no | |
| 110 | * Is value required: no | |
| 111 | * Is multiple: no | |
| 112 | * Default: `false` | |
| 113 | ||
| 114 | #### `--no-interaction|-n` | |
| 115 | ||
| 116 | Do not ask any interactive question | |
| 117 | ||
| 118 | * Accept value: no | |
| 119 | * Is value required: no | |
| 120 | * Is multiple: no | |
| 121 | * Default: `false` | |
| 122 | ||
| 123 | `list` | |
| 124 | ------ | |
| 125 | ||
| 126 | Lists commands | |
| 127 | ||
| 128 | ### Usage | |
| 129 | ||
| 130 | * `list [--raw] [--format FORMAT] [--] [<namespace>]` | |
| 131 | ||
| 132 | The list command lists all commands: | |
| 133 | ||
| 134 | php app/console list | |
| 135 | ||
| 136 | You can also display the commands for a specific namespace: | |
| 137 | ||
| 138 | php app/console list test | |
| 139 | ||
| 140 | You can also output the information in other formats by using the --format option: | |
| 141 | ||
| 142 | php app/console list --format=xml | |
| 143 | ||
| 144 | It's also possible to get raw list of commands (useful for embedding command runner): | |
| 145 | ||
| 146 | php app/console list --raw | |
| 147 | ||
| 148 | ### Arguments | |
| 149 | ||
| 150 | #### `namespace` | |
| 151 | ||
| 152 | The namespace name | |
| 153 | ||
| 154 | * Is required: no | |
| 155 | * Is array: no | |
| 156 | * Default: `NULL` | |
| 157 | ||
| 158 | ### Options | |
| 159 | ||
| 160 | #### `--raw` | |
| 161 | ||
| 162 | To output raw command list | |
| 163 | ||
| 164 | * Accept value: no | |
| 165 | * Is value required: no | |
| 166 | * Is multiple: no | |
| 167 | * Default: `false` | |
| 168 | ||
| 169 | #### `--format` | |
| 170 | ||
| 171 | The output format (txt, xml, json, or md) | |
| 172 | ||
| 173 | * Accept value: yes | |
| 174 | * Is value required: yes | |
| 175 | * Is multiple: no | |
| 176 | * Default: `'txt'` | |
| 177 | ||
| 178 | `descriptor:åèä` | |
| 179 | ---------------- | |
| 180 | ||
| 181 | command åèä description | |
| 182 | ||
| 183 | ### Usage | |
| 184 | ||
| 185 | * `descriptor:åèä [-o|--option_åèä] [--] <argument_åèä>` | |
| 186 | * `descriptor:åèä -o|--option_name <argument_name>` | |
| 187 | * `descriptor:åèä <argument_name>` | |
| 188 | ||
| 189 | command åèä help | |
| 190 | ||
| 191 | ### Arguments | |
| 192 | ||
| 193 | #### `argument_åèä` | |
| 194 | ||
| 195 | * Is required: yes | |
| 196 | * Is array: no | |
| 197 | * Default: `NULL` | |
| 198 | ||
| 199 | ### Options | |
| 200 | ||
| 201 | #### `--option_åèä|-o` | |
| 202 | ||
| 203 | * Accept value: no | |
| 204 | * Is value required: no | |
| 205 | * Is multiple: no | |
| 206 | * Default: `false` | |
| 207 | ||
| 208 | #### `--help|-h` | |
| 209 | ||
| 210 | Display this help message | |
| 211 | ||
| 212 | * Accept value: no | |
| 213 | * Is value required: no | |
| 214 | * Is multiple: no | |
| 215 | * Default: `false` | |
| 216 | ||
| 217 | #### `--quiet|-q` | |
| 218 | ||
| 219 | Do not output any message | |
| 220 | ||
| 221 | * Accept value: no | |
| 222 | * Is value required: no | |
| 223 | * Is multiple: no | |
| 224 | * Default: `false` | |
| 225 | ||
| 226 | #### `--verbose|-v|-vv|-vvv` | |
| 227 | ||
| 228 | Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug | |
| 229 | ||
| 230 | * Accept value: no | |
| 231 | * Is value required: no | |
| 232 | * Is multiple: no | |
| 233 | * Default: `false` | |
| 234 | ||
| 235 | #### `--version|-V` | |
| 236 | ||
| 237 | Display this application version | |
| 238 | ||
| 239 | * Accept value: no | |
| 240 | * Is value required: no | |
| 241 | * Is multiple: no | |
| 242 | * Default: `false` | |
| 243 | ||
| 244 | #### `--ansi` | |
| 245 | ||
| 246 | Force ANSI output | |
| 247 | ||
| 248 | * Accept value: no | |
| 249 | * Is value required: no | |
| 250 | * Is multiple: no | |
| 251 | * Default: `false` | |
| 252 | ||
| 253 | #### `--no-ansi` | |
| 254 | ||
| 255 | Disable ANSI output | |
| 256 | ||
| 257 | * Accept value: no | |
| 258 | * Is value required: no | |
| 259 | * Is multiple: no | |
| 260 | * Default: `false` | |
| 261 | ||
| 262 | #### `--no-interaction|-n` | |
| 263 | ||
| 264 | Do not ask any interactive question | |
| 265 | ||
| 266 | * Accept value: no | |
| 267 | * Is value required: no | |
| 268 | * Is multiple: no | |
| 269 | * Default: `false` | |
