application_2.json 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510
  1. {
  2. "application": {
  3. "name": "My Symfony application",
  4. "version": "v1.0"
  5. },
  6. "commands": [
  7. {
  8. "name": "help",
  9. "hidden": false,
  10. "usage": [
  11. "help [--format FORMAT] [--raw] [--] [<command_name>]"
  12. ],
  13. "description": "Displays help for a command",
  14. "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.",
  15. "definition": {
  16. "arguments": {
  17. "command_name": {
  18. "name": "command_name",
  19. "is_required": false,
  20. "is_array": false,
  21. "description": "The command name",
  22. "default": "help"
  23. }
  24. },
  25. "options": {
  26. "format": {
  27. "name": "--format",
  28. "shortcut": "",
  29. "accept_value": true,
  30. "is_value_required": true,
  31. "is_multiple": false,
  32. "description": "The output format (txt, xml, json, or md)",
  33. "default": "txt"
  34. },
  35. "raw": {
  36. "name": "--raw",
  37. "shortcut": "",
  38. "accept_value": false,
  39. "is_value_required": false,
  40. "is_multiple": false,
  41. "description": "To output raw command help",
  42. "default": false
  43. },
  44. "help": {
  45. "name": "--help",
  46. "shortcut": "-h",
  47. "accept_value": false,
  48. "is_value_required": false,
  49. "is_multiple": false,
  50. "description": "Display this help message",
  51. "default": false
  52. },
  53. "quiet": {
  54. "name": "--quiet",
  55. "shortcut": "-q",
  56. "accept_value": false,
  57. "is_value_required": false,
  58. "is_multiple": false,
  59. "description": "Do not output any message",
  60. "default": false
  61. },
  62. "verbose": {
  63. "name": "--verbose",
  64. "shortcut": "-v|-vv|-vvv",
  65. "accept_value": false,
  66. "is_value_required": false,
  67. "is_multiple": false,
  68. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  69. "default": false
  70. },
  71. "version": {
  72. "name": "--version",
  73. "shortcut": "-V",
  74. "accept_value": false,
  75. "is_value_required": false,
  76. "is_multiple": false,
  77. "description": "Display this application version",
  78. "default": false
  79. },
  80. "ansi": {
  81. "name": "--ansi",
  82. "shortcut": "",
  83. "accept_value": false,
  84. "is_value_required": false,
  85. "is_multiple": false,
  86. "description": "Force ANSI output",
  87. "default": false
  88. },
  89. "no-ansi": {
  90. "name": "--no-ansi",
  91. "shortcut": "",
  92. "accept_value": false,
  93. "is_value_required": false,
  94. "is_multiple": false,
  95. "description": "Disable ANSI output",
  96. "default": false
  97. },
  98. "no-interaction": {
  99. "name": "--no-interaction",
  100. "shortcut": "-n",
  101. "accept_value": false,
  102. "is_value_required": false,
  103. "is_multiple": false,
  104. "description": "Do not ask any interactive question",
  105. "default": false
  106. }
  107. }
  108. }
  109. },
  110. {
  111. "name": "list",
  112. "hidden": false,
  113. "usage": [
  114. "list [--raw] [--format FORMAT] [--] [<namespace>]"
  115. ],
  116. "description": "Lists commands",
  117. "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>",
  118. "definition": {
  119. "arguments": {
  120. "namespace": {
  121. "name": "namespace",
  122. "is_required": false,
  123. "is_array": false,
  124. "description": "The namespace name",
  125. "default": null
  126. }
  127. },
  128. "options": {
  129. "raw": {
  130. "name": "--raw",
  131. "shortcut": "",
  132. "accept_value": false,
  133. "is_value_required": false,
  134. "is_multiple": false,
  135. "description": "To output raw command list",
  136. "default": false
  137. },
  138. "format": {
  139. "name": "--format",
  140. "shortcut": "",
  141. "accept_value": true,
  142. "is_value_required": true,
  143. "is_multiple": false,
  144. "description": "The output format (txt, xml, json, or md)",
  145. "default": "txt"
  146. }
  147. }
  148. }
  149. },
  150. {
  151. "name": "descriptor:command1",
  152. "hidden": false,
  153. "usage": [
  154. "descriptor:command1",
  155. "alias1",
  156. "alias2"
  157. ],
  158. "description": "command 1 description",
  159. "help": "command 1 help",
  160. "definition": {
  161. "arguments": [],
  162. "options": {
  163. "help": {
  164. "name": "--help",
  165. "shortcut": "-h",
  166. "accept_value": false,
  167. "is_value_required": false,
  168. "is_multiple": false,
  169. "description": "Display this help message",
  170. "default": false
  171. },
  172. "quiet": {
  173. "name": "--quiet",
  174. "shortcut": "-q",
  175. "accept_value": false,
  176. "is_value_required": false,
  177. "is_multiple": false,
  178. "description": "Do not output any message",
  179. "default": false
  180. },
  181. "verbose": {
  182. "name": "--verbose",
  183. "shortcut": "-v|-vv|-vvv",
  184. "accept_value": false,
  185. "is_value_required": false,
  186. "is_multiple": false,
  187. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  188. "default": false
  189. },
  190. "version": {
  191. "name": "--version",
  192. "shortcut": "-V",
  193. "accept_value": false,
  194. "is_value_required": false,
  195. "is_multiple": false,
  196. "description": "Display this application version",
  197. "default": false
  198. },
  199. "ansi": {
  200. "name": "--ansi",
  201. "shortcut": "",
  202. "accept_value": false,
  203. "is_value_required": false,
  204. "is_multiple": false,
  205. "description": "Force ANSI output",
  206. "default": false
  207. },
  208. "no-ansi": {
  209. "name": "--no-ansi",
  210. "shortcut": "",
  211. "accept_value": false,
  212. "is_value_required": false,
  213. "is_multiple": false,
  214. "description": "Disable ANSI output",
  215. "default": false
  216. },
  217. "no-interaction": {
  218. "name": "--no-interaction",
  219. "shortcut": "-n",
  220. "accept_value": false,
  221. "is_value_required": false,
  222. "is_multiple": false,
  223. "description": "Do not ask any interactive question",
  224. "default": false
  225. }
  226. }
  227. }
  228. },
  229. {
  230. "name": "descriptor:command2",
  231. "hidden": false,
  232. "usage": [
  233. "descriptor:command2 [-o|--option_name] [--] <argument_name>",
  234. "descriptor:command2 -o|--option_name <argument_name>",
  235. "descriptor:command2 <argument_name>"
  236. ],
  237. "description": "command 2 description",
  238. "help": "command 2 help",
  239. "definition": {
  240. "arguments": {
  241. "argument_name": {
  242. "name": "argument_name",
  243. "is_required": true,
  244. "is_array": false,
  245. "description": "",
  246. "default": null
  247. }
  248. },
  249. "options": {
  250. "option_name": {
  251. "name": "--option_name",
  252. "shortcut": "-o",
  253. "accept_value": false,
  254. "is_value_required": false,
  255. "is_multiple": false,
  256. "description": "",
  257. "default": false
  258. },
  259. "help": {
  260. "name": "--help",
  261. "shortcut": "-h",
  262. "accept_value": false,
  263. "is_value_required": false,
  264. "is_multiple": false,
  265. "description": "Display this help message",
  266. "default": false
  267. },
  268. "quiet": {
  269. "name": "--quiet",
  270. "shortcut": "-q",
  271. "accept_value": false,
  272. "is_value_required": false,
  273. "is_multiple": false,
  274. "description": "Do not output any message",
  275. "default": false
  276. },
  277. "verbose": {
  278. "name": "--verbose",
  279. "shortcut": "-v|-vv|-vvv",
  280. "accept_value": false,
  281. "is_value_required": false,
  282. "is_multiple": false,
  283. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  284. "default": false
  285. },
  286. "version": {
  287. "name": "--version",
  288. "shortcut": "-V",
  289. "accept_value": false,
  290. "is_value_required": false,
  291. "is_multiple": false,
  292. "description": "Display this application version",
  293. "default": false
  294. },
  295. "ansi": {
  296. "name": "--ansi",
  297. "shortcut": "",
  298. "accept_value": false,
  299. "is_value_required": false,
  300. "is_multiple": false,
  301. "description": "Force ANSI output",
  302. "default": false
  303. },
  304. "no-ansi": {
  305. "name": "--no-ansi",
  306. "shortcut": "",
  307. "accept_value": false,
  308. "is_value_required": false,
  309. "is_multiple": false,
  310. "description": "Disable ANSI output",
  311. "default": false
  312. },
  313. "no-interaction": {
  314. "name": "--no-interaction",
  315. "shortcut": "-n",
  316. "accept_value": false,
  317. "is_value_required": false,
  318. "is_multiple": false,
  319. "description": "Do not ask any interactive question",
  320. "default": false
  321. }
  322. }
  323. }
  324. },
  325. {
  326. "name": "descriptor:command3",
  327. "hidden": true,
  328. "usage": [
  329. "descriptor:command3"
  330. ],
  331. "description": "command 3 description",
  332. "help": "command 3 help",
  333. "definition": {
  334. "arguments": {},
  335. "options": {
  336. "help": {
  337. "name": "--help",
  338. "shortcut": "-h",
  339. "accept_value": false,
  340. "is_value_required": false,
  341. "is_multiple": false,
  342. "description": "Display this help message",
  343. "default": false
  344. },
  345. "quiet": {
  346. "name": "--quiet",
  347. "shortcut": "-q",
  348. "accept_value": false,
  349. "is_value_required": false,
  350. "is_multiple": false,
  351. "description": "Do not output any message",
  352. "default": false
  353. },
  354. "verbose": {
  355. "name": "--verbose",
  356. "shortcut": "-v|-vv|-vvv",
  357. "accept_value": false,
  358. "is_value_required": false,
  359. "is_multiple": false,
  360. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  361. "default": false
  362. },
  363. "version": {
  364. "name": "--version",
  365. "shortcut": "-V",
  366. "accept_value": false,
  367. "is_value_required": false,
  368. "is_multiple": false,
  369. "description": "Display this application version",
  370. "default": false
  371. },
  372. "ansi": {
  373. "name": "--ansi",
  374. "shortcut": "",
  375. "accept_value": false,
  376. "is_value_required": false,
  377. "is_multiple": false,
  378. "description": "Force ANSI output",
  379. "default": false
  380. },
  381. "no-ansi": {
  382. "name": "--no-ansi",
  383. "shortcut": "",
  384. "accept_value": false,
  385. "is_value_required": false,
  386. "is_multiple": false,
  387. "description": "Disable ANSI output",
  388. "default": false
  389. },
  390. "no-interaction": {
  391. "name": "--no-interaction",
  392. "shortcut": "-n",
  393. "accept_value": false,
  394. "is_value_required": false,
  395. "is_multiple": false,
  396. "description": "Do not ask any interactive question",
  397. "default": false
  398. }
  399. }
  400. }
  401. },
  402. {
  403. "name": "descriptor:command4",
  404. "hidden": false,
  405. "usage": [
  406. "descriptor:command4",
  407. "descriptor:alias_command4",
  408. "command4:descriptor"
  409. ],
  410. "description": null,
  411. "help": "",
  412. "definition": {
  413. "arguments": {},
  414. "options": {
  415. "help": {
  416. "name": "--help",
  417. "shortcut": "-h",
  418. "accept_value": false,
  419. "is_value_required": false,
  420. "is_multiple": false,
  421. "description": "Display this help message",
  422. "default": false
  423. },
  424. "quiet": {
  425. "name": "--quiet",
  426. "shortcut": "-q",
  427. "accept_value": false,
  428. "is_value_required": false,
  429. "is_multiple": false,
  430. "description": "Do not output any message",
  431. "default": false
  432. },
  433. "verbose": {
  434. "name": "--verbose",
  435. "shortcut": "-v|-vv|-vvv",
  436. "accept_value": false,
  437. "is_value_required": false,
  438. "is_multiple": false,
  439. "description": "Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug",
  440. "default": false
  441. },
  442. "version": {
  443. "name": "--version",
  444. "shortcut": "-V",
  445. "accept_value": false,
  446. "is_value_required": false,
  447. "is_multiple": false,
  448. "description": "Display this application version",
  449. "default": false
  450. },
  451. "ansi": {
  452. "name": "--ansi",
  453. "shortcut": "",
  454. "accept_value": false,
  455. "is_value_required": false,
  456. "is_multiple": false,
  457. "description": "Force ANSI output",
  458. "default": false
  459. },
  460. "no-ansi": {
  461. "name": "--no-ansi",
  462. "shortcut": "",
  463. "accept_value": false,
  464. "is_value_required": false,
  465. "is_multiple": false,
  466. "description": "Disable ANSI output",
  467. "default": false
  468. },
  469. "no-interaction": {
  470. "name": "--no-interaction",
  471. "shortcut": "-n",
  472. "accept_value": false,
  473. "is_value_required": false,
  474. "is_multiple": false,
  475. "description": "Do not ask any interactive question",
  476. "default": false
  477. }
  478. }
  479. }
  480. }
  481. ],
  482. "namespaces": [
  483. {
  484. "id": "_global",
  485. "commands": [
  486. "alias1",
  487. "alias2",
  488. "help",
  489. "list"
  490. ]
  491. },
  492. {
  493. "id": "command4",
  494. "commands": [
  495. "command4:descriptor"
  496. ]
  497. },
  498. {
  499. "id": "descriptor",
  500. "commands": [
  501. "descriptor:alias_command4",
  502. "descriptor:command1",
  503. "descriptor:command2",
  504. "descriptor:command3",
  505. "descriptor:command4"
  506. ]
  507. }
  508. ]
  509. }