355 lines
15 KiB
JSON
355 lines
15 KiB
JSON
{
|
|
"commands": [
|
|
{
|
|
"name": "help",
|
|
"usage": [
|
|
"help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]"
|
|
],
|
|
"description": "Displays help for a command",
|
|
"help": "The <info>help<\/info> command displays help for a given command:\n\n <info>php app\/console help list<\/info>\n\nYou can also output the help in other formats by using the <comment>--format<\/comment> option:\n\n <info>php app\/console help --format=xml list<\/info>\n\nTo display the list of available commands, please use the <info>list<\/info> command.",
|
|
"definition": {
|
|
"arguments": {
|
|
"command_name": {
|
|
"name": "command_name",
|
|
"is_required": false,
|
|
"is_array": false,
|
|
"description": "The command name",
|
|
"default": "help"
|
|
}
|
|
},
|
|
"options": {
|
|
"xml": {
|
|
"name": "--xml",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "To output help as XML",
|
|
"default": false
|
|
},
|
|
"format": {
|
|
"name": "--format",
|
|
"shortcut": "",
|
|
"accept_value": true,
|
|
"is_value_required": true,
|
|
"is_multiple": false,
|
|
"description": "The output format (txt, xml, json, or md)",
|
|
"default": "txt"
|
|
},
|
|
"raw": {
|
|
"name": "--raw",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "To output raw command help",
|
|
"default": false
|
|
},
|
|
"help": {
|
|
"name": "--help",
|
|
"shortcut": "-h",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Display this help message",
|
|
"default": false
|
|
},
|
|
"quiet": {
|
|
"name": "--quiet",
|
|
"shortcut": "-q",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Do not output any message",
|
|
"default": false
|
|
},
|
|
"verbose": {
|
|
"name": "--verbose",
|
|
"shortcut": "-v|-vv|-vvv",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
|
|
"default": false
|
|
},
|
|
"version": {
|
|
"name": "--version",
|
|
"shortcut": "-V",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Display this application version",
|
|
"default": false
|
|
},
|
|
"ansi": {
|
|
"name": "--ansi",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Force ANSI output",
|
|
"default": false
|
|
},
|
|
"no-ansi": {
|
|
"name": "--no-ansi",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Disable ANSI output",
|
|
"default": false
|
|
},
|
|
"no-interaction": {
|
|
"name": "--no-interaction",
|
|
"shortcut": "-n",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Do not ask any interactive question",
|
|
"default": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "list",
|
|
"usage": [
|
|
"list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]"
|
|
],
|
|
"description": "Lists commands",
|
|
"help": "The <info>list<\/info> command lists all commands:\n\n <info>php app\/console list<\/info>\n\nYou can also display the commands for a specific namespace:\n\n <info>php app\/console list test<\/info>\n\nYou can also output the information in other formats by using the <comment>--format<\/comment> option:\n\n <info>php app\/console list --format=xml<\/info>\n\nIt's also possible to get raw list of commands (useful for embedding command runner):\n\n <info>php app\/console list --raw<\/info>",
|
|
"definition": {
|
|
"arguments": {
|
|
"namespace": {
|
|
"name": "namespace",
|
|
"is_required": false,
|
|
"is_array": false,
|
|
"description": "The namespace name",
|
|
"default": null
|
|
}
|
|
},
|
|
"options": {
|
|
"xml": {
|
|
"name": "--xml",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "To output list as XML",
|
|
"default": false
|
|
},
|
|
"raw": {
|
|
"name": "--raw",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "To output raw command list",
|
|
"default": false
|
|
},
|
|
"format": {
|
|
"name": "--format",
|
|
"shortcut": "",
|
|
"accept_value": true,
|
|
"is_value_required": true,
|
|
"is_multiple": false,
|
|
"description": "The output format (txt, xml, json, or md)",
|
|
"default": "txt"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "descriptor:command1",
|
|
"usage": [
|
|
"descriptor:command1",
|
|
"alias1",
|
|
"alias2"
|
|
],
|
|
"description": "command 1 description",
|
|
"help": "command 1 help",
|
|
"definition": {
|
|
"arguments": [],
|
|
"options": {
|
|
"help": {
|
|
"name": "--help",
|
|
"shortcut": "-h",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Display this help message",
|
|
"default": false
|
|
},
|
|
"quiet": {
|
|
"name": "--quiet",
|
|
"shortcut": "-q",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Do not output any message",
|
|
"default": false
|
|
},
|
|
"verbose": {
|
|
"name": "--verbose",
|
|
"shortcut": "-v|-vv|-vvv",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
|
|
"default": false
|
|
},
|
|
"version": {
|
|
"name": "--version",
|
|
"shortcut": "-V",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Display this application version",
|
|
"default": false
|
|
},
|
|
"ansi": {
|
|
"name": "--ansi",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Force ANSI output",
|
|
"default": false
|
|
},
|
|
"no-ansi": {
|
|
"name": "--no-ansi",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Disable ANSI output",
|
|
"default": false
|
|
},
|
|
"no-interaction": {
|
|
"name": "--no-interaction",
|
|
"shortcut": "-n",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Do not ask any interactive question",
|
|
"default": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "descriptor:command2",
|
|
"usage": [
|
|
"descriptor:command2 [-o|--option_name] [--] <argument_name>",
|
|
"descriptor:command2 -o|--option_name <argument_name>",
|
|
"descriptor:command2 <argument_name>"
|
|
],
|
|
"description": "command 2 description",
|
|
"help": "command 2 help",
|
|
"definition": {
|
|
"arguments": {
|
|
"argument_name": {
|
|
"name": "argument_name",
|
|
"is_required": true,
|
|
"is_array": false,
|
|
"description": "",
|
|
"default": null
|
|
}
|
|
},
|
|
"options": {
|
|
"option_name": {
|
|
"name": "--option_name",
|
|
"shortcut": "-o",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "",
|
|
"default": false
|
|
},
|
|
"help": {
|
|
"name": "--help",
|
|
"shortcut": "-h",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Display this help message",
|
|
"default": false
|
|
},
|
|
"quiet": {
|
|
"name": "--quiet",
|
|
"shortcut": "-q",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Do not output any message",
|
|
"default": false
|
|
},
|
|
"verbose": {
|
|
"name": "--verbose",
|
|
"shortcut": "-v|-vv|-vvv",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
|
|
"default": false
|
|
},
|
|
"version": {
|
|
"name": "--version",
|
|
"shortcut": "-V",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Display this application version",
|
|
"default": false
|
|
},
|
|
"ansi": {
|
|
"name": "--ansi",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Force ANSI output",
|
|
"default": false
|
|
},
|
|
"no-ansi": {
|
|
"name": "--no-ansi",
|
|
"shortcut": "",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Disable ANSI output",
|
|
"default": false
|
|
},
|
|
"no-interaction": {
|
|
"name": "--no-interaction",
|
|
"shortcut": "-n",
|
|
"accept_value": false,
|
|
"is_value_required": false,
|
|
"is_multiple": false,
|
|
"description": "Do not ask any interactive question",
|
|
"default": false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"namespaces": [
|
|
{
|
|
"id": "_global",
|
|
"commands": [
|
|
"alias1",
|
|
"alias2",
|
|
"help",
|
|
"list"
|
|
]
|
|
},
|
|
{
|
|
"id": "descriptor",
|
|
"commands": [
|
|
"descriptor:command1",
|
|
"descriptor:command2"
|
|
]
|
|
}
|
|
]
|
|
}
|