API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Feb 12th, 2016
111
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 72.35 KB | None | 0 0
raw download clone embed print report
  1. about:
  2. command: about
  3. aliases: { }
  4. description: 'Display basic information about Drupal Console project'
  5. synopsis: about
  6. usages: { }
  7. help: null
  8. arguments: { }
  9. options: { }
  10. 'cache:rebuild':
  11. command: 'cache:rebuild'
  12. aliases: { }
  13. description: 'Rebuild and clear all site caches.'
  14. synopsis: 'cache:rebuild [<cache>]'
  15. usages: { }
  16. help: null
  17. arguments: { cache: { name: cache, description: 'Only clear a specific cache.', default: null } }
  18. options: { }
  19. chain:
  20. command: chain
  21. aliases: { }
  22. description: 'Chain command execution'
  23. synopsis: 'chain [--file [FILE]]'
  24. usages: { }
  25. help: null
  26. arguments: { }
  27. options: { file: { name: file, description: 'User defined file containing commands to get executed.', default: null, required: false, optional: true } }
  28. complete:
  29. command: complete
  30. aliases: { }
  31. description: 'Shell completion command list'
  32. synopsis: complete
  33. usages: { }
  34. help: null
  35. arguments: { }
  36. options: { }
  37. 'config:debug':
  38. command: 'config:debug'
  39. aliases: { }
  40. description: 'Show the current configuration.'
  41. synopsis: 'config:debug [<config-name>]'
  42. usages: { }
  43. help: null
  44. arguments: { config-name: { name: config-name, description: 'Configuration name.', default: null } }
  45. options: { }
  46. 'config:edit':
  47. command: 'config:edit'
  48. aliases: { }
  49. description: 'Edit the selected configuration.'
  50. synopsis: 'config:edit <config-name> [<editor>]'
  51. usages: { }
  52. help: null
  53. arguments: { config-name: { name: config-name, description: 'Configuration name.', default: null }, editor: { name: editor, description: Editor., default: null } }
  54. options: { }
  55. 'config:export':
  56. command: 'config:export'
  57. aliases: { }
  58. description: 'Export current application configuration.'
  59. synopsis: 'config:export [--directory [DIRECTORY]] [--tar]'
  60. usages: { }
  61. help: null
  62. arguments: { }
  63. options: { directory: { name: directory, description: commands.config.export.options.directory, default: null, required: false, optional: true }, tar: { name: tar, description: commands.config.export.options.tar, default: false, required: false, optional: false } }
  64. 'config:export:content:type':
  65. command: 'config:export:content:type'
  66. aliases: { }
  67. description: 'Export a specific content type and their fields.'
  68. synopsis: 'config:export:content:type [--module MODULE] [--optional-config [OPTIONAL-CONFIG]] [--] <content-type>'
  69. usages: { }
  70. help: null
  71. arguments: { content-type: { name: content-type, description: 'Content Type to be exported', default: null } }
  72. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, optional-config: { name: optional-config, description: 'Export content type as an optional YAML configuration in your module', default: null, required: false, optional: true } }
  73. 'config:export:single':
  74. command: 'config:export:single'
  75. aliases: { }
  76. description: 'Export single configuration as yml file.'
  77. synopsis: 'config:export:single [--directory [DIRECTORY]] [--] <config-name>'
  78. usages: { }
  79. help: null
  80. arguments: { config-name: { name: config-name, description: 'Configuration name.', default: null } }
  81. options: { directory: { name: directory, description: 'Define export directory to save configuration output.', default: null, required: false, optional: true } }
  82. 'config:export:view':
  83. command: 'config:export:view'
  84. aliases: { }
  85. description: 'Export a view in YAML format inside a provided module to reuse in other website.'
  86. synopsis: 'config:export:view [--module MODULE] [--optional-config [OPTIONAL-CONFIG]] [--include-module-dependencies [INCLUDE-MODULE-DEPENDENCIES]] [--] [<view-id>]'
  87. usages: { }
  88. help: null
  89. arguments: { view-id: { name: view-id, description: 'View ID', default: null } }
  90. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, optional-config: { name: optional-config, description: 'Export view as an optional YAML configuration in your module', default: null, required: false, optional: true }, include-module-dependencies: { name: include-module-dependencies, description: 'Include module dependencies in module info YAML file', default: null, required: false, optional: true } }
  91. 'config:import':
  92. command: 'config:import'
  93. aliases: { }
  94. description: 'Import configuration to current application.'
  95. synopsis: 'config:import [--file [FILE]] [--remove-files]'
  96. usages: { }
  97. help: null
  98. arguments: { }
  99. options: { file: { name: file, description: commands.config.import.option.file, default: null, required: false, optional: true }, remove-files: { name: remove-files, description: commands.config.import.option.keep-files, default: false, required: false, optional: false } }
  100. 'config:import:single':
  101. command: 'config:import:single'
  102. aliases: { }
  103. description: 'Import the selected configuration.'
  104. synopsis: 'config:import:single <config-name> [<input-file>]'
  105. usages: { }
  106. help: null
  107. arguments: { config-name: { name: config-name, description: 'Configuration name.', default: null }, input-file: { name: input-file, description: 'Path to the import files.', default: null } }
  108. options: { }
  109. 'config:override':
  110. command: 'config:override'
  111. aliases: { }
  112. description: 'Override config value in active configuration.'
  113. synopsis: 'config:override <config-name> <key> <value>'
  114. usages: { }
  115. help: null
  116. arguments: { config-name: { name: config-name, description: 'Configuration name.', default: null }, key: { name: key, description: Key, default: null }, value: { name: value, description: Value, default: null } }
  117. options: { }
  118. 'container:debug':
  119. command: 'container:debug'
  120. aliases: { }
  121. description: 'Displays current services for an application.'
  122. synopsis: 'container:debug'
  123. usages: { }
  124. help: null
  125. arguments: { }
  126. options: { }
  127. 'create:nodes':
  128. command: 'create:nodes'
  129. aliases: { }
  130. description: 'Create dummy nodes for your Drupal 8 application.'
  131. synopsis: 'create:nodes [--limit [LIMIT]] [--title-words [TITLE-WORDS]] [--time-range [TIME-RANGE]] [--] [<content-types>]...'
  132. usages: { }
  133. help: null
  134. arguments: { content-types: { name: content-types, description: 'Content type(s) to be used in node creation', default: { } } }
  135. options: { limit: { name: limit, description: commands.create.nodes.arguments.limit, default: null, required: false, optional: true }, title-words: { name: title-words, description: commands.create.nodes.arguments.title-words, default: null, required: false, optional: true }, time-range: { name: time-range, description: commands.create.nodes.arguments.time-range, default: null, required: false, optional: true } }
  136. 'create:terms':
  137. command: 'create:terms'
  138. aliases: { }
  139. description: 'Create dummy terms for your Drupal 8 application.'
  140. synopsis: 'create:terms [--limit [LIMIT]] [--name-words [NAME-WORDS]] [--] [<vocabularies>]...'
  141. usages: { }
  142. help: null
  143. arguments: { vocabularies: { name: vocabularies, description: 'Vocabularie(s) to be used in terms creation', default: { } } }
  144. options: { limit: { name: limit, description: 'How many terms would you like to create', default: null, required: false, optional: true }, name-words: { name: name-words, description: 'Maximum number of words in term names', default: null, required: false, optional: true } }
  145. 'create:users':
  146. command: 'create:users'
  147. aliases: { }
  148. description: 'Create dummy users for your Drupal 8 application.'
  149. synopsis: 'create:users [--limit [LIMIT]] [--password [PASSWORD]] [--time-range [TIME-RANGE]] [--] [<roles>]...'
  150. usages: { }
  151. help: null
  152. arguments: { roles: { name: roles, description: 'Role(s) to be used in user creation', default: { } } }
  153. options: { limit: { name: limit, description: 'How many users would you like to create', default: null, required: false, optional: true }, password: { name: password, description: 'Password to be set to users created', default: null, required: false, optional: true }, time-range: { name: time-range, description: 'How far back in time should the users be dated', default: null, required: false, optional: true } }
  154. 'create:vocabularies':
  155. command: 'create:vocabularies'
  156. aliases: { }
  157. description: 'Create dummy vocabularies for your Drupal 8 application.'
  158. synopsis: 'create:vocabularies [--limit [LIMIT]] [--name-words [NAME-WORDS]]'
  159. usages: { }
  160. help: null
  161. arguments: { }
  162. options: { limit: { name: limit, description: 'How many vocabularies would you like to create', default: null, required: false, optional: true }, name-words: { name: name-words, description: 'Maximum number of words in vocabulary names', default: null, required: false, optional: true } }
  163. 'cron:debug':
  164. command: 'cron:debug'
  165. aliases: { }
  166. description: 'List of modules implementing a cron'
  167. synopsis: 'cron:debug'
  168. usages: { }
  169. help: null
  170. arguments: { }
  171. options: { }
  172. 'cron:execute':
  173. command: 'cron:execute'
  174. aliases: { }
  175. description: 'Execute cron implementations by module or execute all crons'
  176. synopsis: 'cron:execute <module>'
  177. usages: { }
  178. help: null
  179. arguments: { module: { name: module, description: 'The Module name.', default: null } }
  180. options: { }
  181. 'cron:release':
  182. command: 'cron:release'
  183. aliases: { }
  184. description: 'Release cron system lock to run cron again'
  185. synopsis: 'cron:release'
  186. usages: { }
  187. help: null
  188. arguments: { }
  189. options: { }
  190. 'database:client':
  191. command: 'database:client'
  192. aliases: { }
  193. description: 'Launch a DB client if it''s available'
  194. synopsis: 'database:client [<database>]'
  195. usages: { }
  196. help: commands.database.client.help
  197. arguments: { database: { name: database, description: 'Database key from settings.php', default: default } }
  198. options: { }
  199. 'database:connect':
  200. command: 'database:connect'
  201. aliases: { }
  202. description: 'Shows DB connection'
  203. synopsis: 'database:connect [<database>]'
  204. usages: { }
  205. help: commands.database.connect.help
  206. arguments: { database: { name: database, description: 'Database key from settings.php', default: default } }
  207. options: { }
  208. 'database:dump':
  209. command: 'database:dump'
  210. aliases: { }
  211. description: 'Dump structure and contents of a database'
  212. synopsis: 'database:dump [--file [FILE]] [--] [<database>]'
  213. usages: { }
  214. help: commands.database.dump.help
  215. arguments: { database: { name: database, description: 'Database key from settings.php', default: default } }
  216. options: { file: { name: file, description: commands.database.dump.option.file, default: null, required: false, optional: true } }
  217. 'database:log:clear':
  218. command: 'database:log:clear'
  219. aliases: { }
  220. description: 'Remove events from DBLog table, filters are available'
  221. synopsis: 'database:log:clear [--type [TYPE]] [--severity [SEVERITY]] [--user-id [USER-ID]] [--] [<event-id>]'
  222. usages: { }
  223. help: null
  224. arguments: { event-id: { name: event-id, description: commands.database.log.clear.arguments.event-id, default: null } }
  225. options: { type: { name: type, description: commands.database.log.clear.options.type, default: null, required: false, optional: true }, severity: { name: severity, description: commands.database.log.clear.options.severity, default: null, required: false, optional: true }, user-id: { name: user-id, description: commands.database.log.clear.options.user-id, default: null, required: false, optional: true } }
  226. 'database:log:debug':
  227. command: 'database:log:debug'
  228. aliases: { }
  229. description: 'Display current log events for the application'
  230. synopsis: 'database:log:debug [--type [TYPE]] [--severity [SEVERITY]] [--user-id [USER-ID]] [--reverse] [--limit [LIMIT]] [--offset [OFFSET]] [--] [<event-id>]'
  231. usages: { }
  232. help: null
  233. arguments: { event-id: { name: event-id, description: 'DBLog event ID', default: null } }
  234. options: { type: { name: type, description: 'Filter events by a specific type', default: null, required: false, optional: true }, severity: { name: severity, description: 'Filter events by a specific level of severity', default: null, required: false, optional: true }, user-id: { name: user-id, description: 'Filter events by a specific user id', default: null, required: false, optional: true }, reverse: { name: reverse, description: 'Reverse the order of events', default: false, required: false, optional: false }, limit: { name: limit, description: 'Limit results to a specific number', default: null, required: false, optional: true }, offset: { name: offset, description: 'Starting point of a limit', default: 0, required: false, optional: true } }
  235. 'database:restore':
  236. command: 'database:restore'
  237. aliases: { }
  238. description: 'Restore structure and contents of a database.'
  239. synopsis: 'database:restore [--file FILE] [--] [<database>]'
  240. usages: { }
  241. help: commands.database.restore.help
  242. arguments: { database: { name: database, description: 'Database key from settings.php', default: default } }
  243. options: { file: { name: file, description: 'The filename for your database backup file', default: null, required: true, optional: false } }
  244. 'database:table:debug':
  245. command: 'database:table:debug'
  246. aliases: { }
  247. description: 'Show all tables in a given database.'
  248. synopsis: 'database:table:debug [<database>]'
  249. usages: { }
  250. help: 'The database:table:debug command helps you debug database tables.'
  251. arguments: { database: { name: database, description: 'Database key from settings.php', default: default } }
  252. options: { }
  253. 'database:table:drop':
  254. command: 'database:table:drop'
  255. aliases: { }
  256. description: 'Drop all tables in a given database.'
  257. synopsis: 'database:table:drop [<database>]'
  258. usages: { }
  259. help: 'The database:table:drop command helps you drop database tables.'
  260. arguments: { database: { name: database, description: 'Database key from settings.php', default: default } }
  261. options: { }
  262. 'generate:authentication:provider':
  263. command: 'generate:authentication:provider'
  264. aliases: { }
  265. description: 'Generate an Authentication Provider'
  266. synopsis: 'generate:authentication:provider [--module MODULE] [--class [CLASS]] [--provider-id [PROVIDER-ID]]'
  267. usages: { }
  268. help: 'The generate:authentication:provider command helps you generate a new Authentication Provider.'
  269. arguments: { }
  270. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Authentication Provider class', default: null, required: false, optional: true }, provider-id: { name: provider-id, description: 'Provider ID', default: null, required: false, optional: true } }
  271. 'generate:command':
  272. command: 'generate:command'
  273. aliases: { }
  274. description: 'Generate commands for the console.'
  275. synopsis: 'generate:command [--module MODULE] [--class [CLASS]] [--name [NAME]] [--container-aware]'
  276. usages: { }
  277. help: 'The generate:command command helps you generate a new command.'
  278. arguments: { }
  279. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'The Class that describes the command. (Must end with the word ''Commmand'').', default: null, required: false, optional: true }, name: { name: name, description: 'The Command name.', default: null, required: false, optional: true }, container-aware: { name: container-aware, description: 'Is the command aware of the drupal site installation when executed', default: false, required: false, optional: false } }
  280. 'generate:form:config':
  281. command: 'generate:form:config'
  282. aliases: { }
  283. description: 'Generate a new "ConfigFormBase"'
  284. synopsis: 'generate:form:config [--module MODULE] [--class [CLASS]] [--form-id [FORM-ID]] [--services [SERVICES]] [--inputs [INPUTS]] [--routing] [--menu_link_gen [MENU_LINK_GEN]] [--menu_link_title [MENU_LINK_TITLE]] [--menu_parent [MENU_PARENT]] [--menu_link_desc [MENU_LINK_DESC]]'
  285. usages: { }
  286. help: 'The "generate:form:config" command helps you generate a new "ConfigFormBase"'
  287. arguments: { }
  288. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'The form class name', default: null, required: false, optional: true }, form-id: { name: form-id, description: 'The Form id', default: null, required: false, optional: true }, services: { name: services, description: 'Load services from the container.', default: null, required: false, optional: true }, inputs: { name: inputs, description: 'Create inputs in a form.', default: null, required: false, optional: true }, routing: { name: routing, description: 'Update routing', default: false, required: false, optional: false }, menu_link_gen: { name: menu_link_gen, description: commands.generate.form.options.menu_link_gen, default: null, required: false, optional: true }, menu_link_title: { name: menu_link_title, description: commands.generate.form.options.menu_link_title, default: null, required: false, optional: true }, menu_parent: { name: menu_parent, description: commands.generate.form.options.menu_parent, default: null, required: false, optional: true }, menu_link_desc: { name: menu_link_desc, description: commands.generate.form.options.menu_link_desc, default: null, required: false, optional: true } }
  289. 'generate:controller':
  290. command: 'generate:controller'
  291. aliases: { }
  292. description: 'Generate & Register a controller'
  293. synopsis: 'generate:controller [--module MODULE] [--class [CLASS]] [--routes [ROUTES]] [--services [SERVICES]] [--test]'
  294. usages: { }
  295. help: 'The generate:controller command helps you generate a new controller.'
  296. arguments: { }
  297. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Controller Class name', default: null, required: false, optional: true }, routes: { name: routes, description: 'The routes, must be an array containing [title, method, path]', default: { }, required: false, optional: true }, services: { name: services, description: 'Load services from the container.', default: { }, required: false, optional: true }, test: { name: test, description: 'Generate a test class', default: false, required: false, optional: false } }
  298. 'generate:entity:bundle':
  299. command: 'generate:entity:bundle'
  300. aliases: { }
  301. description: 'Generate a new content type (node / entity bundle)'
  302. synopsis: 'generate:entity:bundle [--module MODULE] [--bundle-name [BUNDLE-NAME]] [--bundle-title [BUNDLE-TITLE]]'
  303. usages: { }
  304. help: 'Use: generate:contenttype <fancy> <Fancy> to create a new content type name with the machine name of fancy and the human-readable name of Fancy.'
  305. arguments: { }
  306. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, bundle-name: { name: bundle-name, description: 'The content type''s machine name', default: null, required: false, optional: true }, bundle-title: { name: bundle-title, description: 'The content type''s human-readable name', default: null, required: false, optional: true } }
  307. 'generate:entity:config':
  308. command: 'generate:entity:config'
  309. aliases: { }
  310. description: 'Generate a new config entity'
  311. synopsis: 'generate:entity:config [--module MODULE] [--entity-class ENTITY-CLASS] [--entity-name ENTITY-NAME] [--label LABEL] [--bundle-of]'
  312. usages: { }
  313. help: ''
  314. arguments: { }
  315. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, entity-class: { name: entity-class, description: 'The config entity class', default: null, required: true, optional: false }, entity-name: { name: entity-name, description: 'The config entity name', default: null, required: true, optional: false }, label: { name: label, description: 'The label', default: null, required: true, optional: false }, bundle-of: { name: bundle-of, description: 'Acts as bundle for content entities', default: false, required: false, optional: false } }
  316. 'generate:entity:content':
  317. command: 'generate:entity:content'
  318. aliases: { }
  319. description: 'Generate a new content entity'
  320. synopsis: 'generate:entity:content [--module MODULE] [--entity-class ENTITY-CLASS] [--entity-name ENTITY-NAME] [--label LABEL] [--has-bundles]'
  321. usages: { }
  322. help: ''
  323. arguments: { }
  324. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, entity-class: { name: entity-class, description: 'The content entity class', default: null, required: true, optional: false }, entity-name: { name: entity-name, description: 'The content entity name', default: null, required: true, optional: false }, label: { name: label, description: 'The label', default: null, required: true, optional: false }, has-bundles: { name: has-bundles, description: 'Entity has bundles', default: false, required: false, optional: false } }
  325. 'generate:event:subscriber':
  326. command: 'generate:event:subscriber'
  327. aliases: { }
  328. description: 'Generate an event subscriber'
  329. synopsis: 'generate:event:subscriber [--module MODULE] [--name [NAME]] [--class [CLASS]] [--events [EVENTS]] [--services [SERVICES]]'
  330. usages: { }
  331. help: 'Generate an event subscriber'
  332. arguments: { }
  333. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, name: { name: name, description: commands.generate.service.options.name, default: null, required: false, optional: true }, class: { name: class, description: 'Class name', default: null, required: false, optional: true }, events: { name: events, description: 'Load services from the container.', default: { }, required: false, optional: true }, services: { name: services, description: 'Load services from the container.', default: { }, required: false, optional: true } }
  334. 'generate:form:alter':
  335. command: 'generate:form:alter'
  336. aliases: { }
  337. description: 'Generate an implementation of hook_form_alter() or hook_form_FORM_ID_alter'
  338. synopsis: 'generate:form:alter [--module MODULE] [--form-id [FORM-ID]] [--inputs [INPUTS]]'
  339. usages: { }
  340. help: 'The "%s" command helps you generate a new "%s"'
  341. arguments: { }
  342. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, form-id: { name: form-id, description: 'Form ID to alter', default: null, required: false, optional: true }, inputs: { name: inputs, description: 'Create inputs in a form.', default: { }, required: false, optional: true } }
  343. 'generate:form':
  344. command: 'generate:form'
  345. aliases: { }
  346. description: 'Generate a new "FormBase"'
  347. synopsis: 'generate:form [--module MODULE] [--class [CLASS]] [--form-id [FORM-ID]] [--services [SERVICES]] [--inputs [INPUTS]] [--routing] [--menu_link_gen [MENU_LINK_GEN]] [--menu_link_title [MENU_LINK_TITLE]] [--menu_parent [MENU_PARENT]] [--menu_link_desc [MENU_LINK_DESC]]'
  348. usages: { }
  349. help: 'The "generate:form" command helps you generate a new "FormBase"'
  350. arguments: { }
  351. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'The form class name', default: null, required: false, optional: true }, form-id: { name: form-id, description: 'The Form id', default: null, required: false, optional: true }, services: { name: services, description: 'Load services from the container.', default: null, required: false, optional: true }, inputs: { name: inputs, description: 'Create inputs in a form.', default: null, required: false, optional: true }, routing: { name: routing, description: 'Update routing', default: false, required: false, optional: false }, menu_link_gen: { name: menu_link_gen, description: commands.generate.form.options.menu_link_gen, default: null, required: false, optional: true }, menu_link_title: { name: menu_link_title, description: commands.generate.form.options.menu_link_title, default: null, required: false, optional: true }, menu_parent: { name: menu_parent, description: commands.generate.form.options.menu_parent, default: null, required: false, optional: true }, menu_link_desc: { name: menu_link_desc, description: commands.generate.form.options.menu_link_desc, default: null, required: false, optional: true } }
  352. 'generate:module':
  353. command: 'generate:module'
  354. aliases: { }
  355. description: 'Generate a module.'
  356. synopsis: 'generate:module [--module MODULE] [--machine-name MACHINE-NAME] [--module-path MODULE-PATH] [--description [DESCRIPTION]] [--core [CORE]] [--package [PACKAGE]] [--module-file] [--feature] [--composer] [--dependencies [DEPENDENCIES]]'
  357. usages: { }
  358. help: 'The generate:module command helps you generates a new module.'
  359. arguments: { }
  360. options: { module: { name: module, description: 'The Module name', default: null, required: true, optional: false }, machine-name: { name: machine-name, description: 'The machine name (lowercase and underscore only)', default: null, required: true, optional: false }, module-path: { name: module-path, description: 'The path of the module', default: null, required: true, optional: false }, description: { name: description, description: 'Module description', default: null, required: false, optional: true }, core: { name: core, description: 'Core version', default: null, required: false, optional: true }, package: { name: package, description: 'Module package', default: null, required: false, optional: true }, module-file: { name: module-file, description: 'Add a .module file', default: false, required: false, optional: false }, feature: { name: feature, description: 'Set module compatible with Features module', default: false, required: false, optional: false }, composer: { name: composer, description: 'Add a composer.json file', default: false, required: false, optional: false }, dependencies: { name: dependencies, description: 'Module dependencies separated by commas (i.e. context, panels)', default: null, required: false, optional: true } }
  361. 'generate:permissions':
  362. command: 'generate:permissions'
  363. aliases: { }
  364. description: 'Generate module permissions'
  365. synopsis: 'generate:permissions [--module MODULE] [--permissions [PERMISSIONS]]'
  366. usages: { }
  367. help: 'The generate:permissions command helps you generate new permissions'
  368. arguments: { }
  369. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, permissions: { name: permissions, description: 'Create permissions.', default: null, required: false, optional: true } }
  370. 'generate:plugin:block':
  371. command: 'generate:plugin:block'
  372. aliases: { }
  373. description: 'Generate a plugin block'
  374. synopsis: 'generate:plugin:block [--module MODULE] [--class [CLASS]] [--label [LABEL]] [--plugin-id [PLUGIN-ID]] [--theme-region [THEME-REGION]] [--inputs [INPUTS]] [--services [SERVICES]]'
  375. usages: { }
  376. help: 'The generate:plugin:block command helps you generate a new Plugin block.'
  377. arguments: { }
  378. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: false, optional: true }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true }, theme-region: { name: theme-region, description: 'Theme region to render Plugin Block', default: null, required: false, optional: true }, inputs: { name: inputs, description: 'Create inputs in a form.', default: { }, required: false, optional: true }, services: { name: services, description: 'Load services from the container.', default: null, required: false, optional: true } }
  379. 'generate:plugin:condition':
  380. command: 'generate:plugin:condition'
  381. aliases: { }
  382. description: 'Generate a plugin condition.'
  383. synopsis: 'generate:plugin:condition [--module MODULE] [--class CLASS] [--label LABEL] [--plugin-id PLUGIN-ID] [--context-definition-id CONTEXT-DEFINITION-ID] [--context-definition-label CONTEXT-DEFINITION-LABEL] [--context-definition-required [CONTEXT-DEFINITION-REQUIRED]]'
  384. usages: { }
  385. help: 'The generate:plugin:conditon command helps you generate a plugin condition.'
  386. arguments: { }
  387. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin condition class name', default: null, required: true, optional: false }, label: { name: label, description: 'Plugin condition label', default: null, required: true, optional: false }, plugin-id: { name: plugin-id, description: 'Plugin condition id', default: null, required: true, optional: false }, context-definition-id: { name: context-definition-id, description: 'Context definition ID', default: null, required: true, optional: false }, context-definition-label: { name: context-definition-label, description: 'Context definition label', default: null, required: true, optional: false }, context-definition-required: { name: context-definition-required, description: 'Context definition is requiered (TRUE/FALSE)', default: null, required: false, optional: true } }
  388. 'generate:plugin:field':
  389. command: 'generate:plugin:field'
  390. aliases: { }
  391. description: 'Generate field type, widget and formatter plugins.'
  392. synopsis: 'generate:plugin:field [--module MODULE] [--type-class TYPE-CLASS] [--type-label [TYPE-LABEL]] [--type-plugin-id [TYPE-PLUGIN-ID]] [--type-description [TYPE-DESCRIPTION]] [--formatter-class FORMATTER-CLASS] [--formatter-label [FORMATTER-LABEL]] [--formatter-plugin-id [FORMATTER-PLUGIN-ID]] [--widget-class WIDGET-CLASS] [--widget-label [WIDGET-LABEL]] [--widget-plugin-id [WIDGET-PLUGIN-ID]] [--field-type [FIELD-TYPE]] [--default-widget [DEFAULT-WIDGET]] [--default-formatter [DEFAULT-FORMATTER]]'
  393. usages: { }
  394. help: 'The generate:plugin:field command helps you generate a full set of field plugin: field type, field formatter and field widget.'
  395. arguments: { }
  396. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, type-class: { name: type-class, description: 'Field type plugin class name', default: null, required: true, optional: false }, type-label: { name: type-label, description: 'Field type plugin label', default: null, required: false, optional: true }, type-plugin-id: { name: type-plugin-id, description: 'Field type plugin id', default: null, required: false, optional: true }, type-description: { name: type-description, description: commands.generate.plugin.field.options.type-type-description, default: null, required: false, optional: true }, formatter-class: { name: formatter-class, description: commands.generate.plugin.field.options.class, default: null, required: true, optional: false }, formatter-label: { name: formatter-label, description: 'Field formatter plugin label', default: null, required: false, optional: true }, formatter-plugin-id: { name: formatter-plugin-id, description: 'Field formatter plugin id', default: null, required: false, optional: true }, widget-class: { name: widget-class, description: 'Field formatter plugin class name', default: null, required: true, optional: false }, widget-label: { name: widget-label, description: 'Field widget plugin label', default: null, required: false, optional: true }, widget-plugin-id: { name: widget-plugin-id, description: 'Field widget plugin id', default: null, required: false, optional: true }, field-type: { name: field-type, description: 'Field type the formatter and widget plugin can be used with', default: null, required: false, optional: true }, default-widget: { name: default-widget, description: 'Default field widget of the field type plugin', default: null, required: false, optional: true }, default-formatter: { name: default-formatter, description: 'Default field formatter of field type plugin', default: null, required: false, optional: true } }
  397. 'generate:plugin:fieldformatter':
  398. command: 'generate:plugin:fieldformatter'
  399. aliases: { }
  400. description: 'Generate field formatter plugin.'
  401. synopsis: 'generate:plugin:fieldformatter [--module MODULE] [--class CLASS] [--label [LABEL]] [--plugin-id [PLUGIN-ID]] [--field-type [FIELD-TYPE]]'
  402. usages: { }
  403. help: 'The generate:plugin:fieldformatter command helps you generate a new field formatter plugin.'
  404. arguments: { }
  405. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: true, optional: false }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true }, field-type: { name: field-type, description: 'Field type the plugin can be used with', default: null, required: false, optional: true } }
  406. 'generate:plugin:fieldtype':
  407. command: 'generate:plugin:fieldtype'
  408. aliases: { }
  409. description: 'Generate field type plugin.'
  410. synopsis: 'generate:plugin:fieldtype [--module MODULE] [--class CLASS] [--label [LABEL]] [--plugin-id [PLUGIN-ID]] [--description [DESCRIPTION]] [--default-widget [DEFAULT-WIDGET]] [--default-formatter [DEFAULT-FORMATTER]]'
  411. usages: { }
  412. help: 'The generate:plugin:fieldtype command helps you generate a new field type plugin.'
  413. arguments: { }
  414. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: true, optional: false }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true }, description: { name: description, description: 'Plugin Description', default: null, required: false, optional: true }, default-widget: { name: default-widget, description: 'Default field widget of this plugin', default: null, required: false, optional: true }, default-formatter: { name: default-formatter, description: 'Default field formatter of this plugin', default: null, required: false, optional: true } }
  415. 'generate:plugin:fieldwidget':
  416. command: 'generate:plugin:fieldwidget'
  417. aliases: { }
  418. description: 'Generate field widget plugin.'
  419. synopsis: 'generate:plugin:fieldwidget [--module MODULE] [--class CLASS] [--label [LABEL]] [--plugin-id [PLUGIN-ID]] [--field-type [FIELD-TYPE]]'
  420. usages: { }
  421. help: 'The generate:plugin:fieldwidget command helps you generate a new field widget plugin.'
  422. arguments: { }
  423. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: true, optional: false }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true }, field-type: { name: field-type, description: 'Field type the plugin can be used with', default: null, required: false, optional: true } }
  424. 'generate:plugin:imageeffect':
  425. command: 'generate:plugin:imageeffect'
  426. aliases: { }
  427. description: 'Generate image effect plugin.'
  428. synopsis: 'generate:plugin:imageeffect [--module MODULE] [--class CLASS] [--label [LABEL]] [--plugin-id [PLUGIN-ID]] [--description [DESCRIPTION]]'
  429. usages: { }
  430. help: 'The generate:plugin:imageeffect command helps you generate a new image effect plugin.'
  431. arguments: { }
  432. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: true, optional: false }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true }, description: { name: description, description: 'Plugin Description', default: null, required: false, optional: true } }
  433. 'generate:plugin:imageformatter':
  434. command: 'generate:plugin:imageformatter'
  435. aliases: { }
  436. description: 'Generate image formatter plugin.'
  437. synopsis: 'generate:plugin:imageformatter [--module MODULE] [--class CLASS] [--label [LABEL]] [--plugin-id [PLUGIN-ID]]'
  438. usages: { }
  439. help: 'The generate:plugin:imageformatter command helps you generate a new image formatter plugin.'
  440. arguments: { }
  441. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: true, optional: false }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true } }
  442. 'generate:plugin:rest:resource':
  443. command: 'generate:plugin:rest:resource'
  444. aliases: { }
  445. description: 'Generate plugin rest resource'
  446. synopsis: 'generate:plugin:rest:resource [--module MODULE] [--class [CLASS]] [--name [NAME]] [--plugin-id [PLUGIN-ID]] [--plugin-label [PLUGIN-LABEL]] [--plugin-url [PLUGIN-URL]] [--plugin-states [PLUGIN-STATES]]'
  447. usages: { }
  448. help: 'The generate:plugin:rest:resource command helps you generate a new rest resource.'
  449. arguments: { }
  450. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin Rest Resource class', default: null, required: false, optional: true }, name: { name: name, description: commands.generate.service.options.name, default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin Rest Resource id', default: null, required: false, optional: true }, plugin-label: { name: plugin-label, description: 'Plugin Rest Resource Label', default: null, required: false, optional: true }, plugin-url: { name: plugin-url, description: 'Plugin Rest Resource URL', default: { }, required: false, optional: true }, plugin-states: { name: plugin-states, description: 'Plugin Rest Resource States', default: { }, required: false, optional: true } }
  451. 'generate:plugin:rulesaction':
  452. command: 'generate:plugin:rulesaction'
  453. aliases: { }
  454. description: 'Generate a plugin rule action'
  455. synopsis: 'generate:plugin:rulesaction [--module MODULE] [--class [CLASS]] [--label [LABEL]] [--plugin-id [PLUGIN-ID]] [--type TYPE] [--category [CATEGORY]] [--context [CONTEXT]]'
  456. usages: { }
  457. help: 'The generate:plugin:rulesaction command helps you generate a new Plugin rule action.'
  458. arguments: { }
  459. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin class name', default: null, required: false, optional: true }, label: { name: label, description: 'Plugin label', default: null, required: false, optional: true }, plugin-id: { name: plugin-id, description: 'Plugin id', default: null, required: false, optional: true }, type: { name: type, description: 'Action Type (user or node)', default: null, required: true, optional: false }, category: { name: category, description: 'Plugin category', default: { }, required: false, optional: true }, context: { name: context, description: 'Plugin context', default: null, required: false, optional: true } }
  460. 'generate:plugin:type:annotation':
  461. command: 'generate:plugin:type:annotation'
  462. aliases: { }
  463. description: 'Generate a plugin type with annotation discovery'
  464. synopsis: 'generate:plugin:type:annotation [--module MODULE] [--class [CLASS]] [--machine-name [MACHINE-NAME]] [--label [LABEL]]'
  465. usages: { }
  466. help: 'The generate:plugin:type:annotation command helps you generate a new Plugin type that uses annotation discovery.'
  467. arguments: { }
  468. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin type class name', default: null, required: false, optional: true }, machine-name: { name: machine-name, description: commands.generate.plugin.type.annotation.options.plugin-id, default: null, required: false, optional: true }, label: { name: label, description: 'Plugin type label', default: null, required: false, optional: true } }
  469. 'generate:plugin:type:yaml':
  470. command: 'generate:plugin:type:yaml'
  471. aliases: { }
  472. description: 'Generate a plugin type with Yaml discovery'
  473. synopsis: 'generate:plugin:type:yaml [--module MODULE] [--class [CLASS]] [--plugin-name [PLUGIN-NAME]] [--plugin-file-name [PLUGIN-FILE-NAME]]'
  474. usages: { }
  475. help: 'The generate:plugin:type:yaml command helps you generate a new Plugin type that uses Yaml discovery.'
  476. arguments: { }
  477. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Plugin type class name', default: null, required: false, optional: true }, plugin-name: { name: plugin-name, description: 'Plugin type machine name', default: null, required: false, optional: true }, plugin-file-name: { name: plugin-file-name, description: 'Plugin file name', default: null, required: false, optional: true } }
  478. 'generate:plugin:views:field':
  479. command: 'generate:plugin:views:field'
  480. aliases: { }
  481. description: 'Generate a custom plugin view field.'
  482. synopsis: 'generate:plugin:views:field [--module MODULE] [--class CLASS] [--title [TITLE]] [--description [DESCRIPTION]]'
  483. usages: { }
  484. help: 'The generate:plugin:views:field command helps you generate a new custom views field plugin.'
  485. arguments: { }
  486. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, class: { name: class, description: 'Views plugin field class name', default: null, required: true, optional: false }, title: { name: title, description: 'Views plugin field title', default: null, required: false, optional: true }, description: { name: description, description: 'Views plugin field description', default: null, required: false, optional: true } }
  487. 'generate:profile':
  488. command: 'generate:profile'
  489. aliases: { }
  490. description: 'Generate a profile.'
  491. synopsis: 'generate:profile [--profile PROFILE] [--machine-name MACHINE-NAME] [--description [DESCRIPTION]] [--core [CORE]] [--dependencies [DEPENDENCIES]] [--distribution [DISTRIBUTION]]'
  492. usages: { }
  493. help: 'The generate:profile command helps you generate a new installation profile.'
  494. arguments: { }
  495. options: { profile: { name: profile, description: 'The profile name', default: null, required: true, optional: false }, machine-name: { name: machine-name, description: 'The machine name (lowercase and underscore only)', default: null, required: true, optional: false }, description: { name: description, description: 'Profile description', default: null, required: false, optional: true }, core: { name: core, description: 'Core version', default: null, required: false, optional: true }, dependencies: { name: dependencies, description: 'Module dependencies separated by commas (i.e. context, panels)', default: null, required: false, optional: true }, distribution: { name: distribution, description: 'The distribution name', default: null, required: false, optional: true } }
  496. 'generate:routesubscriber':
  497. command: 'generate:routesubscriber'
  498. aliases: { }
  499. description: 'Generate a RouteSubscriber'
  500. synopsis: 'generate:routesubscriber [--module MODULE] [--name NAME] [--class CLASS]'
  501. usages: { }
  502. help: 'Generate a RouteSubscriber'
  503. arguments: { }
  504. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, name: { name: name, description: 'Service name', default: null, required: true, optional: false }, class: { name: class, description: 'Class name', default: null, required: true, optional: false } }
  505. 'generate:service':
  506. command: 'generate:service'
  507. aliases: { }
  508. description: 'Generate service'
  509. synopsis: 'generate:service [--module MODULE] [--name NAME] [--class CLASS] [--interface] [--services [SERVICES]]'
  510. usages: { }
  511. help: 'Generate service'
  512. arguments: { }
  513. options: { module: { name: module, description: 'The Module name.', default: null, required: true, optional: false }, name: { name: name, description: commands.generate.service.options.name, default: null, required: true, optional: false }, class: { name: class, description: 'Class name', default: null, required: true, optional: false }, interface: { name: interface, description: commands.common.service.options.interface, default: false, required: false, optional: false }, services: { name: services, description: 'Load services from the container.', default: { }, required: false, optional: true } }
  514. 'generate:theme':
  515. command: 'generate:theme'
  516. aliases: { }
  517. description: 'Generate a theme.'
  518. synopsis: 'generate:theme [--theme THEME] [--machine-name MACHINE-NAME] [--theme-path THEME-PATH] [--description [DESCRIPTION]] [--core [CORE]] [--package [PACKAGE]] [--global-library [GLOBAL-LIBRARY]] [--base-theme [BASE-THEME]] [--regions [REGIONS]] [--breakpoints [BREAKPOINTS]]'
  519. usages: { }
  520. help: 'The generate:theme command helps you generates a new theme.'
  521. arguments: { }
  522. options: { theme: { name: theme, description: commands.generate.theme.options.module, default: null, required: true, optional: false }, machine-name: { name: machine-name, description: 'The machine name (lowercase and underscore only)', default: null, required: true, optional: false }, theme-path: { name: theme-path, description: commands.generate.theme.options.module-path, default: null, required: true, optional: false }, description: { name: description, description: 'Theme description', default: null, required: false, optional: true }, core: { name: core, description: 'Core version', default: null, required: false, optional: true }, package: { name: package, description: 'Theme package', default: null, required: false, optional: true }, global-library: { name: global-library, description: 'Global styling library name', default: null, required: false, optional: true }, base-theme: { name: base-theme, description: 'Base theme (i.e. classy, stable)', default: null, required: false, optional: true }, regions: { name: regions, description: Regions, default: null, required: false, optional: true }, breakpoints: { name: breakpoints, description: Breakpoints, default: null, required: false, optional: true } }
  523. init:
  524. command: init
  525. aliases: { }
  526. description: 'Copy configuration files to user home directory.'
  527. synopsis: 'init [--override]'
  528. usages: { }
  529. help: null
  530. arguments: { }
  531. options: { override: { name: override, description: 'Override configurations files', default: false, required: false, optional: false } }
  532. list:
  533. command: list
  534. aliases: { }
  535. description: 'Lists all available commands'
  536. synopsis: 'list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]'
  537. usages: { }
  538. help: "The %command.name% command lists all commands:\nphp %command.full_name%\nYou can also display the commands for a specific namespace:\nphp %command.full_name% test\nYou can also output the information in other formats by using the --format option:\nphp %command.full_name% --format=xml\nIt's also possible to get raw list of commands (useful for embedding command runner):\nphp %command.full_name% --raw\n"
  539. arguments: { namespace: { name: namespace, description: 'The namespace name', default: null } }
  540. options: { xml: { name: xml, description: 'To output list as XML', default: false, required: false, optional: false }, raw: { name: raw, description: 'To output raw command list', default: false, required: false, optional: false }, format: { name: format, description: 'The output format (txt, xml, json, or md)', default: txt, required: true, optional: false } }
  541. 'locale:language:add':
  542. command: 'locale:language:add'
  543. aliases: { }
  544. description: 'Add a language to be supported by your site'
  545. synopsis: 'locale:language:add <language>'
  546. usages: { }
  547. help: null
  548. arguments: { language: { name: language, description: 'Language for instance es or Spanish', default: null } }
  549. options: { }
  550. 'locale:language:delete':
  551. command: 'locale:language:delete'
  552. aliases: { }
  553. description: 'Delete a language to be supported by your site'
  554. synopsis: 'locale:language:delete <language>'
  555. usages: { }
  556. help: null
  557. arguments: { language: { name: language, description: 'Language for instance es or Spanish', default: null } }
  558. options: { }
  559. 'locale:translation:status':
  560. command: 'locale:translation:status'
  561. aliases: { }
  562. description: 'List available translation updates'
  563. synopsis: 'locale:translation:status [<language>]'
  564. usages: { }
  565. help: null
  566. arguments: { language: { name: language, description: 'Language for instance es or Spanish', default: null } }
  567. options: { }
  568. 'migrate:debug':
  569. command: 'migrate:debug'
  570. aliases: { }
  571. description: 'Display current migration available for the application'
  572. synopsis: 'migrate:debug [<tag>]'
  573. usages: { }
  574. help: null
  575. arguments: { tag: { name: tag, description: 'Migrate tag', default: null } }
  576. options: { }
  577. 'migrate:execute':
  578. command: 'migrate:execute'
  579. aliases: { }
  580. description: 'Execute a migration available for application'
  581. synopsis: 'migrate:execute [--site-url SITE-URL] [--db-type DB-TYPE] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-pass [DB-PASS]] [--db-prefix [DB-PREFIX]] [--db-port DB-PORT] [--exclude [EXCLUDE]] [--] [<migration-ids>]...'
  582. usages: { }
  583. help: null
  584. arguments: { migration-ids: { name: migration-ids, description: 'Migration id(s)', default: { } } }
  585. options: { site-url: { name: site-url, description: 'Site Source URL', default: null, required: true, optional: false }, db-type: { name: db-type, description: commands.migrate.setup.migrations.options.db-type, default: null, required: true, optional: false }, db-host: { name: db-host, description: 'Database Host', default: null, required: true, optional: false }, db-name: { name: db-name, description: 'Database Name', default: null, required: true, optional: false }, db-user: { name: db-user, description: 'Database User', default: null, required: true, optional: false }, db-pass: { name: db-pass, description: 'Database Pass', default: null, required: false, optional: true }, db-prefix: { name: db-prefix, description: 'Database Prefix', default: null, required: false, optional: true }, db-port: { name: db-port, description: 'Database Port', default: null, required: true, optional: false }, exclude: { name: exclude, description: 'Migration id(s) to exclude', default: { }, required: false, optional: true } }
  586. 'migrate:setup':
  587. command: 'migrate:setup'
  588. aliases: { }
  589. description: 'Load and create the relevant migrations for a provided legacy database'
  590. synopsis: 'migrate:setup [--db-type DB-TYPE] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-pass [DB-PASS]] [--db-prefix [DB-PREFIX]] [--db-port DB-PORT] [--files-directory [FILES-DIRECTORY]]'
  591. usages: { }
  592. help: null
  593. arguments: { }
  594. options: { db-type: { name: db-type, description: 'Drupal Database type', default: null, required: true, optional: false }, db-host: { name: db-host, description: 'Database Host', default: null, required: true, optional: false }, db-name: { name: db-name, description: 'Database Name', default: null, required: true, optional: false }, db-user: { name: db-user, description: 'Database User', default: null, required: true, optional: false }, db-pass: { name: db-pass, description: 'Database Pass', default: null, required: false, optional: true }, db-prefix: { name: db-prefix, description: 'Database Prefix', default: null, required: false, optional: true }, db-port: { name: db-port, description: 'Database Port', default: null, required: true, optional: false }, files-directory: { name: files-directory, description: 'Files Directory', default: null, required: false, optional: true } }
  595. 'module:debug':
  596. command: 'module:debug'
  597. aliases: { }
  598. description: 'Display current modules available for application'
  599. synopsis: 'module:debug [--status [STATUS]] [--type [TYPE]]'
  600. usages: { }
  601. help: null
  602. arguments: { }
  603. options: { status: { name: status, description: 'Module status [enabled|disabled]', default: null, required: false, optional: true }, type: { name: type, description: 'Module type [core|no-core]', default: null, required: false, optional: true } }
  604. 'module:download':
  605. command: 'module:download'
  606. aliases: { }
  607. description: 'Download module or modules in application'
  608. synopsis: 'module:download <module> [<version>]'
  609. usages: { }
  610. help: null
  611. arguments: { module: { name: module, description: commands.module.download.options.module, default: null }, version: { name: version, description: 'Module version i.e 1.x-dev', default: null } }
  612. options: { }
  613. 'module:install':
  614. command: 'module:install'
  615. aliases: { }
  616. description: 'Install module or modules in the application'
  617. synopsis: 'module:install [--overwrite-config] [--] [<module>]...'
  618. usages: { }
  619. help: null
  620. arguments: { module: { name: module, description: 'Module or modules to be enabled should be separated by a space', default: { } } }
  621. options: { overwrite-config: { name: overwrite-config, description: 'Overwrite configuration active if necessary', default: false, required: false, optional: false } }
  622. 'module:uninstall':
  623. command: 'module:uninstall'
  624. aliases: { }
  625. description: 'Uninstall module or modules in the application'
  626. synopsis: 'module:uninstall <module>'
  627. usages: { }
  628. help: null
  629. arguments: { module: { name: module, description: 'Module or modules to be uninstalled should be separated by a comma', default: null } }
  630. options: { }
  631. 'multisite:debug':
  632. command: 'multisite:debug'
  633. aliases: { }
  634. description: 'List all multisites available in system'
  635. synopsis: 'multisite:debug'
  636. usages: { }
  637. help: 'The multisite:debug list all known multi sites.'
  638. arguments: { }
  639. options: { }
  640. 'rest:debug':
  641. command: 'rest:debug'
  642. aliases: { }
  643. description: 'Display current rest resource for the application'
  644. synopsis: 'rest:debug [--authorization [AUTHORIZATION]] [--] [<resource-id>]'
  645. usages: { }
  646. help: null
  647. arguments: { resource-id: { name: resource-id, description: 'Rest ID', default: null } }
  648. options: { authorization: { name: authorization, description: 'Rest resource status enabled | disabled', default: null, required: false, optional: true } }
  649. 'rest:disable':
  650. command: 'rest:disable'
  651. aliases: { }
  652. description: 'Disable a rest resource for the application'
  653. synopsis: 'rest:disable [<resource-id>]'
  654. usages: { }
  655. help: null
  656. arguments: { resource-id: { name: resource-id, description: 'Rest ID', default: null } }
  657. options: { }
  658. 'rest:enable':
  659. command: 'rest:enable'
  660. aliases: { }
  661. description: 'Enable a rest resource for the application'
  662. synopsis: 'rest:enable [<resource-id>]'
  663. usages: { }
  664. help: null
  665. arguments: { resource-id: { name: resource-id, description: 'Rest ID', default: null } }
  666. options: { }
  667. 'router:debug':
  668. command: 'router:debug'
  669. aliases: { }
  670. description: 'Displays current routes for the application'
  671. synopsis: 'router:debug [<route-name>]...'
  672. usages: { }
  673. help: null
  674. arguments: { route-name: { name: route-name, description: 'Route names', default: { } } }
  675. options: { }
  676. 'router:rebuild':
  677. command: 'router:rebuild'
  678. aliases: { }
  679. description: 'Rebuild routes for the application'
  680. synopsis: 'router:rebuild'
  681. usages: { }
  682. help: null
  683. arguments: { }
  684. options: { }
  685. self-update:
  686. command: self-update
  687. aliases: { }
  688. description: 'Update project to the latest version.'
  689. synopsis: 'self-update [--major] [--manifest MANIFEST] [--current-version CURRENT-VERSION]'
  690. usages: { }
  691. help: 'Update project to the latest version.'
  692. arguments: { }
  693. options: { major: { name: major, description: 'Update to a new major version, if available.', default: false, required: false, optional: false }, manifest: { name: manifest, description: 'Override the manifest file path.', default: null, required: true, optional: false }, current-version: { name: current-version, description: 'Override the version to update from.', default: null, required: true, optional: false } }
  694. server:
  695. command: server
  696. aliases: { }
  697. description: 'Runs PHP built-in web server'
  698. synopsis: 'server [<address>]'
  699. usages: { }
  700. help: null
  701. arguments: { address: { name: address, description: 'The address:port values', default: '127.0.0.1:8088' } }
  702. options: { }
  703. 'settings:debug':
  704. command: 'settings:debug'
  705. aliases: { }
  706. description: 'Displays current key:value on settings file.'
  707. synopsis: 'settings:debug'
  708. usages: { }
  709. help: 'The settings:debug command helps you displaying current key:value on settings file.'
  710. arguments: { }
  711. options: { }
  712. 'site:debug':
  713. command: 'site:debug'
  714. aliases: { }
  715. description: 'List all known local and remote sites.'
  716. synopsis: 'site:debug [<target>]'
  717. usages: { }
  718. help: 'The site:debug list all known local and remote sites.'
  719. arguments: { target: { name: target, description: commands.site.debug.options.target, default: null } }
  720. options: { }
  721. 'site:install':
  722. command: 'site:install'
  723. aliases: { }
  724. description: 'Install a Drupal project'
  725. synopsis: 'site:install [--langcode LANGCODE] [--db-type DB-TYPE] [--db-file DB-FILE] [--db-host [DB-HOST]] [--db-name [DB-NAME]] [--db-user [DB-USER]] [--db-pass [DB-PASS]] [--db-prefix [DB-PREFIX]] [--db-port [DB-PORT]] [--site-name SITE-NAME] [--site-mail SITE-MAIL] [--account-name ACCOUNT-NAME] [--account-mail ACCOUNT-MAIL] [--account-pass ACCOUNT-PASS] [--] [<profile>]'
  726. usages: { }
  727. help: null
  728. arguments: { profile: { name: profile, description: 'Drupal Profile to be install', default: null } }
  729. options: { langcode: { name: langcode, description: 'Drupal language', default: null, required: true, optional: false }, db-type: { name: db-type, description: 'Drupal Database type to be use in install', default: null, required: true, optional: false }, db-file: { name: db-file, description: 'Drupal Database file to be use in install', default: null, required: true, optional: false }, db-host: { name: db-host, description: 'Database Host', default: null, required: false, optional: true }, db-name: { name: db-name, description: 'Database Name', default: null, required: false, optional: true }, db-user: { name: db-user, description: 'Database User', default: null, required: false, optional: true }, db-pass: { name: db-pass, description: 'Database Pass', default: null, required: false, optional: true }, db-prefix: { name: db-prefix, description: 'Database Prefix', default: null, required: false, optional: true }, db-port: { name: db-port, description: 'Database Port', default: null, required: false, optional: true }, site-name: { name: site-name, description: 'Drupal site name', default: null, required: true, optional: false }, site-mail: { name: site-mail, description: 'Drupal site mail', default: null, required: true, optional: false }, account-name: { name: account-name, description: 'Drupal administrator account name', default: null, required: true, optional: false }, account-mail: { name: account-mail, description: 'Drupal administrator account mail', default: null, required: true, optional: false }, account-pass: { name: account-pass, description: 'Drupal administrator account password', default: null, required: true, optional: false } }
  730. 'site:maintenance':
  731. command: 'site:maintenance'
  732. aliases: { }
  733. description: 'Switch site into maintenance mode'
  734. synopsis: 'site:maintenance <mode>'
  735. usages: { }
  736. help: null
  737. arguments: { mode: { name: mode, description: 'Site maintenance mode[on/off]', default: null } }
  738. options: { }
  739. 'site:mode':
  740. command: 'site:mode'
  741. aliases: { }
  742. description: 'Switch system performance configuration'
  743. synopsis: 'site:mode <environment>'
  744. usages: { }
  745. help: null
  746. arguments: { environment: { name: environment, description: 'Environment name [dev, prod]', default: null } }
  747. options: { }
  748. 'site:new':
  749. command: 'site:new'
  750. aliases: { }
  751. description: 'Create a new Drupal project'
  752. synopsis: 'site:new <directory> [<version>]'
  753. usages: { }
  754. help: null
  755. arguments: { directory: { name: directory, description: 'Directory when downloading Drupal', default: null }, version: { name: version, description: 'Drupal version to download', default: null } }
  756. options: { }
  757. 'site:status':
  758. command: 'site:status'
  759. aliases: { }
  760. description: 'View current Drupal Installation status'
  761. synopsis: 'site:status [--format [FORMAT]]'
  762. usages: { }
  763. help: null
  764. arguments: { }
  765. options: { format: { name: format, description: commands.site.status.options.format, default: table, required: false, optional: true } }
  766. 'state:debug':
  767. command: 'state:debug'
  768. aliases: { }
  769. description: 'Show the current State keys.'
  770. synopsis: 'state:debug [<key>]'
  771. usages: { }
  772. help: 'Show the current State keys.'
  773. arguments: { key: { name: key, description: 'The State key to debug.', default: null } }
  774. options: { }
  775. 'state:override':
  776. command: 'state:override'
  777. aliases: { }
  778. description: 'Show the current State keys.'
  779. synopsis: 'state:override [<key>] [<value>]'
  780. usages: { }
  781. help: null
  782. arguments: { key: { name: key, description: 'The State key to override.', default: null }, value: { name: value, description: 'The State value to set.', default: null } }
  783. options: { }
  784. 'test:debug':
  785. command: 'test:debug'
  786. aliases: { }
  787. description: 'List Test Units available for the application.'
  788. synopsis: 'test:debug [--group [GROUP]] [--] [<test-class>]'
  789. usages: { }
  790. help: null
  791. arguments: { test-class: { name: test-class, description: 'Test Class', default: null } }
  792. options: { group: { name: group, description: Group, default: null, required: false, optional: true } }
  793. 'test:run':
  794. command: 'test:run'
  795. aliases: { }
  796. description: 'Run Test unit from tests available for application'
  797. synopsis: 'test:run [--url URL] [--] <test-class>'
  798. usages: { }
  799. help: null
  800. arguments: { test-class: { name: test-class, description: 'Test Class', default: null } }
  801. options: { url: { name: url, description: commands.test.run.arguments.url, default: null, required: true, optional: false } }
  802. 'theme:debug':
  803. command: 'theme:debug'
  804. aliases: { }
  805. description: 'Displays current themes for the application'
  806. synopsis: 'theme:debug [<theme>]'
  807. usages: { }
  808. help: null
  809. arguments: { theme: { name: theme, description: 'Specific theme to debug', default: null } }
  810. options: { }
  811. 'theme:download':
  812. command: 'theme:download'
  813. aliases: { }
  814. description: 'Download theme in application'
  815. synopsis: 'theme:download <theme> [<version>]'
  816. usages: { }
  817. help: null
  818. arguments: { theme: { name: theme, description: commands.theme.download.options.theme, default: null }, version: { name: version, description: 'Theme version i.e 1.x-dev', default: null } }
  819. options: { }
  820. 'theme:install':
  821. command: 'theme:install'
  822. aliases: { }
  823. description: 'Install theme or themes in the application'
  824. synopsis: 'theme:install [--set-default] [--] [<theme>]...'
  825. usages: { }
  826. help: null
  827. arguments: { theme: { name: theme, description: commands.theme.install.options.module, default: { } } }
  828. options: { set-default: { name: set-default, description: 'Set theme as default theme', default: false, required: false, optional: false } }
  829. 'theme:uninstall':
  830. command: 'theme:uninstall'
  831. aliases: { }
  832. description: 'Uninstall theme or themes in the application'
  833. synopsis: 'theme:uninstall [<theme>]...'
  834. usages: { }
  835. help: null
  836. arguments: { theme: { name: theme, description: commands.theme.uninstall.options.module, default: { } } }
  837. options: { }
  838. 'update:debug':
  839. command: 'update:debug'
  840. aliases: { }
  841. description: 'Display current updates available for the application'
  842. synopsis: 'update:debug'
  843. usages: { }
  844. help: null
  845. arguments: { }
  846. options: { }
  847. 'update:execute':
  848. command: 'update:execute'
  849. aliases: { }
  850. description: 'Execute a specific Update N function in a module, or execute all'
  851. synopsis: 'update:execute <module> [<update-n>]'
  852. usages: { }
  853. help: null
  854. arguments: { module: { name: module, description: 'The Module name.', default: null }, update-n: { name: update-n, description: 'Specific Update N function to be executed', default: null } }
  855. options: { }
  856. 'user:debug':
  857. command: 'user:debug'
  858. aliases: { }
  859. description: 'Displays current users for the application'
  860. synopsis: 'user:debug [--roles [ROLES]] [--limit [LIMIT]]'
  861. usages: { }
  862. help: null
  863. arguments: { }
  864. options: { roles: { name: roles, description: 'Roles to filter debug', default: null, required: false, optional: true }, limit: { name: limit, description: 'How many users would you listed in debug', default: null, required: false, optional: true } }
  865. 'user:delete':
  866. command: 'user:delete'
  867. aliases: { }
  868. description: 'Delete users for the application'
  869. synopsis: 'user:delete [--user-id [USER-ID]] [--roles [ROLES]]'
  870. usages: { }
  871. help: null
  872. arguments: { }
  873. options: { user-id: { name: user-id, description: 'User id to be deleted', default: null, required: false, optional: true }, roles: { name: roles, description: 'Roles associated to users to be deleted', default: { }, required: false, optional: true } }
  874. 'user:login:clear:attempts':
  875. command: 'user:login:clear:attempts'
  876. aliases: { }
  877. description: 'Clear login failed attempts for an account.'
  878. synopsis: 'user:login:clear:attempts <uid>'
  879. usages: { }
  880. help: 'The user:login:clear:attempts reset login failed attempts for an account.'
  881. arguments: { uid: { name: uid, description: 'User ID.', default: null } }
  882. options: { }
  883. 'user:login:url':
  884. command: 'user:login:url'
  885. aliases: { }
  886. description: 'Returns a one-time user login url.'
  887. synopsis: 'user:login:url <user-id>'
  888. usages: { }
  889. help: null
  890. arguments: { user-id: { name: user-id, description: 'User ID.', default: null } }
  891. options: { }
  892. 'user:password:hash':
  893. command: 'user:password:hash'
  894. aliases: { }
  895. description: 'Generate a hash from a plaintext password.'
  896. synopsis: 'user:password:hash [<password>]...'
  897. usages: { }
  898. help: 'The password:hash command helps you to generate hashes password from plaintext passwords.'
  899. arguments: { password: { name: password, description: 'Password(s) in text format', default: { } } }
  900. options: { }
  901. 'user:password:reset':
  902. command: 'user:password:reset'
  903. aliases: { }
  904. description: 'Reset password for a specific user.'
  905. synopsis: 'user:password:reset <user> <password>'
  906. usages: { }
  907. help: 'The password:reset command helps you to reset password for a specific user.'
  908. arguments: { user: { name: user, description: 'User ID', default: null }, password: { name: password, description: 'Password in text format', default: null } }
  909. options: { }
  910. 'views:debug':
  911. command: 'views:debug'
  912. aliases: { }
  913. description: 'Display current views resources for the application'
  914. synopsis: 'views:debug [--tag [TAG]] [--status [STATUS]] [--] [<view-id>]'
  915. usages: { }
  916. help: null
  917. arguments: { view-id: { name: view-id, description: 'View ID', default: null } }
  918. options: { tag: { name: tag, description: 'View tag', default: null, required: false, optional: true }, status: { name: status, description: 'View status (Enabled|Disabled)', default: null, required: false, optional: true } }
  919. 'views:disable':
  920. command: 'views:disable'
  921. aliases: { }
  922. description: 'Disable a View'
  923. synopsis: 'views:disable [<view-id>]'
  924. usages: { }
  925. help: null
  926. arguments: { view-id: { name: view-id, description: 'View ID', default: null } }
  927. options: { }
  928. 'views:enable':
  929. command: 'views:enable'
  930. aliases: { }
  931. description: 'Enable a View'
  932. synopsis: 'views:enable [<view-id>]'
  933. usages: { }
  934. help: null
  935. arguments: { view-id: { name: view-id, description: 'View ID', default: null } }
  936. options: { }
  937. 'yaml:diff':
  938. command: 'yaml:diff'
  939. aliases: { }
  940. description: 'Compare two YAML files in order to find differences between them.'
  941. synopsis: 'yaml:diff [--stats] [--negate] [--limit [LIMIT]] [--offset [OFFSET]] [--] <yaml-left> <yaml-right>'
  942. usages: { }
  943. help: null
  944. arguments: { yaml-left: { name: yaml-left, description: 'YAML file used as base to compare', default: null }, yaml-right: { name: yaml-right, description: 'YAML file used to find missing parts or differences with the base YAML file', default: null } }
  945. options: { stats: { name: stats, description: 'Print statistics about YAML files comparation', default: false, required: false, optional: false }, negate: { name: negate, description: 'Define mode diff or equal comparation, possible values TRUE/FALSE or 0/1', default: false, required: false, optional: false }, limit: { name: limit, description: 'Limit results to a specific number', default: null, required: false, optional: true }, offset: { name: offset, description: 'Starting point of a limit', default: null, required: false, optional: true } }
  946. 'yaml:merge':
  947. command: 'yaml:merge'
  948. aliases: { }
  949. description: 'Merge one or more YAML files in a new YAML file. Latest values are preserved.'
  950. synopsis: 'yaml:merge <yaml-destination> [<yaml-files>]...'
  951. usages: { }
  952. help: null
  953. arguments: { yaml-destination: { name: yaml-destination, description: 'Path of new YAML file to store the result of merge.', default: null }, yaml-files: { name: yaml-files, description: 'Path of YAML files to merge', default: { } } }
  954. options: { }
  955. 'yaml:split':
  956. command: 'yaml:split'
  957. aliases: { }
  958. description: 'Split a YAML file using indent as separator criteria'
  959. synopsis: 'yaml:split [--indent-level INDENT-LEVEL] [--file-output-prefix FILE-OUTPUT-PREFIX] [--file-output-suffix FILE-OUTPUT-SUFFIX] [--starting-key STARTING-KEY] [--exclude-parents-key] [--] <yaml-file>'
  960. usages: { }
  961. help: null
  962. arguments: { yaml-file: { name: yaml-file, description: commands.yaml.split.value.arguments.yaml-file, default: null } }
  963. options: { indent-level: { name: indent-level, description: 'Split YAML file using a specific indent level', default: null, required: true, optional: false }, file-output-prefix: { name: file-output-prefix, description: commands.yaml.split.options.file-output-prefix, default: null, required: true, optional: false }, file-output-suffix: { name: file-output-suffix, description: commands.yaml.split.options.file-output-suffix, default: null, required: true, optional: false }, starting-key: { name: starting-key, description: 'YAML Key from where start split useful to extract partial elements', default: null, required: true, optional: false }, exclude-parents-key: { name: exclude-parents-key, description: 'Exclude parents key in file name generated', default: false, required: false, optional: false } }
  964. 'yaml:update:key':
  965. command: 'yaml:update:key'
  966. aliases: { }
  967. description: 'Replace a YAML key in a YAML file.'
  968. synopsis: 'yaml:update:key <yaml-file> <yaml-key> <yaml-new-key>'
  969. usages: { }
  970. help: null
  971. arguments: { yaml-file: { name: yaml-file, description: 'Path of YAML file to update', default: null }, yaml-key: { name: yaml-key, description: 'YAML key to update', default: null }, yaml-new-key: { name: yaml-new-key, description: commands.yaml.update.value.arguments.yaml-new-key, default: null } }
  972. options: { }
  973. 'yaml:update:value':
  974. command: 'yaml:update:value'
  975. aliases: { }
  976. description: 'Update a value for a specific key in a YAML file.'
  977. synopsis: 'yaml:update:value <yaml-file> <yaml-key> <yaml-value>'
  978. usages: { }
  979. help: null
  980. arguments: { yaml-file: { name: yaml-file, description: 'Path of YAML file to update', default: null }, yaml-key: { name: yaml-key, description: 'YAML key to update', default: null }, yaml-value: { name: yaml-value, description: 'YAML value to update', default: null } }
  981. options: { }
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!