application_2.json 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  1. {
  2. "commands": [
  3. {
  4. "name": "help",
  5. "usage": [
  6. "help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]"
  7. ],
  8. "description": "Displays help for a command",
  9. "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.",
  10. "definition": {
  11. "arguments": {
  12. "command_name": {
  13. "name": "command_name",
  14. "is_required": false,
  15. "is_array": false,
  16. "description": "The command name",
  17. "default": "help"
  18. }
  19. },
  20. "options": {
  21. "xml": {
  22. "name": "--xml",
  23. "shortcut": "",
  24. "accept_value": false,
  25. "is_value_required": false,
  26. "is_multiple": false,
  27. "description": "To output help as XML",
  28. "default": false
  29. },
  30. "format": {
  31. "name": "--format",
  32. "shortcut": "",
  33. "accept_value": true,
  34. "is_value_required": true,
  35. "is_multiple": false,
  36. "description": "The output format (txt, xml, json, or md)",
  37. "default": "txt"
  38. },
  39. "raw": {
  40. "name": "--raw",
  41. "shortcut": "",
  42. "accept_value": false,
  43. "is_value_required": false,
  44. "is_multiple": false,
  45. "description": "To output raw command help",
  46. "default": false
  47. },
  48. "help": {
  49. "name": "--help",
  50. "shortcut": "-h",
  51. "accept_value": false,
  52. "is_value_required": false,
  53. "is_multiple": false,
  54. "description": "Display this help message",
  55. "default": false
  56. },
  57. "quiet": {
  58. "name": "--quiet",
  59. "shortcut": "-q",
  60. "accept_value": false,
  61. "is_value_required": false,
  62. "is_multiple": false,
  63. "description": "Do not output any message",
  64. "default": false
  65. },
  66. "verbose": {
  67. "name": "--verbose",
  68. "shortcut": "-v|-vv|-vvv",
  69. "accept_value": false,
  70. "is_value_required": false,
  71. "is_multiple": false,
  72. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  73. "default": false
  74. },
  75. "version": {
  76. "name": "--version",
  77. "shortcut": "-V",
  78. "accept_value": false,
  79. "is_value_required": false,
  80. "is_multiple": false,
  81. "description": "Display this application version",
  82. "default": false
  83. },
  84. "ansi": {
  85. "name": "--ansi",
  86. "shortcut": "",
  87. "accept_value": false,
  88. "is_value_required": false,
  89. "is_multiple": false,
  90. "description": "Force ANSI output",
  91. "default": false
  92. },
  93. "no-ansi": {
  94. "name": "--no-ansi",
  95. "shortcut": "",
  96. "accept_value": false,
  97. "is_value_required": false,
  98. "is_multiple": false,
  99. "description": "Disable ANSI output",
  100. "default": false
  101. },
  102. "no-interaction": {
  103. "name": "--no-interaction",
  104. "shortcut": "-n",
  105. "accept_value": false,
  106. "is_value_required": false,
  107. "is_multiple": false,
  108. "description": "Do not ask any interactive question",
  109. "default": false
  110. }
  111. }
  112. }
  113. },
  114. {
  115. "name": "list",
  116. "usage": [
  117. "list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]"
  118. ],
  119. "description": "Lists commands",
  120. "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>",
  121. "definition": {
  122. "arguments": {
  123. "namespace": {
  124. "name": "namespace",
  125. "is_required": false,
  126. "is_array": false,
  127. "description": "The namespace name",
  128. "default": null
  129. }
  130. },
  131. "options": {
  132. "xml": {
  133. "name": "--xml",
  134. "shortcut": "",
  135. "accept_value": false,
  136. "is_value_required": false,
  137. "is_multiple": false,
  138. "description": "To output list as XML",
  139. "default": false
  140. },
  141. "raw": {
  142. "name": "--raw",
  143. "shortcut": "",
  144. "accept_value": false,
  145. "is_value_required": false,
  146. "is_multiple": false,
  147. "description": "To output raw command list",
  148. "default": false
  149. },
  150. "format": {
  151. "name": "--format",
  152. "shortcut": "",
  153. "accept_value": true,
  154. "is_value_required": true,
  155. "is_multiple": false,
  156. "description": "The output format (txt, xml, json, or md)",
  157. "default": "txt"
  158. }
  159. }
  160. }
  161. },
  162. {
  163. "name": "descriptor:command1",
  164. "usage": [
  165. "descriptor:command1",
  166. "alias1",
  167. "alias2"
  168. ],
  169. "description": "command 1 description",
  170. "help": "command 1 help",
  171. "definition": {
  172. "arguments": [],
  173. "options": {
  174. "help": {
  175. "name": "--help",
  176. "shortcut": "-h",
  177. "accept_value": false,
  178. "is_value_required": false,
  179. "is_multiple": false,
  180. "description": "Display this help message",
  181. "default": false
  182. },
  183. "quiet": {
  184. "name": "--quiet",
  185. "shortcut": "-q",
  186. "accept_value": false,
  187. "is_value_required": false,
  188. "is_multiple": false,
  189. "description": "Do not output any message",
  190. "default": false
  191. },
  192. "verbose": {
  193. "name": "--verbose",
  194. "shortcut": "-v|-vv|-vvv",
  195. "accept_value": false,
  196. "is_value_required": false,
  197. "is_multiple": false,
  198. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  199. "default": false
  200. },
  201. "version": {
  202. "name": "--version",
  203. "shortcut": "-V",
  204. "accept_value": false,
  205. "is_value_required": false,
  206. "is_multiple": false,
  207. "description": "Display this application version",
  208. "default": false
  209. },
  210. "ansi": {
  211. "name": "--ansi",
  212. "shortcut": "",
  213. "accept_value": false,
  214. "is_value_required": false,
  215. "is_multiple": false,
  216. "description": "Force ANSI output",
  217. "default": false
  218. },
  219. "no-ansi": {
  220. "name": "--no-ansi",
  221. "shortcut": "",
  222. "accept_value": false,
  223. "is_value_required": false,
  224. "is_multiple": false,
  225. "description": "Disable ANSI output",
  226. "default": false
  227. },
  228. "no-interaction": {
  229. "name": "--no-interaction",
  230. "shortcut": "-n",
  231. "accept_value": false,
  232. "is_value_required": false,
  233. "is_multiple": false,
  234. "description": "Do not ask any interactive question",
  235. "default": false
  236. }
  237. }
  238. }
  239. },
  240. {
  241. "name": "descriptor:command2",
  242. "usage": [
  243. "descriptor:command2 [-o|--option_name] [--] <argument_name>",
  244. "descriptor:command2 -o|--option_name <argument_name>",
  245. "descriptor:command2 <argument_name>"
  246. ],
  247. "description": "command 2 description",
  248. "help": "command 2 help",
  249. "definition": {
  250. "arguments": {
  251. "argument_name": {
  252. "name": "argument_name",
  253. "is_required": true,
  254. "is_array": false,
  255. "description": "",
  256. "default": null
  257. }
  258. },
  259. "options": {
  260. "option_name": {
  261. "name": "--option_name",
  262. "shortcut": "-o",
  263. "accept_value": false,
  264. "is_value_required": false,
  265. "is_multiple": false,
  266. "description": "",
  267. "default": false
  268. },
  269. "help": {
  270. "name": "--help",
  271. "shortcut": "-h",
  272. "accept_value": false,
  273. "is_value_required": false,
  274. "is_multiple": false,
  275. "description": "Display this help message",
  276. "default": false
  277. },
  278. "quiet": {
  279. "name": "--quiet",
  280. "shortcut": "-q",
  281. "accept_value": false,
  282. "is_value_required": false,
  283. "is_multiple": false,
  284. "description": "Do not output any message",
  285. "default": false
  286. },
  287. "verbose": {
  288. "name": "--verbose",
  289. "shortcut": "-v|-vv|-vvv",
  290. "accept_value": false,
  291. "is_value_required": false,
  292. "is_multiple": false,
  293. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  294. "default": false
  295. },
  296. "version": {
  297. "name": "--version",
  298. "shortcut": "-V",
  299. "accept_value": false,
  300. "is_value_required": false,
  301. "is_multiple": false,
  302. "description": "Display this application version",
  303. "default": false
  304. },
  305. "ansi": {
  306. "name": "--ansi",
  307. "shortcut": "",
  308. "accept_value": false,
  309. "is_value_required": false,
  310. "is_multiple": false,
  311. "description": "Force ANSI output",
  312. "default": false
  313. },
  314. "no-ansi": {
  315. "name": "--no-ansi",
  316. "shortcut": "",
  317. "accept_value": false,
  318. "is_value_required": false,
  319. "is_multiple": false,
  320. "description": "Disable ANSI output",
  321. "default": false
  322. },
  323. "no-interaction": {
  324. "name": "--no-interaction",
  325. "shortcut": "-n",
  326. "accept_value": false,
  327. "is_value_required": false,
  328. "is_multiple": false,
  329. "description": "Do not ask any interactive question",
  330. "default": false
  331. }
  332. }
  333. }
  334. }
  335. ],
  336. "namespaces": [
  337. {
  338. "id": "_global",
  339. "commands": [
  340. "alias1",
  341. "alias2",
  342. "help",
  343. "list"
  344. ]
  345. },
  346. {
  347. "id": "descriptor",
  348. "commands": [
  349. "descriptor:command1",
  350. "descriptor:command2"
  351. ]
  352. }
  353. ]
  354. }