@mittwald/cli 1.0.0-alpha.10 → 1.0.0-alpha.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/README.md +1136 -579
  2. package/dist/esm/DeleteBaseCommand.js +1 -1
  3. package/dist/esm/Formatter.js +3 -0
  4. package/dist/esm/Helpers.d.ts +1 -0
  5. package/dist/esm/Helpers.js +7 -1
  6. package/dist/esm/ListBaseCommand.js +6 -1
  7. package/dist/esm/Translator.d.ts +1 -0
  8. package/dist/esm/Translator.js +11 -0
  9. package/dist/esm/commands/app/install/wordpress.js +1 -1
  10. package/dist/esm/commands/context/set.js +4 -3
  11. package/dist/esm/commands/database/mysql/charsets.d.ts +14 -3
  12. package/dist/esm/commands/database/mysql/charsets.js +25 -2
  13. package/dist/esm/commands/database/mysql/create.d.ts +23 -0
  14. package/dist/esm/commands/database/mysql/create.js +103 -0
  15. package/dist/esm/commands/database/mysql/delete.d.ts +14 -0
  16. package/dist/esm/commands/database/mysql/delete.js +20 -0
  17. package/dist/esm/commands/database/mysql/dump.d.ts +15 -0
  18. package/dist/esm/commands/database/mysql/dump.js +70 -0
  19. package/dist/esm/commands/database/mysql/get.d.ts +14 -2
  20. package/dist/esm/commands/database/mysql/get.js +14 -5
  21. package/dist/esm/commands/database/mysql/list.d.ts +11 -3
  22. package/dist/esm/commands/database/mysql/list.js +23 -13
  23. package/dist/esm/commands/database/mysql/phpmyadmin.d.ts +8 -0
  24. package/dist/esm/commands/database/mysql/phpmyadmin.js +25 -0
  25. package/dist/esm/commands/database/mysql/port-forward.d.ts +14 -0
  26. package/dist/esm/commands/database/mysql/port-forward.js +44 -0
  27. package/dist/esm/commands/database/mysql/shell.d.ts +14 -0
  28. package/dist/esm/commands/database/mysql/shell.js +39 -0
  29. package/dist/esm/commands/database/mysql/user/get.d.ts +13 -2
  30. package/dist/esm/commands/database/mysql/user/get.js +18 -5
  31. package/dist/esm/commands/database/mysql/user/list.d.ts +13 -3
  32. package/dist/esm/commands/database/mysql/user/list.js +38 -2
  33. package/dist/esm/commands/database/mysql/versions.d.ts +13 -3
  34. package/dist/esm/commands/database/mysql/versions.js +19 -2
  35. package/dist/esm/commands/database/redis/get.d.ts +15 -2
  36. package/dist/esm/commands/database/redis/get.js +21 -5
  37. package/dist/esm/commands/database/redis/list.d.ts +13 -3
  38. package/dist/esm/commands/database/redis/list.js +26 -2
  39. package/dist/esm/commands/database/redis/shell.d.ts +13 -0
  40. package/dist/esm/commands/database/redis/shell.js +26 -0
  41. package/dist/esm/commands/database/redis/versions.d.ts +11 -3
  42. package/dist/esm/commands/database/redis/versions.js +12 -2
  43. package/dist/esm/commands/domain/ownership/list.js +1 -0
  44. package/dist/esm/commands/domain/virtualhost/create.d.ts +26 -0
  45. package/dist/esm/commands/domain/virtualhost/create.js +122 -0
  46. package/dist/esm/commands/domain/virtualhost/delete.d.ts +13 -0
  47. package/dist/esm/commands/domain/virtualhost/delete.js +21 -0
  48. package/dist/esm/commands/domain/virtualhost/get.d.ts +13 -2
  49. package/dist/esm/commands/domain/virtualhost/get.js +85 -5
  50. package/dist/esm/commands/domain/virtualhost/list.d.ts +1 -1
  51. package/dist/esm/commands/domain/virtualhost/list.js +29 -13
  52. package/dist/esm/commands/login/reset.js +1 -1
  53. package/dist/esm/commands/mail/address/create.d.ts +16 -8
  54. package/dist/esm/commands/mail/address/create.js +52 -10
  55. package/dist/esm/commands/org/delete.d.ts +13 -0
  56. package/dist/esm/commands/org/delete.js +16 -0
  57. package/dist/esm/commands/org/invite/list-own.d.ts +46 -5
  58. package/dist/esm/commands/org/invite/list-own.js +38 -3
  59. package/dist/esm/commands/org/invite/list.d.ts +13 -3
  60. package/dist/esm/commands/org/invite/list.js +31 -2
  61. package/dist/esm/commands/org/invite/revoke.d.ts +17 -0
  62. package/dist/esm/commands/org/invite/revoke.js +39 -0
  63. package/dist/esm/commands/org/invite.d.ts +21 -0
  64. package/dist/esm/commands/org/invite.js +66 -0
  65. package/dist/esm/commands/org/list.d.ts +13 -4
  66. package/dist/esm/commands/org/list.js +21 -3
  67. package/dist/esm/commands/org/membership/list-own.d.ts +45 -5
  68. package/dist/esm/commands/org/membership/list-own.js +41 -3
  69. package/dist/esm/commands/org/membership/list.d.ts +33 -5
  70. package/dist/esm/commands/org/membership/list.js +40 -3
  71. package/dist/esm/commands/org/membership/revoke.d.ts +17 -0
  72. package/dist/esm/commands/org/membership/revoke.js +43 -0
  73. package/dist/esm/commands/project/create.js +1 -1
  74. package/dist/esm/commands/project/get.js +8 -4
  75. package/dist/esm/commands/project/list-react.js +1 -1
  76. package/dist/esm/commands/user/api-token/create.js +1 -1
  77. package/dist/esm/commands/user/ssh-key/create.js +1 -1
  78. package/dist/esm/generated/domain/listDomainOwnerships.d.ts +1 -1
  79. package/dist/esm/generated/domain/listDomainOwnerships.js +3 -6
  80. package/dist/esm/lib/context_flags.js +2 -1
  81. package/dist/esm/lib/database/common.d.ts +8 -0
  82. package/dist/esm/lib/database/common.js +17 -0
  83. package/dist/esm/lib/database/mysql/connect.d.ts +19 -0
  84. package/dist/esm/lib/database/mysql/connect.js +50 -0
  85. package/dist/esm/lib/database/mysql/flags.d.ts +10 -0
  86. package/dist/esm/lib/database/mysql/flags.js +48 -0
  87. package/dist/esm/lib/database/redis/connect.d.ts +8 -0
  88. package/dist/esm/lib/database/redis/connect.js +22 -0
  89. package/dist/esm/lib/database/redis/flags.d.ts +7 -0
  90. package/dist/esm/lib/database/redis/flags.js +35 -0
  91. package/dist/esm/lib/handleError.js +11 -0
  92. package/dist/esm/lib/org/flags.js +2 -1
  93. package/dist/esm/rendering/process/components/ProcessConfirmation.d.ts +6 -0
  94. package/dist/esm/rendering/process/components/ProcessConfirmation.js +12 -0
  95. package/dist/esm/rendering/process/components/ProcessConfirmationStateSummary.d.ts +5 -0
  96. package/dist/esm/rendering/process/components/ProcessConfirmationStateSummary.js +18 -0
  97. package/dist/esm/rendering/process/components/ProcessError.d.ts +4 -0
  98. package/dist/esm/rendering/process/components/ProcessError.js +10 -0
  99. package/dist/esm/rendering/process/components/ProcessInput.d.ts +6 -0
  100. package/dist/esm/rendering/process/components/ProcessInput.js +15 -0
  101. package/dist/esm/rendering/process/components/ProcessInputStateSummary.d.ts +5 -0
  102. package/dist/esm/rendering/process/components/ProcessInputStateSummary.js +13 -0
  103. package/dist/esm/rendering/process/components/ProcessState.d.ts +5 -0
  104. package/dist/esm/rendering/process/components/ProcessState.js +8 -0
  105. package/dist/esm/rendering/process/components/ProcessStateIcon.d.ts +5 -0
  106. package/dist/esm/rendering/process/components/ProcessStateIcon.js +22 -0
  107. package/dist/esm/rendering/process/components/ProcessStateSummary.d.ts +5 -0
  108. package/dist/esm/rendering/process/components/ProcessStateSummary.js +27 -0
  109. package/dist/esm/rendering/process/components/ProcessValidationErrors.d.ts +7 -0
  110. package/dist/esm/rendering/process/components/ProcessValidationErrors.js +15 -0
  111. package/dist/esm/rendering/{react → process}/process.d.ts +5 -5
  112. package/dist/esm/rendering/{react → process}/process_fancy.d.ts +1 -12
  113. package/dist/esm/rendering/process/process_fancy.js +119 -0
  114. package/dist/esm/rendering/process/process_flags.d.ts +20 -0
  115. package/dist/esm/rendering/process/process_flags.js +29 -0
  116. package/dist/esm/rendering/{react → process}/process_quiet.d.ts +2 -2
  117. package/dist/esm/rendering/react/components/ErrorBox.d.ts +11 -0
  118. package/dist/esm/rendering/react/components/ErrorBox.js +45 -0
  119. package/dist/esm/rendering/react/components/Ingress/DnsValidationErrors.d.ts +8 -0
  120. package/dist/esm/rendering/react/components/Ingress/DnsValidationErrors.js +17 -0
  121. package/dist/esm/rendering/react/components/Ingress/DomainOwnership.d.ts +8 -0
  122. package/dist/esm/rendering/react/components/Ingress/DomainOwnership.js +7 -0
  123. package/dist/esm/rendering/react/components/Note.d.ts +1 -2
  124. package/dist/esm/rendering/react/components/{ProjectReadiness.js → Project/ProjectReadiness.js} +1 -1
  125. package/dist/esm/rendering/react/components/Project/ProjectStatus.d.ts +18 -0
  126. package/dist/esm/rendering/react/components/Warning.d.ts +4 -0
  127. package/dist/esm/rendering/react/components/Warning.js +7 -0
  128. package/dist/esm/rendering/react/error.d.ts +7 -0
  129. package/dist/esm/rendering/react/error.js +12 -0
  130. package/package.json +28 -8
  131. package/dist/esm/commands/database/mysql/user/getMysqlUserPhpMyAdminUrl.d.ts +0 -3
  132. package/dist/esm/commands/database/mysql/user/getMysqlUserPhpMyAdminUrl.js +0 -7
  133. package/dist/esm/commands/org/invite/get.d.ts +0 -3
  134. package/dist/esm/commands/org/invite/get.js +0 -6
  135. package/dist/esm/commands/org/membership/get.d.ts +0 -3
  136. package/dist/esm/commands/org/membership/get.js +0 -6
  137. package/dist/esm/generated/customer/getCustomerCategory.d.ts +0 -16
  138. package/dist/esm/generated/customer/getCustomerCategory.js +0 -25
  139. package/dist/esm/generated/customer/getCustomerInvite.d.ts +0 -16
  140. package/dist/esm/generated/customer/getCustomerInvite.js +0 -25
  141. package/dist/esm/generated/customer/getCustomerMembership.d.ts +0 -16
  142. package/dist/esm/generated/customer/getCustomerMembership.js +0 -25
  143. package/dist/esm/generated/customer/listCustomerInvites.d.ts +0 -13
  144. package/dist/esm/generated/customer/listCustomerInvites.js +0 -17
  145. package/dist/esm/generated/customer/listCustomerMemberships.d.ts +0 -13
  146. package/dist/esm/generated/customer/listCustomerMemberships.js +0 -17
  147. package/dist/esm/generated/customer/listCustomers.d.ts +0 -13
  148. package/dist/esm/generated/customer/listCustomers.js +0 -17
  149. package/dist/esm/generated/customer/listInvitesForCustomer.d.ts +0 -13
  150. package/dist/esm/generated/customer/listInvitesForCustomer.js +0 -24
  151. package/dist/esm/generated/customer/listMembershipsForCustomer.d.ts +0 -13
  152. package/dist/esm/generated/customer/listMembershipsForCustomer.js +0 -24
  153. package/dist/esm/generated/customer/listOfCustomerCategories.d.ts +0 -13
  154. package/dist/esm/generated/customer/listOfCustomerCategories.js +0 -17
  155. package/dist/esm/generated/database/getMysqlDatabase.d.ts +0 -16
  156. package/dist/esm/generated/database/getMysqlDatabase.js +0 -25
  157. package/dist/esm/generated/database/getMysqlUser.d.ts +0 -16
  158. package/dist/esm/generated/database/getMysqlUser.js +0 -25
  159. package/dist/esm/generated/database/getMysqlUserPhpMyAdminUrl.d.ts +0 -14
  160. package/dist/esm/generated/database/getMysqlUserPhpMyAdminUrl.js +0 -24
  161. package/dist/esm/generated/database/getRedisDatabase.d.ts +0 -16
  162. package/dist/esm/generated/database/getRedisDatabase.js +0 -25
  163. package/dist/esm/generated/database/listMysqlCharsets.d.ts +0 -13
  164. package/dist/esm/generated/database/listMysqlCharsets.js +0 -17
  165. package/dist/esm/generated/database/listMysqlDatabases.d.ts +0 -13
  166. package/dist/esm/generated/database/listMysqlDatabases.js +0 -24
  167. package/dist/esm/generated/database/listMysqlUsers.d.ts +0 -13
  168. package/dist/esm/generated/database/listMysqlUsers.js +0 -24
  169. package/dist/esm/generated/database/listMysqlVersions.d.ts +0 -13
  170. package/dist/esm/generated/database/listMysqlVersions.js +0 -17
  171. package/dist/esm/generated/database/listRedisDatabases.d.ts +0 -13
  172. package/dist/esm/generated/database/listRedisDatabases.js +0 -24
  173. package/dist/esm/generated/database/listRedisVersions.d.ts +0 -13
  174. package/dist/esm/generated/database/listRedisVersions.js +0 -17
  175. package/dist/esm/generated/domain/ingressGetSpecific.d.ts +0 -16
  176. package/dist/esm/generated/domain/ingressGetSpecific.js +0 -25
  177. package/dist/esm/rendering/react/components/ProjectStatus.d.ts +0 -7
  178. package/dist/esm/rendering/react/process_fancy.js +0 -221
  179. package/dist/esm/rendering/react/process_flags.d.ts +0 -9
  180. package/dist/esm/rendering/react/process_flags.js +0 -15
  181. /package/dist/esm/rendering/{react → process}/process.js +0 -0
  182. /package/dist/esm/rendering/{react → process}/process_quiet.js +0 -0
  183. /package/dist/esm/rendering/react/components/{ProjectEnabled.d.ts → Project/ProjectEnabled.d.ts} +0 -0
  184. /package/dist/esm/rendering/react/components/{ProjectEnabled.js → Project/ProjectEnabled.js} +0 -0
  185. /package/dist/esm/rendering/react/components/{ProjectReadiness.d.ts → Project/ProjectReadiness.d.ts} +0 -0
  186. /package/dist/esm/rendering/react/components/{ProjectStatus.js → Project/ProjectStatus.js} +0 -0
package/README.md CHANGED
@@ -26,8 +26,6 @@ installation instructions.
26
26
 
27
27
  ## Usage
28
28
 
29
- <!-- usage -->
30
-
31
29
  ```sh-session
32
30
  $ npm install -g @mittwald/cli
33
31
  $ mw COMMAND
@@ -40,125 +38,132 @@ USAGE
40
38
  ...
41
39
  ```
42
40
 
43
- <!-- usagestop -->
44
-
45
41
  ## Commands
46
42
 
47
43
  <!-- commands -->
48
-
49
- - [`mw app delete ID`](#mw-app-delete-id)
50
- - [`mw app dependency getSystemsoftware SYSTEMSOFTWAREID`](#mw-app-dependency-getsystemsoftware-systemsoftwareid)
51
- - [`mw app dependency getSystemsoftwareversion SYSTEMSOFTWAREVERSIONID`](#mw-app-dependency-getsystemsoftwareversion-systemsoftwareversionid)
52
- - [`mw app dependency listSystemsoftwares`](#mw-app-dependency-listsystemsoftwares)
53
- - [`mw app dependency listSystemsoftwareversions`](#mw-app-dependency-listsystemsoftwareversions)
54
- - [`mw app get APPINSTALLATIONID`](#mw-app-get-appinstallationid)
55
- - [`mw app install wordpress`](#mw-app-install-wordpress)
56
- - [`mw app list`](#mw-app-list)
57
- - [`mw app versions [APP]`](#mw-app-versions-app)
58
- - [`mw article get ARTICLEID`](#mw-article-get-articleid)
59
- - [`mw article list`](#mw-article-list)
60
- - [`mw contract getBaseItemOfContract`](#mw-contract-getbaseitemofcontract)
61
- - [`mw contract getDetailOfContract CONTRACTID`](#mw-contract-getdetailofcontract-contractid)
62
- - [`mw contract getDetailOfContractByDomain`](#mw-contract-getdetailofcontractbydomain)
63
- - [`mw contract getDetailOfContractByProject`](#mw-contract-getdetailofcontractbyproject)
64
- - [`mw contract getDetailOfContractByServer`](#mw-contract-getdetailofcontractbyserver)
65
- - [`mw contract getDetailOfContractItem CONTRACTITEMID`](#mw-contract-getdetailofcontractitem-contractitemid)
66
- - [`mw contract getNextTerminationDateForItem`](#mw-contract-getnextterminationdateforitem)
67
- - [`mw contract invoiceDetailOfInvoice INVOICEID`](#mw-contract-invoicedetailofinvoice-invoiceid)
68
- - [`mw contract invoiceGetDetailOfInvoiceSettings`](#mw-contract-invoicegetdetailofinvoicesettings)
69
- - [`mw contract invoiceListCustomerInvoices`](#mw-contract-invoicelistcustomerinvoices)
70
- - [`mw contract listContracts`](#mw-contract-listcontracts)
71
- - [`mw contract orderGetOrder ORDERID`](#mw-contract-ordergetorder-orderid)
72
- - [`mw contract orderListCustomerOrders`](#mw-contract-orderlistcustomerorders)
73
- - [`mw contract orderListProjectOrders`](#mw-contract-orderlistprojectorders)
74
- - [`mw conversation categories`](#mw-conversation-categories)
75
- - [`mw conversation close ID`](#mw-conversation-close-id)
76
- - [`mw conversation create`](#mw-conversation-create)
77
- - [`mw conversation list`](#mw-conversation-list)
78
- - [`mw conversation reply ID`](#mw-conversation-reply-id)
79
- - [`mw conversation show ID`](#mw-conversation-show-id)
80
- - [`mw conversation show2 CONVERSATIONID`](#mw-conversation-show2-conversationid)
81
- - [`mw database mysql charsets`](#mw-database-mysql-charsets)
82
- - [`mw database mysql get ID`](#mw-database-mysql-get-id)
83
- - [`mw database mysql list`](#mw-database-mysql-list)
84
- - [`mw database mysql user get ID`](#mw-database-mysql-user-get-id)
85
- - [`mw database mysql user getMysqlUserPhpMyAdminUrl`](#mw-database-mysql-user-getmysqluserphpmyadminurl)
86
- - [`mw database mysql user list`](#mw-database-mysql-user-list)
87
- - [`mw database mysql versions`](#mw-database-mysql-versions)
88
- - [`mw database redis get ID`](#mw-database-redis-get-id)
89
- - [`mw database redis list`](#mw-database-redis-list)
90
- - [`mw database redis versions`](#mw-database-redis-versions)
91
- - [`mw domain dnszone get ZONEID`](#mw-domain-dnszone-get-zoneid)
92
- - [`mw domain dnszone list`](#mw-domain-dnszone-list)
93
- - [`mw domain get DOMAINID`](#mw-domain-get-domainid)
94
- - [`mw domain get-handle DOMAINNAME`](#mw-domain-get-handle-domainname)
95
- - [`mw domain list`](#mw-domain-list)
96
- - [`mw domain ownership get DOMAINOWNERSHIPID`](#mw-domain-ownership-get-domainownershipid)
97
- - [`mw domain ownership list`](#mw-domain-ownership-list)
98
- - [`mw domain tld get TLD`](#mw-domain-tld-get-tld)
99
- - [`mw domain tld list`](#mw-domain-tld-list)
100
- - [`mw domain virtualhost get INGRESSID`](#mw-domain-virtualhost-get-ingressid)
101
- - [`mw domain virtualhost list`](#mw-domain-virtualhost-list)
102
- - [`mw help [COMMANDS]`](#mw-help-commands)
103
- - [`mw login status`](#mw-login-status)
104
- - [`mw login token`](#mw-login-token)
105
- - [`mw mail address create`](#mw-mail-address-create)
106
- - [`mw mail address delete ID`](#mw-mail-address-delete-id)
107
- - [`mw mail address get ID`](#mw-mail-address-get-id)
108
- - [`mw mail address list`](#mw-mail-address-list)
109
- - [`mw mail deliverybox get ID`](#mw-mail-deliverybox-get-id)
110
- - [`mw mail deliverybox list`](#mw-mail-deliverybox-list)
111
- - [`mw org can-order`](#mw-org-can-order)
112
- - [`mw org get CUSTOMERID`](#mw-org-get-customerid)
113
- - [`mw org invite get INVITEID`](#mw-org-invite-get-inviteid)
114
- - [`mw org invite list`](#mw-org-invite-list)
115
- - [`mw org invite list-own`](#mw-org-invite-list-own)
116
- - [`mw org list`](#mw-org-list)
117
- - [`mw org membership get MEMBERSHIPID`](#mw-org-membership-get-membershipid)
118
- - [`mw org membership list`](#mw-org-membership-list)
119
- - [`mw org membership list-own`](#mw-org-membership-list-own)
120
- - [`mw project backup get PROJECTBACKUPID`](#mw-project-backup-get-projectbackupid)
121
- - [`mw project backup list`](#mw-project-backup-list)
122
- - [`mw project backupschedule get PROJECTBACKUPSCHEDULEID`](#mw-project-backupschedule-get-projectbackupscheduleid)
123
- - [`mw project backupschedule list`](#mw-project-backupschedule-list)
124
- - [`mw project create`](#mw-project-create)
125
- - [`mw project cronjob execution get EXECUTIONID`](#mw-project-cronjob-execution-get-executionid)
126
- - [`mw project cronjob execution list`](#mw-project-cronjob-execution-list)
127
- - [`mw project cronjob get CRONJOBID`](#mw-project-cronjob-get-cronjobid)
128
- - [`mw project cronjob list`](#mw-project-cronjob-list)
129
- - [`mw project delete ID`](#mw-project-delete-id)
130
- - [`mw project filesystem directories`](#mw-project-filesystem-directories)
131
- - [`mw project filesystem file-content`](#mw-project-filesystem-file-content)
132
- - [`mw project filesystem files PROJECTID`](#mw-project-filesystem-files-projectid)
133
- - [`mw project filesystem usage`](#mw-project-filesystem-usage)
134
- - [`mw project get ID`](#mw-project-get-id)
135
- - [`mw project invite get INVITEID`](#mw-project-invite-get-inviteid)
136
- - [`mw project invite list`](#mw-project-invite-list)
137
- - [`mw project invite list-own`](#mw-project-invite-list-own)
138
- - [`mw project list`](#mw-project-list)
139
- - [`mw project list1`](#mw-project-list1)
140
- - [`mw project list2`](#mw-project-list2)
141
- - [`mw project membership get MEMBERSHIPID`](#mw-project-membership-get-membershipid)
142
- - [`mw project membership get-own`](#mw-project-membership-get-own)
143
- - [`mw project membership list`](#mw-project-membership-list)
144
- - [`mw project membership list-own`](#mw-project-membership-list-own)
145
- - [`mw project sftp-user list`](#mw-project-sftp-user-list)
146
- - [`mw project ssh ID`](#mw-project-ssh-id)
147
- - [`mw project ssh-user list`](#mw-project-ssh-user-list)
148
- - [`mw project update ID`](#mw-project-update-id)
149
- - [`mw server get SERVERID`](#mw-server-get-serverid)
150
- - [`mw server list`](#mw-server-list)
151
- - [`mw user api-token create`](#mw-user-api-token-create)
152
- - [`mw user api-token get APITOKENID`](#mw-user-api-token-get-apitokenid)
153
- - [`mw user api-token list`](#mw-user-api-token-list)
154
- - [`mw user api-token revoke ID`](#mw-user-api-token-revoke-id)
155
- - [`mw user get`](#mw-user-get)
156
- - [`mw user session get TOKENID`](#mw-user-session-get-tokenid)
157
- - [`mw user session list`](#mw-user-session-list)
158
- - [`mw user ssh-key create`](#mw-user-ssh-key-create)
159
- - [`mw user ssh-key delete ID`](#mw-user-ssh-key-delete-id)
160
- - [`mw user ssh-key get SSHKEYID`](#mw-user-ssh-key-get-sshkeyid)
161
- - [`mw user ssh-key list`](#mw-user-ssh-key-list)
44
+ * [`mw app delete ID`](#mw-app-delete-id)
45
+ * [`mw app dependency getSystemsoftware SYSTEMSOFTWAREID`](#mw-app-dependency-getsystemsoftware-systemsoftwareid)
46
+ * [`mw app dependency getSystemsoftwareversion SYSTEMSOFTWAREVERSIONID`](#mw-app-dependency-getsystemsoftwareversion-systemsoftwareversionid)
47
+ * [`mw app dependency listSystemsoftwares`](#mw-app-dependency-listsystemsoftwares)
48
+ * [`mw app dependency listSystemsoftwareversions`](#mw-app-dependency-listsystemsoftwareversions)
49
+ * [`mw app get APPINSTALLATIONID`](#mw-app-get-appinstallationid)
50
+ * [`mw app install wordpress`](#mw-app-install-wordpress)
51
+ * [`mw app list`](#mw-app-list)
52
+ * [`mw app versions [APP]`](#mw-app-versions-app)
53
+ * [`mw article get ARTICLEID`](#mw-article-get-articleid)
54
+ * [`mw article list`](#mw-article-list)
55
+ * [`mw context get`](#mw-context-get)
56
+ * [`mw context set`](#mw-context-set)
57
+ * [`mw contract getBaseItemOfContract`](#mw-contract-getbaseitemofcontract)
58
+ * [`mw contract getDetailOfContract CONTRACTID`](#mw-contract-getdetailofcontract-contractid)
59
+ * [`mw contract getDetailOfContractByDomain`](#mw-contract-getdetailofcontractbydomain)
60
+ * [`mw contract getDetailOfContractByProject`](#mw-contract-getdetailofcontractbyproject)
61
+ * [`mw contract getDetailOfContractByServer`](#mw-contract-getdetailofcontractbyserver)
62
+ * [`mw contract getDetailOfContractItem CONTRACTITEMID`](#mw-contract-getdetailofcontractitem-contractitemid)
63
+ * [`mw contract getNextTerminationDateForItem`](#mw-contract-getnextterminationdateforitem)
64
+ * [`mw contract invoiceDetailOfInvoice INVOICEID`](#mw-contract-invoicedetailofinvoice-invoiceid)
65
+ * [`mw contract invoiceGetDetailOfInvoiceSettings`](#mw-contract-invoicegetdetailofinvoicesettings)
66
+ * [`mw contract invoiceListCustomerInvoices`](#mw-contract-invoicelistcustomerinvoices)
67
+ * [`mw contract listContracts`](#mw-contract-listcontracts)
68
+ * [`mw contract orderGetOrder ORDERID`](#mw-contract-ordergetorder-orderid)
69
+ * [`mw contract orderListCustomerOrders`](#mw-contract-orderlistcustomerorders)
70
+ * [`mw contract orderListProjectOrders`](#mw-contract-orderlistprojectorders)
71
+ * [`mw conversation categories`](#mw-conversation-categories)
72
+ * [`mw conversation close ID`](#mw-conversation-close-id)
73
+ * [`mw conversation create`](#mw-conversation-create)
74
+ * [`mw conversation list`](#mw-conversation-list)
75
+ * [`mw conversation reply ID`](#mw-conversation-reply-id)
76
+ * [`mw conversation show ID`](#mw-conversation-show-id)
77
+ * [`mw conversation show2 CONVERSATIONID`](#mw-conversation-show2-conversationid)
78
+ * [`mw database mysql charsets`](#mw-database-mysql-charsets)
79
+ * [`mw database mysql create`](#mw-database-mysql-create)
80
+ * [`mw database mysql delete DATABASE-ID`](#mw-database-mysql-delete-database-id)
81
+ * [`mw database mysql dump DATABASE-ID`](#mw-database-mysql-dump-database-id)
82
+ * [`mw database mysql get DATABASE-ID`](#mw-database-mysql-get-database-id)
83
+ * [`mw database mysql list`](#mw-database-mysql-list)
84
+ * [`mw database mysql phpmyadmin DATABASE-ID`](#mw-database-mysql-phpmyadmin-database-id)
85
+ * [`mw database mysql port-forward DATABASE-ID`](#mw-database-mysql-port-forward-database-id)
86
+ * [`mw database mysql shell DATABASE-ID`](#mw-database-mysql-shell-database-id)
87
+ * [`mw database mysql user get ID`](#mw-database-mysql-user-get-id)
88
+ * [`mw database mysql user list`](#mw-database-mysql-user-list)
89
+ * [`mw database mysql versions`](#mw-database-mysql-versions)
90
+ * [`mw database redis get ID`](#mw-database-redis-get-id)
91
+ * [`mw database redis list`](#mw-database-redis-list)
92
+ * [`mw database redis shell DATABASE-ID`](#mw-database-redis-shell-database-id)
93
+ * [`mw database redis versions`](#mw-database-redis-versions)
94
+ * [`mw domain dnszone get ZONEID`](#mw-domain-dnszone-get-zoneid)
95
+ * [`mw domain dnszone list`](#mw-domain-dnszone-list)
96
+ * [`mw domain get DOMAINID`](#mw-domain-get-domainid)
97
+ * [`mw domain get-handle DOMAINNAME`](#mw-domain-get-handle-domainname)
98
+ * [`mw domain list`](#mw-domain-list)
99
+ * [`mw domain ownership get DOMAINOWNERSHIPID`](#mw-domain-ownership-get-domainownershipid)
100
+ * [`mw domain ownership list`](#mw-domain-ownership-list)
101
+ * [`mw domain tld get TLD`](#mw-domain-tld-get-tld)
102
+ * [`mw domain tld list`](#mw-domain-tld-list)
103
+ * [`mw domain virtualhost create`](#mw-domain-virtualhost-create)
104
+ * [`mw domain virtualhost delete VIRTUAL-HOST-ID`](#mw-domain-virtualhost-delete-virtual-host-id)
105
+ * [`mw domain virtualhost get INGRESS-ID`](#mw-domain-virtualhost-get-ingress-id)
106
+ * [`mw domain virtualhost list`](#mw-domain-virtualhost-list)
107
+ * [`mw help [COMMANDS]`](#mw-help-commands)
108
+ * [`mw login reset`](#mw-login-reset)
109
+ * [`mw login status`](#mw-login-status)
110
+ * [`mw login token`](#mw-login-token)
111
+ * [`mw mail address create`](#mw-mail-address-create)
112
+ * [`mw mail address delete ID`](#mw-mail-address-delete-id)
113
+ * [`mw mail address get ID`](#mw-mail-address-get-id)
114
+ * [`mw mail address list`](#mw-mail-address-list)
115
+ * [`mw mail deliverybox get ID`](#mw-mail-deliverybox-get-id)
116
+ * [`mw mail deliverybox list`](#mw-mail-deliverybox-list)
117
+ * [`mw org delete [ORG-ID]`](#mw-org-delete-org-id)
118
+ * [`mw org get [ORG-ID]`](#mw-org-get-org-id)
119
+ * [`mw org invite`](#mw-org-invite)
120
+ * [`mw org invite list`](#mw-org-invite-list)
121
+ * [`mw org invite list-own`](#mw-org-invite-list-own)
122
+ * [`mw org invite revoke INVITE-ID`](#mw-org-invite-revoke-invite-id)
123
+ * [`mw org list`](#mw-org-list)
124
+ * [`mw org membership list`](#mw-org-membership-list)
125
+ * [`mw org membership list-own`](#mw-org-membership-list-own)
126
+ * [`mw org membership revoke MEMBERSHIP-ID`](#mw-org-membership-revoke-membership-id)
127
+ * [`mw project backup get PROJECTBACKUPID`](#mw-project-backup-get-projectbackupid)
128
+ * [`mw project backup list`](#mw-project-backup-list)
129
+ * [`mw project backupschedule get PROJECTBACKUPSCHEDULEID`](#mw-project-backupschedule-get-projectbackupscheduleid)
130
+ * [`mw project backupschedule list`](#mw-project-backupschedule-list)
131
+ * [`mw project create`](#mw-project-create)
132
+ * [`mw project cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-get-cronjob-id-execution-id)
133
+ * [`mw project cronjob execution list`](#mw-project-cronjob-execution-list)
134
+ * [`mw project cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-logs-cronjob-id-execution-id)
135
+ * [`mw project cronjob get CRONJOBID`](#mw-project-cronjob-get-cronjobid)
136
+ * [`mw project cronjob list`](#mw-project-cronjob-list)
137
+ * [`mw project delete [PROJECT-ID]`](#mw-project-delete-project-id)
138
+ * [`mw project filesystem usage [PROJECT-ID]`](#mw-project-filesystem-usage-project-id)
139
+ * [`mw project get [PROJECT-ID]`](#mw-project-get-project-id)
140
+ * [`mw project invite get INVITEID`](#mw-project-invite-get-inviteid)
141
+ * [`mw project invite list`](#mw-project-invite-list)
142
+ * [`mw project invite list-own`](#mw-project-invite-list-own)
143
+ * [`mw project list`](#mw-project-list)
144
+ * [`mw project list-react`](#mw-project-list-react)
145
+ * [`mw project membership get MEMBERSHIPID`](#mw-project-membership-get-membershipid)
146
+ * [`mw project membership get-own`](#mw-project-membership-get-own)
147
+ * [`mw project membership list`](#mw-project-membership-list)
148
+ * [`mw project membership list-own`](#mw-project-membership-list-own)
149
+ * [`mw project sftp-user list`](#mw-project-sftp-user-list)
150
+ * [`mw project ssh [PROJECT-ID]`](#mw-project-ssh-project-id)
151
+ * [`mw project ssh-user list`](#mw-project-ssh-user-list)
152
+ * [`mw project update [PROJECT-ID]`](#mw-project-update-project-id)
153
+ * [`mw server get SERVERID`](#mw-server-get-serverid)
154
+ * [`mw server list`](#mw-server-list)
155
+ * [`mw update [CHANNEL]`](#mw-update-channel)
156
+ * [`mw user api-token create`](#mw-user-api-token-create)
157
+ * [`mw user api-token get APITOKENID`](#mw-user-api-token-get-apitokenid)
158
+ * [`mw user api-token list`](#mw-user-api-token-list)
159
+ * [`mw user api-token revoke ID`](#mw-user-api-token-revoke-id)
160
+ * [`mw user get`](#mw-user-get)
161
+ * [`mw user session get TOKENID`](#mw-user-session-get-tokenid)
162
+ * [`mw user session list`](#mw-user-session-list)
163
+ * [`mw user ssh-key create`](#mw-user-ssh-key-create)
164
+ * [`mw user ssh-key delete ID`](#mw-user-ssh-key-delete-id)
165
+ * [`mw user ssh-key get SSHKEYID`](#mw-user-ssh-key-get-sshkeyid)
166
+ * [`mw user ssh-key list`](#mw-user-ssh-key-list)
162
167
 
163
168
  ## `mw app delete ID`
164
169
 
@@ -184,14 +189,14 @@ get a specific `SystemSoftware`
184
189
 
185
190
  ```
186
191
  USAGE
187
- $ mw app dependency getSystemsoftware SYSTEMSOFTWAREID [--output json|yaml | | ]
192
+ $ mw app dependency getSystemsoftware SYSTEMSOFTWAREID [-o json|yaml | | ]
188
193
 
189
194
  ARGUMENTS
190
195
  SYSTEMSOFTWAREID undefined
191
196
 
192
197
  FLAGS
193
- --output=<option> output in a more machine friendly format
194
- <options: json|yaml>
198
+ -o, --output=<option> output in a more machine friendly format
199
+ <options: json|yaml>
195
200
 
196
201
  DESCRIPTION
197
202
  get a specific `SystemSoftware`
@@ -203,14 +208,13 @@ get a specific `SystemSoftwareVersion`
203
208
 
204
209
  ```
205
210
  USAGE
206
- $ mw app dependency getSystemsoftwareversion SYSTEMSOFTWAREVERSIONID --system-software-id <value> [--output json|yaml
207
- | | ]
211
+ $ mw app dependency getSystemsoftwareversion SYSTEMSOFTWAREVERSIONID --system-software-id <value> [-o json|yaml | | ]
208
212
 
209
213
  ARGUMENTS
210
214
  SYSTEMSOFTWAREVERSIONID undefined
211
215
 
212
216
  FLAGS
213
- --output=<option> output in a more machine friendly format
217
+ -o, --output=<option> output in a more machine friendly format
214
218
  <options: json|yaml>
215
219
  --system-software-id=<value> (required) undefined
216
220
 
@@ -273,14 +277,14 @@ get a specific `AppInstallation`
273
277
 
274
278
  ```
275
279
  USAGE
276
- $ mw app get APPINSTALLATIONID [--output json|yaml | | ]
280
+ $ mw app get APPINSTALLATIONID [-o json|yaml | | ]
277
281
 
278
282
  ARGUMENTS
279
283
  APPINSTALLATIONID undefined
280
284
 
281
285
  FLAGS
282
- --output=<option> output in a more machine friendly format
283
- <options: json|yaml>
286
+ -o, --output=<option> output in a more machine friendly format
287
+ <options: json|yaml>
284
288
 
285
289
  DESCRIPTION
286
290
  get a specific `AppInstallation`
@@ -292,21 +296,34 @@ Creates new WordPress Installation.
292
296
 
293
297
  ```
294
298
  USAGE
295
- $ mw app install wordpress -p <value> --host <value> --admin-user <value> --admin-email <value> --admin-pass <value>
296
- --site-title <value> [--version <value>] [-w]
299
+ $ mw app install wordpress --version <value> --host <value> --admin-user <value> --admin-email <value> --admin-pass
300
+ <value> --site-title <value> [-p <value>] [-q] [-w]
297
301
 
298
302
  FLAGS
299
- -p, --project-id=<value> (required) ID of the Project, in which the App will be created.
303
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
304
+ context
305
+ -q, --quiet suppress process output and only display a machine-readable summary.
300
306
  -w, --wait Wait for the App to be ready.
301
307
  --admin-email=<value> (required) First Admin Users E-Mail.
302
308
  --admin-pass=<value> (required) First Admin Users Password.
303
309
  --admin-user=<value> (required) First Admin User for the app.
304
310
  --host=<value> (required) Host under which the App will be available (Needs to be created separately).
305
311
  --site-title=<value> (required) Site Title of the created appInstallation.
306
- --version=<value> Version of the App to be created - Defaults to latest
312
+ --version=<value> (required) [default: latest] Version of the App to be created - Defaults to latest
307
313
 
308
314
  DESCRIPTION
309
315
  Creates new WordPress Installation.
316
+
317
+ FLAG DESCRIPTIONS
318
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
319
+
320
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
321
+ to persistently set a default project for all commands that accept this flag.
322
+
323
+ -q, --quiet suppress process output and only display a machine-readable summary.
324
+
325
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
326
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
310
327
  ```
311
328
 
312
329
  ## `mw app list`
@@ -315,23 +332,30 @@ List projects
315
332
 
316
333
  ```
317
334
  USAGE
318
- $ mw app list -p <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
319
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
335
+ $ mw app list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
336
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
320
337
 
321
338
  FLAGS
322
- -p, --project=<value> (required) project to run the command for
323
- -x, --extended show extra columns
324
- --columns=<value> only show provided columns (comma-separated)
325
- --csv output is csv format [alias: --output=csv]
326
- --filter=<value> filter property by partial string matching, ex: name=foo
327
- --no-header hide table header from output
328
- --no-truncate do not truncate output to fit screen
329
- --output=<option> output in a more machine friendly format
330
- <options: csv|json|yaml>
331
- --sort=<value> property to sort by (prepend '-' for descending)
339
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
340
+ context
341
+ -x, --extended show extra columns
342
+ --columns=<value> only show provided columns (comma-separated)
343
+ --csv output is csv format [alias: --output=csv]
344
+ --filter=<value> filter property by partial string matching, ex: name=foo
345
+ --no-header hide table header from output
346
+ --no-truncate do not truncate output to fit screen
347
+ --output=<option> output in a more machine friendly format
348
+ <options: csv|json|yaml>
349
+ --sort=<value> property to sort by (prepend '-' for descending)
332
350
 
333
351
  DESCRIPTION
334
352
  List projects
353
+
354
+ FLAG DESCRIPTIONS
355
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
356
+
357
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
358
+ to persistently set a default project for all commands that accept this flag.
335
359
  ```
336
360
 
337
361
  ## `mw app versions [APP]`
@@ -355,14 +379,14 @@ Get an Article.
355
379
 
356
380
  ```
357
381
  USAGE
358
- $ mw article get ARTICLEID [--output json|yaml | | ]
382
+ $ mw article get ARTICLEID [-o json|yaml | | ]
359
383
 
360
384
  ARGUMENTS
361
385
  ARTICLEID undefined
362
386
 
363
387
  FLAGS
364
- --output=<option> output in a more machine friendly format
365
- <options: json|yaml>
388
+ -o, --output=<option> output in a more machine friendly format
389
+ <options: json|yaml>
366
390
 
367
391
  DESCRIPTION
368
392
  Get an Article.
@@ -392,18 +416,58 @@ DESCRIPTION
392
416
  List Articles.
393
417
  ```
394
418
 
419
+ ## `mw context get`
420
+
421
+ Print an overview of currently set context parameters
422
+
423
+ ```
424
+ USAGE
425
+ $ mw context get -o txt|json
426
+
427
+ FLAGS
428
+ -o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
429
+ representation, and 'json' for a machine-readable JSON representation.
430
+ <options: txt|json>
431
+
432
+ DESCRIPTION
433
+ Print an overview of currently set context parameters
434
+
435
+ The context allows you to persistently set values for common parameters, like --project-id or --server-id, so you
436
+ don't have to specify them on every command.
437
+ ```
438
+
439
+ ## `mw context set`
440
+
441
+ Set context values for the current project, org or server
442
+
443
+ ```
444
+ USAGE
445
+ $ mw context set [--project-id <value>] [--server-id <value>] [--org-id <value>]
446
+
447
+ FLAGS
448
+ --org-id=<value> ID or short ID of an organization
449
+ --project-id=<value> ID or short ID of a project
450
+ --server-id=<value> ID or short ID of a server
451
+
452
+ DESCRIPTION
453
+ Set context values for the current project, org or server
454
+
455
+ The context allows you to persistently set values for common parameters, like --project-id or --server-id, so you
456
+ don't have to specify them on every command.
457
+ ```
458
+
395
459
  ## `mw contract getBaseItemOfContract`
396
460
 
397
461
  Return the BaseItem of the Contract with the given ID.
398
462
 
399
463
  ```
400
464
  USAGE
401
- $ mw contract getBaseItemOfContract --contract-id <value> [--output json|yaml | | ]
465
+ $ mw contract getBaseItemOfContract --contract-id <value> [-o json|yaml | | ]
402
466
 
403
467
  FLAGS
404
- --contract-id=<value> (required) The uuid of the Contract from which the BaseItem is to be issued.
405
- --output=<option> output in a more machine friendly format
468
+ -o, --output=<option> output in a more machine friendly format
406
469
  <options: json|yaml>
470
+ --contract-id=<value> (required) The uuid of the Contract from which the BaseItem is to be issued.
407
471
 
408
472
  DESCRIPTION
409
473
  Return the BaseItem of the Contract with the given ID.
@@ -415,14 +479,14 @@ Returns the Contract with the given ID.
415
479
 
416
480
  ```
417
481
  USAGE
418
- $ mw contract getDetailOfContract CONTRACTID [--output json|yaml | | ]
482
+ $ mw contract getDetailOfContract CONTRACTID [-o json|yaml | | ]
419
483
 
420
484
  ARGUMENTS
421
485
  CONTRACTID The uuid of the Contract to be returned.
422
486
 
423
487
  FLAGS
424
- --output=<option> output in a more machine friendly format
425
- <options: json|yaml>
488
+ -o, --output=<option> output in a more machine friendly format
489
+ <options: json|yaml>
426
490
 
427
491
  DESCRIPTION
428
492
  Returns the Contract with the given ID.
@@ -434,12 +498,12 @@ Return the Contract for the given Domain.
434
498
 
435
499
  ```
436
500
  USAGE
437
- $ mw contract getDetailOfContractByDomain --domain-id <value> [--output json|yaml | | ]
501
+ $ mw contract getDetailOfContractByDomain --domain-id <value> [-o json|yaml | | ]
438
502
 
439
503
  FLAGS
440
- --domain-id=<value> (required) undefined
441
- --output=<option> output in a more machine friendly format
442
- <options: json|yaml>
504
+ -o, --output=<option> output in a more machine friendly format
505
+ <options: json|yaml>
506
+ --domain-id=<value> (required) undefined
443
507
 
444
508
  DESCRIPTION
445
509
  Return the Contract for the given Domain.
@@ -451,12 +515,12 @@ Return the Contract for the given Project.
451
515
 
452
516
  ```
453
517
  USAGE
454
- $ mw contract getDetailOfContractByProject --project-id <value> [--output json|yaml | | ]
518
+ $ mw contract getDetailOfContractByProject --project-id <value> [-o json|yaml | | ]
455
519
 
456
520
  FLAGS
457
- --output=<option> output in a more machine friendly format
458
- <options: json|yaml>
459
- --project-id=<value> (required) undefined
521
+ -o, --output=<option> output in a more machine friendly format
522
+ <options: json|yaml>
523
+ --project-id=<value> (required) undefined
460
524
 
461
525
  DESCRIPTION
462
526
  Return the Contract for the given Project.
@@ -468,12 +532,12 @@ Return the Contract for the given Server.
468
532
 
469
533
  ```
470
534
  USAGE
471
- $ mw contract getDetailOfContractByServer --server-id <value> [--output json|yaml | | ]
535
+ $ mw contract getDetailOfContractByServer --server-id <value> [-o json|yaml | | ]
472
536
 
473
537
  FLAGS
474
- --output=<option> output in a more machine friendly format
475
- <options: json|yaml>
476
- --server-id=<value> (required) undefined
538
+ -o, --output=<option> output in a more machine friendly format
539
+ <options: json|yaml>
540
+ --server-id=<value> (required) undefined
477
541
 
478
542
  DESCRIPTION
479
543
  Return the Contract for the given Server.
@@ -485,15 +549,15 @@ Get the ContractItem with the given ID.
485
549
 
486
550
  ```
487
551
  USAGE
488
- $ mw contract getDetailOfContractItem CONTRACTITEMID --contract-id <value> [--output json|yaml | | ]
552
+ $ mw contract getDetailOfContractItem CONTRACTITEMID --contract-id <value> [-o json|yaml | | ]
489
553
 
490
554
  ARGUMENTS
491
555
  CONTRACTITEMID The uuid of the ContractItem to be returned.
492
556
 
493
557
  FLAGS
494
- --contract-id=<value> (required) The uuid of the Contract where the desired ContractItem belongs to.
495
- --output=<option> output in a more machine friendly format
558
+ -o, --output=<option> output in a more machine friendly format
496
559
  <options: json|yaml>
560
+ --contract-id=<value> (required) The uuid of the Contract where the desired ContractItem belongs to.
497
561
 
498
562
  DESCRIPTION
499
563
  Get the ContractItem with the given ID.
@@ -505,14 +569,13 @@ Return the next TerminationDate for the ContractItem with the given ID.
505
569
 
506
570
  ```
507
571
  USAGE
508
- $ mw contract getNextTerminationDateForItem --contract-id <value> --contract-item-id <value> [--output json|yaml | |
509
- ]
572
+ $ mw contract getNextTerminationDateForItem --contract-id <value> --contract-item-id <value> [-o json|yaml | | ]
510
573
 
511
574
  FLAGS
575
+ -o, --output=<option> output in a more machine friendly format
576
+ <options: json|yaml>
512
577
  --contract-id=<value> (required) The uuid of the Contract where the desired ContractItem belongs to.
513
578
  --contract-item-id=<value> (required) The uuid of the ContractItem whose next TerminationDate is to be displayed.
514
- --output=<option> output in a more machine friendly format
515
- <options: json|yaml>
516
579
 
517
580
  DESCRIPTION
518
581
  Return the next TerminationDate for the ContractItem with the given ID.
@@ -524,15 +587,15 @@ Get details of an Invoice.
524
587
 
525
588
  ```
526
589
  USAGE
527
- $ mw contract invoiceDetailOfInvoice INVOICEID --customer-id <value> [--output json|yaml | | ]
590
+ $ mw contract invoiceDetailOfInvoice INVOICEID --customer-id <value> [-o json|yaml | | ]
528
591
 
529
592
  ARGUMENTS
530
593
  INVOICEID undefined
531
594
 
532
595
  FLAGS
533
- --customer-id=<value> (required) undefined
534
- --output=<option> output in a more machine friendly format
596
+ -o, --output=<option> output in a more machine friendly format
535
597
  <options: json|yaml>
598
+ --customer-id=<value> (required) undefined
536
599
 
537
600
  DESCRIPTION
538
601
  Get details of an Invoice.
@@ -544,12 +607,12 @@ Get InvoiceSettings of a Customer.
544
607
 
545
608
  ```
546
609
  USAGE
547
- $ mw contract invoiceGetDetailOfInvoiceSettings --customer-id <value> [--output json|yaml | | ]
610
+ $ mw contract invoiceGetDetailOfInvoiceSettings --customer-id <value> [-o json|yaml | | ]
548
611
 
549
612
  FLAGS
550
- --customer-id=<value> (required) undefined
551
- --output=<option> output in a more machine friendly format
613
+ -o, --output=<option> output in a more machine friendly format
552
614
  <options: json|yaml>
615
+ --customer-id=<value> (required) undefined
553
616
 
554
617
  DESCRIPTION
555
618
  Get InvoiceSettings of a Customer.
@@ -611,14 +674,14 @@ Get Order for Customer.
611
674
 
612
675
  ```
613
676
  USAGE
614
- $ mw contract orderGetOrder ORDERID [--output json|yaml | | ]
677
+ $ mw contract orderGetOrder ORDERID [-o json|yaml | | ]
615
678
 
616
679
  ARGUMENTS
617
680
  ORDERID undefined
618
681
 
619
682
  FLAGS
620
- --output=<option> output in a more machine friendly format
621
- <options: json|yaml>
683
+ -o, --output=<option> output in a more machine friendly format
684
+ <options: json|yaml>
622
685
 
623
686
  DESCRIPTION
624
687
  Get Order for Customer.
@@ -803,16 +866,18 @@ DESCRIPTION
803
866
 
804
867
  ```
805
868
  USAGE
806
- $ mw conversation show2 CONVERSATIONID [--wait]
869
+ $ mw conversation show2 CONVERSATIONID -o txt|json [--wait]
807
870
 
808
871
  FLAGS
872
+ -o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
873
+ representation, and 'json' for a machine-readable JSON representation.
874
+ <options: txt|json>
809
875
  --wait
810
876
  ```
811
877
 
812
878
  ## `mw database mysql charsets`
813
879
 
814
- List available MySQL character sets and collations, optionally filtered by a
815
- MySQLVersion.
880
+ List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
816
881
 
817
882
  ```
818
883
  USAGE
@@ -834,20 +899,120 @@ DESCRIPTION
834
899
  List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
835
900
  ```
836
901
 
837
- ## `mw database mysql get ID`
902
+ ## `mw database mysql create`
903
+
904
+ Create a new MySQL database
905
+
906
+ ```
907
+ USAGE
908
+ $ mw database mysql create -d <value> --version <value> [-p <value>] [-q] [--collation <value>] [--character-set <value>]
909
+ [--user-password <value>] [--user-external] [--user-access-level full|readonly]
910
+
911
+ FLAGS
912
+ -d, --description=<value> (required) a description for the database
913
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
914
+ context
915
+ -q, --quiet suppress process output and only display a machine-readable summary.
916
+ --character-set=<value> [default: utf8mb4] the character set to use
917
+ --collation=<value> [default: utf8mb4_unicode_ci] the collation to use
918
+ --user-access-level=<option> [default: full] the access level preset for the default user
919
+ <options: full|readonly>
920
+ --user-external enable external access for default user
921
+ --user-password=<value> the password to use for the default user (env: MYSQL_PWD)
922
+ --version=<value> (required) the MySQL version to use
923
+
924
+ FLAG DESCRIPTIONS
925
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
926
+
927
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
928
+ to persistently set a default project for all commands that accept this flag.
929
+
930
+ -q, --quiet suppress process output and only display a machine-readable summary.
931
+
932
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
933
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
934
+
935
+ --version=<value> the MySQL version to use
936
+
937
+ Use the "database mysql versions" command to list available versions
938
+ ```
939
+
940
+ ## `mw database mysql delete DATABASE-ID`
941
+
942
+ Delete a MySQL database
943
+
944
+ ```
945
+ USAGE
946
+ $ mw database mysql delete DATABASE-ID [-q] [-f]
947
+
948
+ ARGUMENTS
949
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
950
+
951
+ FLAGS
952
+ -f, --force Do not ask for confirmation
953
+ -q, --quiet suppress process output and only display a machine-readable summary.
954
+
955
+ DESCRIPTION
956
+ Delete a MySQL database
957
+
958
+ FLAG DESCRIPTIONS
959
+ -q, --quiet suppress process output and only display a machine-readable summary.
960
+
961
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
962
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
963
+ ```
964
+
965
+ ## `mw database mysql dump DATABASE-ID`
966
+
967
+ Create a dump of a MySQL database
968
+
969
+ ```
970
+ USAGE
971
+ $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>]
972
+
973
+ ARGUMENTS
974
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
975
+
976
+ FLAGS
977
+ -o, --output=<value> (required) the output file to write the dump to ("-" for stdout)
978
+ -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
979
+ -q, --quiet suppress process output and only display a machine-readable summary.
980
+
981
+ FLAG DESCRIPTIONS
982
+ -o, --output=<value> the output file to write the dump to ("-" for stdout)
983
+
984
+ The output file to write the dump to. You can specify "-" or "/dev/stdout" to write the dump directly to STDOUT; in
985
+ this case, you might want to use the --quiet/-q flag to supress all other output, so that you can pipe the mysqldump
986
+ for further processing.
987
+
988
+ -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
989
+
990
+ The password to use for the MySQL user. If not provided, the environment variable MYSQL_PWD will be used. If that is
991
+ not set either, the command will interactively ask for the password.
992
+
993
+ NOTE: This is a security risk, as the password will be visible in the process list of your system, and will be
994
+ visible in your Shell history. It is recommended to use the environment variable instead.
995
+
996
+ -q, --quiet suppress process output and only display a machine-readable summary.
997
+
998
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
999
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1000
+ ```
1001
+
1002
+ ## `mw database mysql get DATABASE-ID`
838
1003
 
839
1004
  Get a MySQLDatabase.
840
1005
 
841
1006
  ```
842
1007
  USAGE
843
- $ mw database mysql get ID [--output json|yaml | | ]
1008
+ $ mw database mysql get DATABASE-ID [-o json|yaml | | ]
844
1009
 
845
1010
  ARGUMENTS
846
- ID ID of the MySQLDatabase to be retrieved.
1011
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
847
1012
 
848
1013
  FLAGS
849
- --output=<option> output in a more machine friendly format
850
- <options: json|yaml>
1014
+ -o, --output=<option> output in a more machine friendly format
1015
+ <options: json|yaml>
851
1016
 
852
1017
  DESCRIPTION
853
1018
  Get a MySQLDatabase.
@@ -859,64 +1024,118 @@ List MySQLDatabases belonging to a Project.
859
1024
 
860
1025
  ```
861
1026
  USAGE
862
- $ mw database mysql list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
863
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1027
+ $ mw database mysql list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1028
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
864
1029
 
865
1030
  FLAGS
866
- -x, --extended show extra columns
867
- --columns=<value> only show provided columns (comma-separated)
868
- --csv output is csv format [alias: --output=csv]
869
- --filter=<value> filter property by partial string matching, ex: name=foo
870
- --no-header hide table header from output
871
- --no-truncate do not truncate output to fit screen
872
- --output=<option> output in a more machine friendly format
873
- <options: csv|json|yaml>
874
- --project-id=<value> (required) ID of the Project to list MySQLDatabases for.
875
- --sort=<value> property to sort by (prepend '-' for descending)
1031
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1032
+ context
1033
+ -x, --extended show extra columns
1034
+ --columns=<value> only show provided columns (comma-separated)
1035
+ --csv output is csv format [alias: --output=csv]
1036
+ --filter=<value> filter property by partial string matching, ex: name=foo
1037
+ --no-header hide table header from output
1038
+ --no-truncate do not truncate output to fit screen
1039
+ --output=<option> output in a more machine friendly format
1040
+ <options: csv|json|yaml>
1041
+ --sort=<value> property to sort by (prepend '-' for descending)
876
1042
 
877
1043
  DESCRIPTION
878
1044
  List MySQLDatabases belonging to a Project.
1045
+
1046
+ FLAG DESCRIPTIONS
1047
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1048
+
1049
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1050
+ to persistently set a default project for all commands that accept this flag.
879
1051
  ```
880
1052
 
881
- ## `mw database mysql user get ID`
1053
+ ## `mw database mysql phpmyadmin DATABASE-ID`
1054
+
1055
+ Open phpMyAdmin for a MySQL database.
1056
+
1057
+ ```
1058
+ USAGE
1059
+ $ mw database mysql phpmyadmin DATABASE-ID
1060
+
1061
+ ARGUMENTS
1062
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
1063
+ ```
882
1064
 
883
- Get a MySQLUser.
1065
+ ## `mw database mysql port-forward DATABASE-ID`
1066
+
1067
+ Forward the TCP port of a MySQL database to a local port
884
1068
 
885
1069
  ```
886
1070
  USAGE
887
- $ mw database mysql user get ID [--output json|yaml | | ]
1071
+ $ mw database mysql port-forward DATABASE-ID [-q] [--port <value>]
888
1072
 
889
1073
  ARGUMENTS
890
- ID ID of the MySQLUser to be retrieved.
1074
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
891
1075
 
892
1076
  FLAGS
893
- --output=<option> output in a more machine friendly format
894
- <options: json|yaml>
1077
+ -q, --quiet suppress process output and only display a machine-readable summary.
1078
+ --port=<value> [default: 3306] The local TCP port to forward to
895
1079
 
896
- DESCRIPTION
897
- Get a MySQLUser.
1080
+ FLAG DESCRIPTIONS
1081
+ -q, --quiet suppress process output and only display a machine-readable summary.
1082
+
1083
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1084
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
898
1085
  ```
899
1086
 
900
- ## `mw database mysql user getMysqlUserPhpMyAdminUrl`
1087
+ ## `mw database mysql shell DATABASE-ID`
901
1088
 
902
- Get a MySQLUser's PhpMyAdmin-URL.
1089
+ Connect to a MySQL database via the MySQL shell
903
1090
 
904
1091
  ```
905
1092
  USAGE
906
- $ mw database mysql user getMysqlUserPhpMyAdminUrl --id <value> [--output json|yaml | | ]
1093
+ $ mw database mysql shell DATABASE-ID [-q] [-p <value>]
1094
+
1095
+ ARGUMENTS
1096
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
907
1097
 
908
1098
  FLAGS
909
- --id=<value> (required) ID of the MySQLUser for which to get the URL for.
910
- --output=<option> output in a more machine friendly format
911
- <options: json|yaml>
1099
+ -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
1100
+ -q, --quiet suppress process output and only display a machine-readable summary.
1101
+
1102
+ FLAG DESCRIPTIONS
1103
+ -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
1104
+
1105
+ The password to use for the MySQL user. If not provided, the environment variable MYSQL_PWD will be used. If that is
1106
+ not set either, the command will interactively ask for the password.
1107
+
1108
+ NOTE: This is a security risk, as the password will be visible in the process list of your system, and will be
1109
+ visible in your Shell history. It is recommended to use the environment variable instead.
1110
+
1111
+ -q, --quiet suppress process output and only display a machine-readable summary.
1112
+
1113
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1114
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1115
+ ```
1116
+
1117
+ ## `mw database mysql user get ID`
1118
+
1119
+ Get a MySQL user.
1120
+
1121
+ ```
1122
+ USAGE
1123
+ $ mw database mysql user get ID [-o json|yaml | | ]
1124
+
1125
+ ARGUMENTS
1126
+ ID ID of the MySQL user to be retrieved.
1127
+
1128
+ FLAGS
1129
+ -o, --output=<option> output in a more machine friendly format
1130
+ <options: json|yaml>
912
1131
 
913
1132
  DESCRIPTION
914
- Get a MySQLUser's PhpMyAdmin-URL.
1133
+ Get a MySQL user.
915
1134
  ```
916
1135
 
917
1136
  ## `mw database mysql user list`
918
1137
 
919
- List MySQLUsers belonging to a database.
1138
+ List MySQL users belonging to a database.
920
1139
 
921
1140
  ```
922
1141
  USAGE
@@ -927,7 +1146,7 @@ FLAGS
927
1146
  -x, --extended show extra columns
928
1147
  --columns=<value> only show provided columns (comma-separated)
929
1148
  --csv output is csv format [alias: --output=csv]
930
- --database-id=<value> (required) ID of the MySQLDatabase to list Users for.
1149
+ --database-id=<value> (required) ID of the MySQL database to list users for.
931
1150
  --filter=<value> filter property by partial string matching, ex: name=foo
932
1151
  --no-header hide table header from output
933
1152
  --no-truncate do not truncate output to fit screen
@@ -936,12 +1155,12 @@ FLAGS
936
1155
  --sort=<value> property to sort by (prepend '-' for descending)
937
1156
 
938
1157
  DESCRIPTION
939
- List MySQLUsers belonging to a database.
1158
+ List MySQL users belonging to a database.
940
1159
  ```
941
1160
 
942
1161
  ## `mw database mysql versions`
943
1162
 
944
- List available MySQLVersions.
1163
+ List available MySQL versions.
945
1164
 
946
1165
  ```
947
1166
  USAGE
@@ -960,51 +1179,79 @@ FLAGS
960
1179
  --sort=<value> property to sort by (prepend '-' for descending)
961
1180
 
962
1181
  DESCRIPTION
963
- List available MySQLVersions.
1182
+ List available MySQL versions.
964
1183
  ```
965
1184
 
966
1185
  ## `mw database redis get ID`
967
1186
 
968
- Get a RedisDatabase.
1187
+ Get a Redis database.
969
1188
 
970
1189
  ```
971
1190
  USAGE
972
- $ mw database redis get ID [--output json|yaml | | ]
1191
+ $ mw database redis get ID [-o json|yaml | | ]
973
1192
 
974
1193
  ARGUMENTS
975
- ID ID of the RedisDatabase to retrieve.
1194
+ ID ID of the Redis database to retrieve.
976
1195
 
977
1196
  FLAGS
978
- --output=<option> output in a more machine friendly format
979
- <options: json|yaml>
1197
+ -o, --output=<option> output in a more machine friendly format
1198
+ <options: json|yaml>
980
1199
 
981
1200
  DESCRIPTION
982
- Get a RedisDatabase.
1201
+ Get a Redis database.
983
1202
  ```
984
1203
 
985
1204
  ## `mw database redis list`
986
1205
 
987
- List RedisDatabases belonging to a project.
1206
+ List Redis databases belonging to a project.
988
1207
 
989
1208
  ```
990
1209
  USAGE
991
- $ mw database redis list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
992
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1210
+ $ mw database redis list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1211
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
993
1212
 
994
1213
  FLAGS
995
- -x, --extended show extra columns
996
- --columns=<value> only show provided columns (comma-separated)
997
- --csv output is csv format [alias: --output=csv]
998
- --filter=<value> filter property by partial string matching, ex: name=foo
999
- --no-header hide table header from output
1000
- --no-truncate do not truncate output to fit screen
1001
- --output=<option> output in a more machine friendly format
1002
- <options: csv|json|yaml>
1003
- --project-id=<value> (required) ID of the Project to list RedisDatabases for.
1004
- --sort=<value> property to sort by (prepend '-' for descending)
1214
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1215
+ context
1216
+ -x, --extended show extra columns
1217
+ --columns=<value> only show provided columns (comma-separated)
1218
+ --csv output is csv format [alias: --output=csv]
1219
+ --filter=<value> filter property by partial string matching, ex: name=foo
1220
+ --no-header hide table header from output
1221
+ --no-truncate do not truncate output to fit screen
1222
+ --output=<option> output in a more machine friendly format
1223
+ <options: csv|json|yaml>
1224
+ --sort=<value> property to sort by (prepend '-' for descending)
1005
1225
 
1006
1226
  DESCRIPTION
1007
- List RedisDatabases belonging to a project.
1227
+ List Redis databases belonging to a project.
1228
+
1229
+ FLAG DESCRIPTIONS
1230
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1231
+
1232
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1233
+ to persistently set a default project for all commands that accept this flag.
1234
+ ```
1235
+
1236
+ ## `mw database redis shell DATABASE-ID`
1237
+
1238
+ Connect to a Redis database via the redis-cli
1239
+
1240
+ ```
1241
+ USAGE
1242
+ $ mw database redis shell DATABASE-ID [-q]
1243
+
1244
+ ARGUMENTS
1245
+ DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
1246
+
1247
+ FLAGS
1248
+ -q, --quiet suppress process output and only display a machine-readable summary.
1249
+
1250
+ FLAG DESCRIPTIONS
1251
+ -q, --quiet suppress process output and only display a machine-readable summary.
1252
+
1253
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1254
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1008
1255
  ```
1009
1256
 
1010
1257
  ## `mw database redis versions`
@@ -1037,14 +1284,14 @@ gets a specific zone
1037
1284
 
1038
1285
  ```
1039
1286
  USAGE
1040
- $ mw domain dnszone get ZONEID [--output json|yaml | | ]
1287
+ $ mw domain dnszone get ZONEID [-o json|yaml | | ]
1041
1288
 
1042
1289
  ARGUMENTS
1043
1290
  ZONEID id of the zone you want to get
1044
1291
 
1045
1292
  FLAGS
1046
- --output=<option> output in a more machine friendly format
1047
- <options: json|yaml>
1293
+ -o, --output=<option> output in a more machine friendly format
1294
+ <options: json|yaml>
1048
1295
 
1049
1296
  DESCRIPTION
1050
1297
  gets a specific zone
@@ -1056,12 +1303,12 @@ gets all dns zones by project id
1056
1303
 
1057
1304
  ```
1058
1305
  USAGE
1059
- $ mw domain dnszone list --project-id <value> [--output json|yaml | | ]
1306
+ $ mw domain dnszone list --project-id <value> [-o json|yaml | | ]
1060
1307
 
1061
1308
  FLAGS
1062
- --output=<option> output in a more machine friendly format
1063
- <options: json|yaml>
1064
- --project-id=<value> (required) project you want to get the zones for
1309
+ -o, --output=<option> output in a more machine friendly format
1310
+ <options: json|yaml>
1311
+ --project-id=<value> (required) project you want to get the zones for
1065
1312
 
1066
1313
  DESCRIPTION
1067
1314
  gets all dns zones by project id
@@ -1073,14 +1320,14 @@ Get a Domain.
1073
1320
 
1074
1321
  ```
1075
1322
  USAGE
1076
- $ mw domain get DOMAINID [--output json|yaml | | ]
1323
+ $ mw domain get DOMAINID [-o json|yaml | | ]
1077
1324
 
1078
1325
  ARGUMENTS
1079
1326
  DOMAINID undefined
1080
1327
 
1081
1328
  FLAGS
1082
- --output=<option> output in a more machine friendly format
1083
- <options: json|yaml>
1329
+ -o, --output=<option> output in a more machine friendly format
1330
+ <options: json|yaml>
1084
1331
 
1085
1332
  DESCRIPTION
1086
1333
  Get a Domain.
@@ -1092,14 +1339,14 @@ Get a HandleSchema.
1092
1339
 
1093
1340
  ```
1094
1341
  USAGE
1095
- $ mw domain get-handle DOMAINNAME [--output json|yaml | | ]
1342
+ $ mw domain get-handle DOMAINNAME [-o json|yaml | | ]
1096
1343
 
1097
1344
  ARGUMENTS
1098
1345
  DOMAINNAME The whole domain name
1099
1346
 
1100
1347
  FLAGS
1101
- --output=<option> output in a more machine friendly format
1102
- <options: json|yaml>
1348
+ -o, --output=<option> output in a more machine friendly format
1349
+ <options: json|yaml>
1103
1350
 
1104
1351
  DESCRIPTION
1105
1352
  Get a HandleSchema.
@@ -1111,23 +1358,30 @@ List Domains belonging to a Project.
1111
1358
 
1112
1359
  ```
1113
1360
  USAGE
1114
- $ mw domain list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1115
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1361
+ $ mw domain list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1362
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1116
1363
 
1117
1364
  FLAGS
1118
- -x, --extended show extra columns
1119
- --columns=<value> only show provided columns (comma-separated)
1120
- --csv output is csv format [alias: --output=csv]
1121
- --filter=<value> filter property by partial string matching, ex: name=foo
1122
- --no-header hide table header from output
1123
- --no-truncate do not truncate output to fit screen
1124
- --output=<option> output in a more machine friendly format
1125
- <options: csv|json|yaml>
1126
- --project-id=<value> (required) undefined
1127
- --sort=<value> property to sort by (prepend '-' for descending)
1365
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1366
+ context
1367
+ -x, --extended show extra columns
1368
+ --columns=<value> only show provided columns (comma-separated)
1369
+ --csv output is csv format [alias: --output=csv]
1370
+ --filter=<value> filter property by partial string matching, ex: name=foo
1371
+ --no-header hide table header from output
1372
+ --no-truncate do not truncate output to fit screen
1373
+ --output=<option> output in a more machine friendly format
1374
+ <options: csv|json|yaml>
1375
+ --sort=<value> property to sort by (prepend '-' for descending)
1128
1376
 
1129
1377
  DESCRIPTION
1130
1378
  List Domains belonging to a Project.
1379
+
1380
+ FLAG DESCRIPTIONS
1381
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1382
+
1383
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1384
+ to persistently set a default project for all commands that accept this flag.
1131
1385
  ```
1132
1386
 
1133
1387
  ## `mw domain ownership get DOMAINOWNERSHIPID`
@@ -1136,14 +1390,14 @@ Get a domain ownership.
1136
1390
 
1137
1391
  ```
1138
1392
  USAGE
1139
- $ mw domain ownership get DOMAINOWNERSHIPID [--output json|yaml | | ]
1393
+ $ mw domain ownership get DOMAINOWNERSHIPID [-o json|yaml | | ]
1140
1394
 
1141
1395
  ARGUMENTS
1142
1396
  DOMAINOWNERSHIPID undefined
1143
1397
 
1144
1398
  FLAGS
1145
- --output=<option> output in a more machine friendly format
1146
- <options: json|yaml>
1399
+ -o, --output=<option> output in a more machine friendly format
1400
+ <options: json|yaml>
1147
1401
 
1148
1402
  DESCRIPTION
1149
1403
  Get a domain ownership.
@@ -1155,23 +1409,30 @@ List all domain ownerships of a project.
1155
1409
 
1156
1410
  ```
1157
1411
  USAGE
1158
- $ mw domain ownership list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1159
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1412
+ $ mw domain ownership list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1413
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1160
1414
 
1161
1415
  FLAGS
1162
- -x, --extended show extra columns
1163
- --columns=<value> only show provided columns (comma-separated)
1164
- --csv output is csv format [alias: --output=csv]
1165
- --filter=<value> filter property by partial string matching, ex: name=foo
1166
- --no-header hide table header from output
1167
- --no-truncate do not truncate output to fit screen
1168
- --output=<option> output in a more machine friendly format
1169
- <options: csv|json|yaml>
1170
- --project-id=<value> (required) undefined
1171
- --sort=<value> property to sort by (prepend '-' for descending)
1416
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1417
+ context
1418
+ -x, --extended show extra columns
1419
+ --columns=<value> only show provided columns (comma-separated)
1420
+ --csv output is csv format [alias: --output=csv]
1421
+ --filter=<value> filter property by partial string matching, ex: name=foo
1422
+ --no-header hide table header from output
1423
+ --no-truncate do not truncate output to fit screen
1424
+ --output=<option> output in a more machine friendly format
1425
+ <options: csv|json|yaml>
1426
+ --sort=<value> property to sort by (prepend '-' for descending)
1172
1427
 
1173
1428
  DESCRIPTION
1174
1429
  List all domain ownerships of a project.
1430
+
1431
+ FLAG DESCRIPTIONS
1432
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1433
+
1434
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1435
+ to persistently set a default project for all commands that accept this flag.
1175
1436
  ```
1176
1437
 
1177
1438
  ## `mw domain tld get TLD`
@@ -1180,14 +1441,14 @@ Get a toplevel domain.
1180
1441
 
1181
1442
  ```
1182
1443
  USAGE
1183
- $ mw domain tld get TLD [--output json|yaml | | ]
1444
+ $ mw domain tld get TLD [-o json|yaml | | ]
1184
1445
 
1185
1446
  ARGUMENTS
1186
1447
  TLD undefined
1187
1448
 
1188
1449
  FLAGS
1189
- --output=<option> output in a more machine friendly format
1190
- <options: json|yaml>
1450
+ -o, --output=<option> output in a more machine friendly format
1451
+ <options: json|yaml>
1191
1452
 
1192
1453
  DESCRIPTION
1193
1454
  Get a toplevel domain.
@@ -1217,71 +1478,176 @@ DESCRIPTION
1217
1478
  List all supported toplevel domains.
1218
1479
  ```
1219
1480
 
1220
- ## `mw domain virtualhost get INGRESSID`
1481
+ ## `mw domain virtualhost create`
1221
1482
 
1222
- Get an Ingress.
1483
+ Create a new ingress
1223
1484
 
1224
1485
  ```
1225
1486
  USAGE
1226
- $ mw domain virtualhost get INGRESSID [--output json|yaml | | ]
1227
-
1228
- ARGUMENTS
1229
- INGRESSID ID of the Ingress to be retrieved.
1487
+ $ mw domain virtualhost create --hostname <value> [-q] [-p <value>] [--path-to-dir <value>] [--path-to-app <value>]
1488
+ [--path-to-url <value>]
1230
1489
 
1231
1490
  FLAGS
1232
- --output=<option> output in a more machine friendly format
1233
- <options: json|yaml>
1491
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1492
+ context
1493
+ -q, --quiet suppress process output and only display a machine-readable summary.
1494
+ --hostname=<value> (required) the hostname of the ingress
1495
+ --path-to-app=<value>... add a path mapping to an app
1496
+ --path-to-dir=<value>... add a path mapping to a directory
1497
+ --path-to-url=<value>... add a path mapping to an external url
1234
1498
 
1235
1499
  DESCRIPTION
1236
- Get an Ingress.
1237
- ```
1500
+ Create a new ingress
1238
1501
 
1239
- ## `mw domain virtualhost list`
1502
+ EXAMPLES
1503
+ Create a new ingress, with the root path mapping to your project's root directory
1240
1504
 
1241
- List Ingresses the user has access to.
1505
+ $ mw domain virtualhost create --hostname mw.example --path-to-dir /:/
1242
1506
 
1243
- ```
1244
- USAGE
1245
- $ mw domain virtualhost list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1246
- [--csv | --no-truncate]] [--no-header | ] [--project-id <value>]
1507
+ Create a new ingress, with the root path mapping to an app
1247
1508
 
1248
- FLAGS
1249
- -x, --extended show extra columns
1250
- --columns=<value> only show provided columns (comma-separated)
1251
- --csv output is csv format [alias: --output=csv]
1252
- --filter=<value> filter property by partial string matching, ex: name=foo
1253
- --no-header hide table header from output
1254
- --no-truncate do not truncate output to fit screen
1255
- --output=<option> output in a more machine friendly format
1256
- <options: csv|json|yaml>
1257
- --project-id=<value> Project ID to filter by; if omitted this will list virtual hosts in all projects you have access
1258
- to.
1259
- --sort=<value> property to sort by (prepend '-' for descending)
1509
+ $ mw domain virtualhost create --hostname mw.example --path-to-app /:3ecaf1a9-6eb4-4869-b811-8a13c3a2e745
1260
1510
 
1261
- DESCRIPTION
1262
- List Ingresses the user has access to.
1263
- ```
1511
+ Create a new ingress, with the root path mapping to a URL
1264
1512
 
1265
- ## `mw help [COMMANDS]`
1513
+ $ mw domain virtualhost create --hostname mw.example --path-to-url /:https://redirect.example
1266
1514
 
1267
- Display help for mw.
1515
+ FLAG DESCRIPTIONS
1516
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1268
1517
 
1269
- ```
1270
- USAGE
1271
- $ mw help [COMMANDS] [-n]
1518
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1519
+ to persistently set a default project for all commands that accept this flag.
1272
1520
 
1273
- ARGUMENTS
1274
- COMMANDS Command to show help for.
1521
+ -q, --quiet suppress process output and only display a machine-readable summary.
1275
1522
 
1276
- FLAGS
1277
- -n, --nested-commands Include all nested commands in the output.
1523
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1524
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1278
1525
 
1279
- DESCRIPTION
1526
+ --path-to-app=<value>... add a path mapping to an app
1527
+
1528
+ This flag can be used to map a specific URL path to an app; the value for this flag should be the URL path and the
1529
+ app ID, separated by a colon, e.g. /:3ecaf1a9-6eb4-4869-b811-8a13c3a2e745. You can specify this flag multiple times
1530
+ to map multiple paths to different apps, and also combine it with the other --path-to-* flags.
1531
+
1532
+ --path-to-dir=<value>... add a path mapping to a directory
1533
+
1534
+ This flag can be used to map a specific URL path to a directory in your project's file system; the value for this
1535
+ flag should be the URL path and the filesystem path, separated by a colon, e.g. /:/ or /:/some/sub/path. You can
1536
+ specify this flag multiple times to map multiple paths to different directories, and also combine it with the other
1537
+ --path-to-* flags.
1538
+
1539
+ --path-to-url=<value>... add a path mapping to an external url
1540
+
1541
+ This flag can be used to map a specific URL path to an external URL; the value for this flag should be the URL path
1542
+ and the external URL, separated by a colon, e.g. /:https://redirect.example. You can specify this flag multiple
1543
+ times to map multiple paths to different external URLs, and also combine it with the other --path-to-* flags.
1544
+ ```
1545
+
1546
+ ## `mw domain virtualhost delete VIRTUAL-HOST-ID`
1547
+
1548
+ Delete a virtual host
1549
+
1550
+ ```
1551
+ USAGE
1552
+ $ mw domain virtualhost delete VIRTUAL-HOST-ID [-q] [-f]
1553
+
1554
+ ARGUMENTS
1555
+ VIRTUAL-HOST-ID ID of the virtual host to delete
1556
+
1557
+ FLAGS
1558
+ -f, --force Do not ask for confirmation
1559
+ -q, --quiet suppress process output and only display a machine-readable summary.
1560
+
1561
+ DESCRIPTION
1562
+ Delete a virtual host
1563
+
1564
+ FLAG DESCRIPTIONS
1565
+ -q, --quiet suppress process output and only display a machine-readable summary.
1566
+
1567
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1568
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1569
+ ```
1570
+
1571
+ ## `mw domain virtualhost get INGRESS-ID`
1572
+
1573
+ Get a virtual host.
1574
+
1575
+ ```
1576
+ USAGE
1577
+ $ mw domain virtualhost get INGRESS-ID [-o json|yaml | | ]
1578
+
1579
+ FLAGS
1580
+ -o, --output=<option> output in a more machine friendly format
1581
+ <options: json|yaml>
1582
+
1583
+ DESCRIPTION
1584
+ Get a virtual host.
1585
+ ```
1586
+
1587
+ ## `mw domain virtualhost list`
1588
+
1589
+ List virtualhosts for a project.
1590
+
1591
+ ```
1592
+ USAGE
1593
+ $ mw domain virtualhost list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1594
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>] [-a]
1595
+
1596
+ FLAGS
1597
+ -a, --all List all virtual hosts that you have access to, regardless of project
1598
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1599
+ context
1600
+ -x, --extended show extra columns
1601
+ --columns=<value> only show provided columns (comma-separated)
1602
+ --csv output is csv format [alias: --output=csv]
1603
+ --filter=<value> filter property by partial string matching, ex: name=foo
1604
+ --no-header hide table header from output
1605
+ --no-truncate do not truncate output to fit screen
1606
+ --output=<option> output in a more machine friendly format
1607
+ <options: csv|json|yaml>
1608
+ --sort=<value> property to sort by (prepend '-' for descending)
1609
+
1610
+ DESCRIPTION
1611
+ List virtualhosts for a project.
1612
+
1613
+ FLAG DESCRIPTIONS
1614
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1615
+
1616
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1617
+ to persistently set a default project for all commands that accept this flag.
1618
+ ```
1619
+
1620
+ ## `mw help [COMMANDS]`
1621
+
1622
+ Display help for mw.
1623
+
1624
+ ```
1625
+ USAGE
1626
+ $ mw help [COMMANDS] [-n]
1627
+
1628
+ ARGUMENTS
1629
+ COMMANDS Command to show help for.
1630
+
1631
+ FLAGS
1632
+ -n, --nested-commands Include all nested commands in the output.
1633
+
1634
+ DESCRIPTION
1280
1635
  Display help for mw.
1281
1636
  ```
1282
1637
 
1283
- _See code:
1284
- [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.11/src/commands/help.ts)_
1638
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.11/src/commands/help.ts)_
1639
+
1640
+ ## `mw login reset`
1641
+
1642
+ Reset your local authentication state
1643
+
1644
+ ```
1645
+ USAGE
1646
+ $ mw login reset
1647
+
1648
+ DESCRIPTION
1649
+ Reset your local authentication state
1650
+ ```
1285
1651
 
1286
1652
  ## `mw login status`
1287
1653
 
@@ -1316,17 +1682,59 @@ Create a new mail address
1316
1682
 
1317
1683
  ```
1318
1684
  USAGE
1319
- $ mw mail address create -p <value> -a <value> [--catch-all] [--enable-spam-protection] [--quota <value>]
1685
+ $ mw mail address create -a <value> [-p <value>] [-q] [--catch-all] [--enable-spam-protection] [--quota <value>]
1686
+ [--password <value>] [--random-password]
1320
1687
 
1321
1688
  FLAGS
1322
- -a, --address=<value> (required) Mail address
1323
- -p, --projectId=<value> (required) Project ID or short ID
1324
- --catch-all Make this a catch-all mail address
1325
- --[no-]enable-spam-protection Enable spam protection for this mailbox
1326
- --quota=<value> [default: 1024] Mailbox quota in mebibytes
1689
+ -a, --address=<value> (required) mail address
1690
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1691
+ context
1692
+ -q, --quiet suppress process output and only display a machine-readable summary.
1693
+ --catch-all make this a catch-all mail address
1694
+ --[no-]enable-spam-protection enable spam protection for this mailbox
1695
+ --password=<value> mailbox password
1696
+ --quota=<value> [default: 1024] mailbox quota in mebibytes
1697
+ --random-password generate a random password
1327
1698
 
1328
1699
  DESCRIPTION
1329
1700
  Create a new mail address
1701
+
1702
+ When running this command with the --quiet flag, the output will contain the ID of the newly created address.
1703
+ In addition, when run with --generated-password the output will be the ID of the newly created address, followed by a
1704
+ tab character and the generated password.
1705
+
1706
+ EXAMPLES
1707
+ Create non-interactively with password
1708
+
1709
+ $ read -s PASSWORD && \
1710
+ mw mail address create --password $PASSWORD --address foo@bar.example
1711
+
1712
+ Create non-interactively with random password
1713
+
1714
+ $ mw mail address create --random-password --address foo@bar.example
1715
+
1716
+ FLAG DESCRIPTIONS
1717
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1718
+
1719
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1720
+ to persistently set a default project for all commands that accept this flag.
1721
+
1722
+ -q, --quiet suppress process output and only display a machine-readable summary.
1723
+
1724
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1725
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1726
+
1727
+ --password=<value> mailbox password
1728
+
1729
+ This is the password that should be used for the mailbox; if omitted, the command will prompt interactively for a
1730
+ password.
1731
+
1732
+ CAUTION: providing this flag may log your password in your shell history!
1733
+
1734
+ --random-password generate a random password
1735
+
1736
+ This flag will cause the command to generate a random 32-character password for the mailbox; when running with
1737
+ --quiet, the address ID and the password will be printed to stdout, separated by a tab character.
1330
1738
  ```
1331
1739
 
1332
1740
  ## `mw mail address delete ID`
@@ -1335,16 +1743,23 @@ Delete a mail address
1335
1743
 
1336
1744
  ```
1337
1745
  USAGE
1338
- $ mw mail address delete ID [--force]
1746
+ $ mw mail address delete ID [-q] [-f]
1339
1747
 
1340
1748
  ARGUMENTS
1341
1749
  ID Mail address ID
1342
1750
 
1343
1751
  FLAGS
1344
- --force Do not ask for confirmation
1752
+ -f, --force Do not ask for confirmation
1753
+ -q, --quiet suppress process output and only display a machine-readable summary.
1345
1754
 
1346
1755
  DESCRIPTION
1347
1756
  Delete a mail address
1757
+
1758
+ FLAG DESCRIPTIONS
1759
+ -q, --quiet suppress process output and only display a machine-readable summary.
1760
+
1761
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1762
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1348
1763
  ```
1349
1764
 
1350
1765
  ## `mw mail address get ID`
@@ -1353,14 +1768,14 @@ Get a specific mail address
1353
1768
 
1354
1769
  ```
1355
1770
  USAGE
1356
- $ mw mail address get ID [--output json|yaml | | ]
1771
+ $ mw mail address get ID [-o json|yaml | | ]
1357
1772
 
1358
1773
  ARGUMENTS
1359
1774
  ID id of the address you want to get
1360
1775
 
1361
1776
  FLAGS
1362
- --output=<option> output in a more machine friendly format
1363
- <options: json|yaml>
1777
+ -o, --output=<option> output in a more machine friendly format
1778
+ <options: json|yaml>
1364
1779
 
1365
1780
  DESCRIPTION
1366
1781
  Get a specific mail address
@@ -1372,23 +1787,30 @@ Get all mail addresses for a project ID
1372
1787
 
1373
1788
  ```
1374
1789
  USAGE
1375
- $ mw mail address list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1376
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1790
+ $ mw mail address list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1791
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1377
1792
 
1378
1793
  FLAGS
1379
- -x, --extended show extra columns
1380
- --columns=<value> only show provided columns (comma-separated)
1381
- --csv output is csv format [alias: --output=csv]
1382
- --filter=<value> filter property by partial string matching, ex: name=foo
1383
- --no-header hide table header from output
1384
- --no-truncate do not truncate output to fit screen
1385
- --output=<option> output in a more machine friendly format
1386
- <options: csv|json|yaml>
1387
- --project-id=<value> (required) Project ID the mailAddresses are related to
1388
- --sort=<value> property to sort by (prepend '-' for descending)
1794
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
1795
+ context
1796
+ -x, --extended show extra columns
1797
+ --columns=<value> only show provided columns (comma-separated)
1798
+ --csv output is csv format [alias: --output=csv]
1799
+ --filter=<value> filter property by partial string matching, ex: name=foo
1800
+ --no-header hide table header from output
1801
+ --no-truncate do not truncate output to fit screen
1802
+ --output=<option> output in a more machine friendly format
1803
+ <options: csv|json|yaml>
1804
+ --sort=<value> property to sort by (prepend '-' for descending)
1389
1805
 
1390
1806
  DESCRIPTION
1391
1807
  Get all mail addresses for a project ID
1808
+
1809
+ FLAG DESCRIPTIONS
1810
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1811
+
1812
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
1813
+ to persistently set a default project for all commands that accept this flag.
1392
1814
  ```
1393
1815
 
1394
1816
  ## `mw mail deliverybox get ID`
@@ -1397,14 +1819,14 @@ Get a specific deliverybox
1397
1819
 
1398
1820
  ```
1399
1821
  USAGE
1400
- $ mw mail deliverybox get ID [--output json|yaml | | ]
1822
+ $ mw mail deliverybox get ID [-o json|yaml | | ]
1401
1823
 
1402
1824
  ARGUMENTS
1403
1825
  ID ID of the deliverybox you want to retrieve
1404
1826
 
1405
1827
  FLAGS
1406
- --output=<option> output in a more machine friendly format
1407
- <options: json|yaml>
1828
+ -o, --output=<option> output in a more machine friendly format
1829
+ <options: json|yaml>
1408
1830
 
1409
1831
  DESCRIPTION
1410
1832
  Get a specific deliverybox
@@ -1435,89 +1857,117 @@ DESCRIPTION
1435
1857
  Get all deliveryboxes by project ID
1436
1858
  ```
1437
1859
 
1438
- ## `mw org can-order`
1860
+ ## `mw org delete [ORG-ID]`
1439
1861
 
1440
- Check if the customer profile has a valid contract partner configured.
1862
+ Delete an organization
1441
1863
 
1442
1864
  ```
1443
1865
  USAGE
1444
- $ mw org can-order --customer-id <value> [--output json|yaml | | ]
1866
+ $ mw org delete [ORG-ID] [-q] [-f]
1867
+
1868
+ ARGUMENTS
1869
+ ORG-ID ID or short ID of a org; this argument is optional if a default org is set in the context
1445
1870
 
1446
1871
  FLAGS
1447
- --customer-id=<value> (required) undefined
1448
- --output=<option> output in a more machine friendly format
1449
- <options: json|yaml>
1872
+ -f, --force Do not ask for confirmation
1873
+ -q, --quiet suppress process output and only display a machine-readable summary.
1450
1874
 
1451
1875
  DESCRIPTION
1452
- Check if the customer profile has a valid contract partner configured.
1876
+ Delete an organization
1877
+
1878
+ FLAG DESCRIPTIONS
1879
+ -q, --quiet suppress process output and only display a machine-readable summary.
1880
+
1881
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1882
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1453
1883
  ```
1454
1884
 
1455
- ## `mw org get CUSTOMERID`
1885
+ ## `mw org get [ORG-ID]`
1456
1886
 
1457
- Get a customer profile.
1887
+ Get an organization profile.
1458
1888
 
1459
1889
  ```
1460
1890
  USAGE
1461
- $ mw org get CUSTOMERID [--output json|yaml | | ]
1891
+ $ mw org get [ORG-ID] [-o json|yaml | | ]
1462
1892
 
1463
1893
  ARGUMENTS
1464
- CUSTOMERID undefined
1894
+ ORG-ID ID or short ID of a org; this argument is optional if a default org is set in the context
1465
1895
 
1466
1896
  FLAGS
1467
- --output=<option> output in a more machine friendly format
1468
- <options: json|yaml>
1897
+ -o, --output=<option> output in a more machine friendly format
1898
+ <options: json|yaml>
1469
1899
 
1470
1900
  DESCRIPTION
1471
- Get a customer profile.
1901
+ Get an organization profile.
1472
1902
  ```
1473
1903
 
1474
- ## `mw org invite get INVITEID`
1904
+ ## `mw org invite`
1475
1905
 
1476
- Get a CustomerInvite.
1906
+ Invite a user to an organization.
1477
1907
 
1478
1908
  ```
1479
1909
  USAGE
1480
- $ mw org invite get INVITEID [--output json|yaml | | ]
1481
-
1482
- ARGUMENTS
1483
- INVITEID ID of the CustomerInvite to be retrieved.
1910
+ $ mw org invite --email <value> [-o <value>] [-q] [--role owner|member|accountant] [--message <value>]
1911
+ [--expires <value>]
1484
1912
 
1485
1913
  FLAGS
1486
- --output=<option> output in a more machine friendly format
1487
- <options: json|yaml>
1914
+ -o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
1915
+ -q, --quiet suppress process output and only display a machine-readable summary.
1916
+ --email=<value> (required) The email address of the user to invite.
1917
+ --expires=<value> An interval after which the invitation expires (examples: 30m, 30d, 1y).
1918
+ --message=<value> A message to include in the invitation email.
1919
+ --role=<option> [default: member] The role of the user to invite.
1920
+ <options: owner|member|accountant>
1488
1921
 
1489
1922
  DESCRIPTION
1490
- Get a CustomerInvite.
1923
+ Invite a user to an organization.
1924
+
1925
+ FLAG DESCRIPTIONS
1926
+ -o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
1927
+
1928
+ May contain a short ID or a full ID of a org; you can also use the "mw context set --org-id=<VALUE>" command to
1929
+ persistently set a default org for all commands that accept this flag.
1930
+
1931
+ -q, --quiet suppress process output and only display a machine-readable summary.
1932
+
1933
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1934
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1491
1935
  ```
1492
1936
 
1493
1937
  ## `mw org invite list`
1494
1938
 
1495
- List all invites for a Customer.
1939
+ List all invites for an organization.
1496
1940
 
1497
1941
  ```
1498
1942
  USAGE
1499
- $ mw org invite list --customer-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1500
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1943
+ $ mw org invite list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
1944
+ [--csv | --no-truncate]] [--no-header | ] [-o <value>]
1501
1945
 
1502
1946
  FLAGS
1503
- -x, --extended show extra columns
1504
- --columns=<value> only show provided columns (comma-separated)
1505
- --csv output is csv format [alias: --output=csv]
1506
- --customer-id=<value> (required) ID of the Customer to list invites for.
1507
- --filter=<value> filter property by partial string matching, ex: name=foo
1508
- --no-header hide table header from output
1509
- --no-truncate do not truncate output to fit screen
1510
- --output=<option> output in a more machine friendly format
1511
- <options: csv|json|yaml>
1512
- --sort=<value> property to sort by (prepend '-' for descending)
1947
+ -o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
1948
+ -x, --extended show extra columns
1949
+ --columns=<value> only show provided columns (comma-separated)
1950
+ --csv output is csv format [alias: --output=csv]
1951
+ --filter=<value> filter property by partial string matching, ex: name=foo
1952
+ --no-header hide table header from output
1953
+ --no-truncate do not truncate output to fit screen
1954
+ --output=<option> output in a more machine friendly format
1955
+ <options: csv|json|yaml>
1956
+ --sort=<value> property to sort by (prepend '-' for descending)
1513
1957
 
1514
1958
  DESCRIPTION
1515
- List all invites for a Customer.
1959
+ List all invites for an organization.
1960
+
1961
+ FLAG DESCRIPTIONS
1962
+ -o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
1963
+
1964
+ May contain a short ID or a full ID of a org; you can also use the "mw context set --org-id=<VALUE>" command to
1965
+ persistently set a default org for all commands that accept this flag.
1516
1966
  ```
1517
1967
 
1518
1968
  ## `mw org invite list-own`
1519
1969
 
1520
- List all CustomerInvites for the executing user.
1970
+ List all organization invites for the executing user.
1521
1971
 
1522
1972
  ```
1523
1973
  USAGE
@@ -1536,12 +1986,36 @@ FLAGS
1536
1986
  --sort=<value> property to sort by (prepend '-' for descending)
1537
1987
 
1538
1988
  DESCRIPTION
1539
- List all CustomerInvites for the executing user.
1989
+ List all organization invites for the executing user.
1990
+ ```
1991
+
1992
+ ## `mw org invite revoke INVITE-ID`
1993
+
1994
+ Revoke an invite to an organization
1995
+
1996
+ ```
1997
+ USAGE
1998
+ $ mw org invite revoke INVITE-ID [-q]
1999
+
2000
+ ARGUMENTS
2001
+ INVITE-ID The ID of the invite to revoke
2002
+
2003
+ FLAGS
2004
+ -q, --quiet suppress process output and only display a machine-readable summary.
2005
+
2006
+ DESCRIPTION
2007
+ Revoke an invite to an organization
2008
+
2009
+ FLAG DESCRIPTIONS
2010
+ -q, --quiet suppress process output and only display a machine-readable summary.
2011
+
2012
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2013
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1540
2014
  ```
1541
2015
 
1542
2016
  ## `mw org list`
1543
2017
 
1544
- Get all customer profiles the authenticated user has access to.
2018
+ Get all organizations the authenticated user has access to.
1545
2019
 
1546
2020
  ```
1547
2021
  USAGE
@@ -1560,56 +2034,43 @@ FLAGS
1560
2034
  --sort=<value> property to sort by (prepend '-' for descending)
1561
2035
 
1562
2036
  DESCRIPTION
1563
- Get all customer profiles the authenticated user has access to.
2037
+ Get all organizations the authenticated user has access to.
1564
2038
  ```
1565
2039
 
1566
- ## `mw org membership get MEMBERSHIPID`
2040
+ ## `mw org membership list`
1567
2041
 
1568
- Get a CustomerMembership.
2042
+ List all memberships belonging to an organization.
1569
2043
 
1570
2044
  ```
1571
2045
  USAGE
1572
- $ mw org membership get MEMBERSHIPID [--output json|yaml | | ]
1573
-
1574
- ARGUMENTS
1575
- MEMBERSHIPID ID of the CustomerMembership to retrieve.
2046
+ $ mw org membership list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
2047
+ [--csv | --no-truncate]] [--no-header | ] [-o <value>]
1576
2048
 
1577
2049
  FLAGS
1578
- --output=<option> output in a more machine friendly format
1579
- <options: json|yaml>
2050
+ -o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
2051
+ -x, --extended show extra columns
2052
+ --columns=<value> only show provided columns (comma-separated)
2053
+ --csv output is csv format [alias: --output=csv]
2054
+ --filter=<value> filter property by partial string matching, ex: name=foo
2055
+ --no-header hide table header from output
2056
+ --no-truncate do not truncate output to fit screen
2057
+ --output=<option> output in a more machine friendly format
2058
+ <options: csv|json|yaml>
2059
+ --sort=<value> property to sort by (prepend '-' for descending)
1580
2060
 
1581
2061
  DESCRIPTION
1582
- Get a CustomerMembership.
1583
- ```
2062
+ List all memberships belonging to an organization.
1584
2063
 
1585
- ## `mw org membership list`
1586
-
1587
- List all memberships belonging to a Customer.
2064
+ FLAG DESCRIPTIONS
2065
+ -o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
1588
2066
 
1589
- ```
1590
- USAGE
1591
- $ mw org membership list --customer-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1592
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1593
-
1594
- FLAGS
1595
- -x, --extended show extra columns
1596
- --columns=<value> only show provided columns (comma-separated)
1597
- --csv output is csv format [alias: --output=csv]
1598
- --customer-id=<value> (required) Customer to list memberships for.
1599
- --filter=<value> filter property by partial string matching, ex: name=foo
1600
- --no-header hide table header from output
1601
- --no-truncate do not truncate output to fit screen
1602
- --output=<option> output in a more machine friendly format
1603
- <options: csv|json|yaml>
1604
- --sort=<value> property to sort by (prepend '-' for descending)
1605
-
1606
- DESCRIPTION
1607
- List all memberships belonging to a Customer.
2067
+ May contain a short ID or a full ID of a org; you can also use the "mw context set --org-id=<VALUE>" command to
2068
+ persistently set a default org for all commands that accept this flag.
1608
2069
  ```
1609
2070
 
1610
2071
  ## `mw org membership list-own`
1611
2072
 
1612
- List all CustomerMemberships for the executing user.
2073
+ List all organization memberships for the executing user.
1613
2074
 
1614
2075
  ```
1615
2076
  USAGE
@@ -1628,7 +2089,31 @@ FLAGS
1628
2089
  --sort=<value> property to sort by (prepend '-' for descending)
1629
2090
 
1630
2091
  DESCRIPTION
1631
- List all CustomerMemberships for the executing user.
2092
+ List all organization memberships for the executing user.
2093
+ ```
2094
+
2095
+ ## `mw org membership revoke MEMBERSHIP-ID`
2096
+
2097
+ Revoke a user's membership to an organization
2098
+
2099
+ ```
2100
+ USAGE
2101
+ $ mw org membership revoke MEMBERSHIP-ID [-q]
2102
+
2103
+ ARGUMENTS
2104
+ MEMBERSHIP-ID The ID of the membership to revoke
2105
+
2106
+ FLAGS
2107
+ -q, --quiet suppress process output and only display a machine-readable summary.
2108
+
2109
+ DESCRIPTION
2110
+ Revoke a user's membership to an organization
2111
+
2112
+ FLAG DESCRIPTIONS
2113
+ -q, --quiet suppress process output and only display a machine-readable summary.
2114
+
2115
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2116
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1632
2117
  ```
1633
2118
 
1634
2119
  ## `mw project backup get PROJECTBACKUPID`
@@ -1637,14 +2122,14 @@ Get a ProjectBackup.
1637
2122
 
1638
2123
  ```
1639
2124
  USAGE
1640
- $ mw project backup get PROJECTBACKUPID [--output json|yaml | | ]
2125
+ $ mw project backup get PROJECTBACKUPID [-o json|yaml | | ]
1641
2126
 
1642
2127
  ARGUMENTS
1643
2128
  PROJECTBACKUPID ID of the ProjectBackup to retrieve.
1644
2129
 
1645
2130
  FLAGS
1646
- --output=<option> output in a more machine friendly format
1647
- <options: json|yaml>
2131
+ -o, --output=<option> output in a more machine friendly format
2132
+ <options: json|yaml>
1648
2133
 
1649
2134
  DESCRIPTION
1650
2135
  Get a ProjectBackup.
@@ -1656,23 +2141,30 @@ List Backups for a given Project.
1656
2141
 
1657
2142
  ```
1658
2143
  USAGE
1659
- $ mw project backup list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1660
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
2144
+ $ mw project backup list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
2145
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1661
2146
 
1662
2147
  FLAGS
1663
- -x, --extended show extra columns
1664
- --columns=<value> only show provided columns (comma-separated)
1665
- --csv output is csv format [alias: --output=csv]
1666
- --filter=<value> filter property by partial string matching, ex: name=foo
1667
- --no-header hide table header from output
1668
- --no-truncate do not truncate output to fit screen
1669
- --output=<option> output in a more machine friendly format
1670
- <options: csv|json|yaml>
1671
- --project-id=<value> (required) ID of the Project to get Backups for.
1672
- --sort=<value> property to sort by (prepend '-' for descending)
2148
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
2149
+ context
2150
+ -x, --extended show extra columns
2151
+ --columns=<value> only show provided columns (comma-separated)
2152
+ --csv output is csv format [alias: --output=csv]
2153
+ --filter=<value> filter property by partial string matching, ex: name=foo
2154
+ --no-header hide table header from output
2155
+ --no-truncate do not truncate output to fit screen
2156
+ --output=<option> output in a more machine friendly format
2157
+ <options: csv|json|yaml>
2158
+ --sort=<value> property to sort by (prepend '-' for descending)
1673
2159
 
1674
2160
  DESCRIPTION
1675
2161
  List Backups for a given Project.
2162
+
2163
+ FLAG DESCRIPTIONS
2164
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
2165
+
2166
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
2167
+ to persistently set a default project for all commands that accept this flag.
1676
2168
  ```
1677
2169
 
1678
2170
  ## `mw project backupschedule get PROJECTBACKUPSCHEDULEID`
@@ -1681,14 +2173,14 @@ Get a ProjectBackupSchedule.
1681
2173
 
1682
2174
  ```
1683
2175
  USAGE
1684
- $ mw project backupschedule get PROJECTBACKUPSCHEDULEID [--output json|yaml | | ]
2176
+ $ mw project backupschedule get PROJECTBACKUPSCHEDULEID [-o json|yaml | | ]
1685
2177
 
1686
2178
  ARGUMENTS
1687
2179
  PROJECTBACKUPSCHEDULEID ID of the ProjectBackupSchedule to retrieve.
1688
2180
 
1689
2181
  FLAGS
1690
- --output=<option> output in a more machine friendly format
1691
- <options: json|yaml>
2182
+ -o, --output=<option> output in a more machine friendly format
2183
+ <options: json|yaml>
1692
2184
 
1693
2185
  DESCRIPTION
1694
2186
  Get a ProjectBackupSchedule.
@@ -1725,32 +2217,45 @@ Get the details of a project
1725
2217
 
1726
2218
  ```
1727
2219
  USAGE
1728
- $ mw project create -s <value> -d <value> [-w]
2220
+ $ mw project create -d <value> [-s <value>] [-q] [-w] [--update-context]
1729
2221
 
1730
2222
  FLAGS
1731
2223
  -d, --description=<value> (required) A description for the project.
1732
- -s, --server-id=<value> (required) ID of the Server, in which the project is to be created.
2224
+ -q, --quiet suppress process output and only display a machine-readable summary.
2225
+ -s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the context
1733
2226
  -w, --wait Wait for the project to be ready.
2227
+ --update-context Update the CLI context to use the newly created project
1734
2228
 
1735
2229
  DESCRIPTION
1736
2230
  Get the details of a project
2231
+
2232
+ FLAG DESCRIPTIONS
2233
+ -q, --quiet suppress process output and only display a machine-readable summary.
2234
+
2235
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2236
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2237
+
2238
+ -s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the context
2239
+
2240
+ May contain a short ID or a full ID of a server; you can also use the "mw context set --server-id=<VALUE>" command
2241
+ to persistently set a default server for all commands that accept this flag.
1737
2242
  ```
1738
2243
 
1739
- ## `mw project cronjob execution get EXECUTIONID`
2244
+ ## `mw project cronjob execution get CRONJOB-ID EXECUTION-ID`
1740
2245
 
1741
2246
  Get a CronjobExecution.
1742
2247
 
1743
2248
  ```
1744
2249
  USAGE
1745
- $ mw project cronjob execution get EXECUTIONID --cronjob-id <value> [--output json|yaml | | ]
2250
+ $ mw project cronjob execution get CRONJOB-ID EXECUTION-ID [-o json|yaml | | ]
1746
2251
 
1747
2252
  ARGUMENTS
1748
- EXECUTIONID ID of the CronjobExecution to be retrieved.
2253
+ CRONJOB-ID ID of the cronjob the execution belongs to
2254
+ EXECUTION-ID ID of the cronjob execution to be retrieved.
1749
2255
 
1750
2256
  FLAGS
1751
- --cronjob-id=<value> (required) undefined
1752
- --output=<option> output in a more machine friendly format
1753
- <options: json|yaml>
2257
+ -o, --output=<option> output in a more machine friendly format
2258
+ <options: json|yaml>
1754
2259
 
1755
2260
  DESCRIPTION
1756
2261
  Get a CronjobExecution.
@@ -1781,152 +2286,141 @@ DESCRIPTION
1781
2286
  List CronjobExecutions belonging to a Cronjob.
1782
2287
  ```
1783
2288
 
1784
- ## `mw project cronjob get CRONJOBID`
2289
+ ## `mw project cronjob execution logs CRONJOB-ID EXECUTION-ID`
1785
2290
 
1786
- Get a Cronjob.
2291
+ Get the log output of a cronjob execution.
1787
2292
 
1788
2293
  ```
1789
2294
  USAGE
1790
- $ mw project cronjob get CRONJOBID [--output json|yaml | | ]
2295
+ $ mw project cronjob execution logs CRONJOB-ID EXECUTION-ID [-o json|yaml | | ] [--no-pager]
1791
2296
 
1792
2297
  ARGUMENTS
1793
- CRONJOBID ID of the Cronjob to be retrieved.
2298
+ CRONJOB-ID ID of the cronjob the execution belongs to
2299
+ EXECUTION-ID ID of the cronjob execution to be retrieved.
1794
2300
 
1795
2301
  FLAGS
1796
- --output=<option> output in a more machine friendly format
1797
- <options: json|yaml>
2302
+ -o, --output=<option> output in a more machine friendly format
2303
+ <options: json|yaml>
2304
+ --no-pager Disable pager for output.
1798
2305
 
1799
2306
  DESCRIPTION
1800
- Get a Cronjob.
1801
- ```
2307
+ Get the log output of a cronjob execution.
1802
2308
 
1803
- ## `mw project cronjob list`
1804
-
1805
- List Cronjobs belonging to a Project.
1806
-
1807
- ```
1808
- USAGE
1809
- $ mw project cronjob list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1810
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1811
-
1812
- FLAGS
1813
- -x, --extended show extra columns
1814
- --columns=<value> only show provided columns (comma-separated)
1815
- --csv output is csv format [alias: --output=csv]
1816
- --filter=<value> filter property by partial string matching, ex: name=foo
1817
- --no-header hide table header from output
1818
- --no-truncate do not truncate output to fit screen
1819
- --output=<option> output in a more machine friendly format
1820
- <options: csv|json|yaml>
1821
- --project-id=<value> (required) ID of the Project for which to list Cronjobs for.
1822
- --sort=<value> property to sort by (prepend '-' for descending)
1823
-
1824
- DESCRIPTION
1825
- List Cronjobs belonging to a Project.
2309
+ This command prints the log output of a cronjob execution. When this command is run in a terminal, the output is piped
2310
+ through a pager. The pager is determined by your PAGER environment variable, with defaulting to "less". You can
2311
+ disable this behavior with the --no-pager flag.
1826
2312
  ```
1827
2313
 
1828
- ## `mw project delete ID`
2314
+ ## `mw project cronjob get CRONJOBID`
1829
2315
 
1830
- Delete a project
2316
+ Get a Cronjob.
1831
2317
 
1832
2318
  ```
1833
2319
  USAGE
1834
- $ mw project delete ID [--force]
2320
+ $ mw project cronjob get CRONJOBID [-o json|yaml | | ]
1835
2321
 
1836
2322
  ARGUMENTS
1837
- ID ID of the Project to be deleted.
2323
+ CRONJOBID ID of the Cronjob to be retrieved.
1838
2324
 
1839
2325
  FLAGS
1840
- --force Do not ask for confirmation
2326
+ -o, --output=<option> output in a more machine friendly format
2327
+ <options: json|yaml>
1841
2328
 
1842
2329
  DESCRIPTION
1843
- Delete a project
2330
+ Get a Cronjob.
1844
2331
  ```
1845
2332
 
1846
- ## `mw project filesystem directories`
2333
+ ## `mw project cronjob list`
1847
2334
 
1848
- List the directories of a Project.
2335
+ List Cronjobs belonging to a Project.
1849
2336
 
1850
2337
  ```
1851
2338
  USAGE
1852
- $ mw project filesystem directories --project-id <value> [--output json|yaml | | ]
2339
+ $ mw project cronjob list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
2340
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1853
2341
 
1854
2342
  FLAGS
1855
- --output=<option> output in a more machine friendly format
1856
- <options: json|yaml>
1857
- --project-id=<value> (required) ID of the Project to list the directories for.
2343
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
2344
+ context
2345
+ -x, --extended show extra columns
2346
+ --columns=<value> only show provided columns (comma-separated)
2347
+ --csv output is csv format [alias: --output=csv]
2348
+ --filter=<value> filter property by partial string matching, ex: name=foo
2349
+ --no-header hide table header from output
2350
+ --no-truncate do not truncate output to fit screen
2351
+ --output=<option> output in a more machine friendly format
2352
+ <options: csv|json|yaml>
2353
+ --sort=<value> property to sort by (prepend '-' for descending)
1858
2354
 
1859
2355
  DESCRIPTION
1860
- List the directories of a Project.
1861
- ```
1862
-
1863
- ## `mw project filesystem file-content`
1864
-
1865
- Get a Project file's content.
1866
-
1867
- ```
1868
- USAGE
1869
- $ mw project filesystem file-content --project-id <value> [--output json|yaml | | ]
2356
+ List Cronjobs belonging to a Project.
1870
2357
 
1871
- FLAGS
1872
- --output=<option> output in a more machine friendly format
1873
- <options: json|yaml>
1874
- --project-id=<value> (required) ID of the Project.
2358
+ FLAG DESCRIPTIONS
2359
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1875
2360
 
1876
- DESCRIPTION
1877
- Get a Project file's content.
2361
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
2362
+ to persistently set a default project for all commands that accept this flag.
1878
2363
  ```
1879
2364
 
1880
- ## `mw project filesystem files PROJECTID`
2365
+ ## `mw project delete [PROJECT-ID]`
1881
2366
 
1882
- Get a foooooooo.
2367
+ Delete a project
1883
2368
 
1884
2369
  ```
1885
2370
  USAGE
1886
- $ mw project filesystem files PROJECTID [--output json|yaml | | ]
2371
+ $ mw project delete [PROJECT-ID] [-q] [-f]
1887
2372
 
1888
2373
  ARGUMENTS
1889
- PROJECTID ID of the Project.
2374
+ PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
1890
2375
 
1891
2376
  FLAGS
1892
- --output=<option> output in a more machine friendly format
1893
- <options: json|yaml>
2377
+ -f, --force Do not ask for confirmation
2378
+ -q, --quiet suppress process output and only display a machine-readable summary.
1894
2379
 
1895
2380
  DESCRIPTION
1896
- Get a foooooooo.
2381
+ Delete a project
2382
+
2383
+ FLAG DESCRIPTIONS
2384
+ -q, --quiet suppress process output and only display a machine-readable summary.
2385
+
2386
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2387
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1897
2388
  ```
1898
2389
 
1899
- ## `mw project filesystem usage`
2390
+ ## `mw project filesystem usage [PROJECT-ID]`
1900
2391
 
1901
2392
  Get a Project directory filesystem usage.
1902
2393
 
1903
2394
  ```
1904
2395
  USAGE
1905
- $ mw project filesystem usage --project-id <value> [--output json|yaml | | ]
2396
+ $ mw project filesystem usage [PROJECT-ID] [-o json|yaml | | ] [--human]
2397
+
2398
+ ARGUMENTS
2399
+ PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
1906
2400
 
1907
2401
  FLAGS
1908
- --output=<option> output in a more machine friendly format
1909
- <options: json|yaml>
1910
- --project-id=<value> (required) ID of the Project.
2402
+ -o, --output=<option> output in a more machine friendly format
2403
+ <options: json|yaml>
2404
+ --human Display human readable sizes.
1911
2405
 
1912
2406
  DESCRIPTION
1913
2407
  Get a Project directory filesystem usage.
1914
2408
  ```
1915
2409
 
1916
- ## `mw project get ID`
2410
+ ## `mw project get [PROJECT-ID]`
1917
2411
 
1918
2412
  Get a Project.
1919
2413
 
1920
2414
  ```
1921
2415
  USAGE
1922
- $ mw project get ID [--output json|yaml | | ]
2416
+ $ mw project get [PROJECT-ID] [-o json|yaml | | ]
1923
2417
 
1924
2418
  ARGUMENTS
1925
- ID ID of the Project to be retrieved.
2419
+ PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
1926
2420
 
1927
2421
  FLAGS
1928
- --output=<option> output in a more machine friendly format
1929
- <options: json|yaml>
2422
+ -o, --output=<option> output in a more machine friendly format
2423
+ <options: json|yaml>
1930
2424
 
1931
2425
  DESCRIPTION
1932
2426
  Get a Project.
@@ -1938,14 +2432,14 @@ Get a ProjectInvite.
1938
2432
 
1939
2433
  ```
1940
2434
  USAGE
1941
- $ mw project invite get INVITEID [--output json|yaml | | ]
2435
+ $ mw project invite get INVITEID [-o json|yaml | | ]
1942
2436
 
1943
2437
  ARGUMENTS
1944
2438
  INVITEID ID of the ProjectInvite to be retrieved.
1945
2439
 
1946
2440
  FLAGS
1947
- --output=<option> output in a more machine friendly format
1948
- <options: json|yaml>
2441
+ -o, --output=<option> output in a more machine friendly format
2442
+ <options: json|yaml>
1949
2443
 
1950
2444
  DESCRIPTION
1951
2445
  Get a ProjectInvite.
@@ -2024,24 +2518,19 @@ DESCRIPTION
2024
2518
  List Project's for an Organization or Server.
2025
2519
  ```
2026
2520
 
2027
- ## `mw project list1`
2521
+ ## `mw project list-react`
2028
2522
 
2029
2523
  ```
2030
2524
  USAGE
2031
- $ mw project list1 [--columns <value>]
2525
+ $ mw project list-react -o txt|json [--wait] [--columns <value> | ] [--extended] [--noTruncate]
2032
2526
 
2033
2527
  FLAGS
2034
- --columns=<value>...
2035
- ```
2036
-
2037
- ## `mw project list2`
2038
-
2039
- ```
2040
- USAGE
2041
- $ mw project list2 [--wait] [--columns <value>]
2042
-
2043
- FLAGS
2044
- --columns=<value>...
2528
+ -o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
2529
+ representation, and 'json' for a machine-readable JSON representation.
2530
+ <options: txt|json>
2531
+ --columns=<value> only show provided columns (comma-seperated)
2532
+ --extended show extra columns
2533
+ --noTruncate do not truncate output to fit screen
2045
2534
  --wait
2046
2535
  ```
2047
2536
 
@@ -2051,14 +2540,14 @@ Get a ProjectMembership
2051
2540
 
2052
2541
  ```
2053
2542
  USAGE
2054
- $ mw project membership get MEMBERSHIPID [--output json|yaml | | ]
2543
+ $ mw project membership get MEMBERSHIPID [-o json|yaml | | ]
2055
2544
 
2056
2545
  ARGUMENTS
2057
2546
  MEMBERSHIPID ID of the ProjectMembership to be retrieved.
2058
2547
 
2059
2548
  FLAGS
2060
- --output=<option> output in a more machine friendly format
2061
- <options: json|yaml>
2549
+ -o, --output=<option> output in a more machine friendly format
2550
+ <options: json|yaml>
2062
2551
 
2063
2552
  DESCRIPTION
2064
2553
  Get a ProjectMembership
@@ -2070,12 +2559,12 @@ Get the executing user's membership in a Project.
2070
2559
 
2071
2560
  ```
2072
2561
  USAGE
2073
- $ mw project membership get-own --project-id <value> [--output json|yaml | | ]
2562
+ $ mw project membership get-own --project-id <value> [-o json|yaml | | ]
2074
2563
 
2075
2564
  FLAGS
2076
- --output=<option> output in a more machine friendly format
2077
- <options: json|yaml>
2078
- --project-id=<value> (required) ID of the Project to get the membership for.
2565
+ -o, --output=<option> output in a more machine friendly format
2566
+ <options: json|yaml>
2567
+ --project-id=<value> (required) ID of the Project to get the membership for.
2079
2568
 
2080
2569
  DESCRIPTION
2081
2570
  Get the executing user's membership in a Project.
@@ -2155,16 +2644,16 @@ DESCRIPTION
2155
2644
  Get all SFTPUsers for a Project.
2156
2645
  ```
2157
2646
 
2158
- ## `mw project ssh ID`
2647
+ ## `mw project ssh [PROJECT-ID]`
2159
2648
 
2160
2649
  Connect to a project via SSH
2161
2650
 
2162
2651
  ```
2163
2652
  USAGE
2164
- $ mw project ssh ID
2653
+ $ mw project ssh [PROJECT-ID]
2165
2654
 
2166
2655
  ARGUMENTS
2167
- ID ID of the Project to be retrieved.
2656
+ PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
2168
2657
 
2169
2658
  DESCRIPTION
2170
2659
  Connect to a project via SSH
@@ -2195,16 +2684,16 @@ DESCRIPTION
2195
2684
  Get all SSHUsers for a Project.
2196
2685
  ```
2197
2686
 
2198
- ## `mw project update ID`
2687
+ ## `mw project update [PROJECT-ID]`
2199
2688
 
2200
2689
  Updates a project
2201
2690
 
2202
2691
  ```
2203
2692
  USAGE
2204
- $ mw project update ID
2693
+ $ mw project update [PROJECT-ID]
2205
2694
 
2206
2695
  ARGUMENTS
2207
- ID ID of the Project to be retrieved.
2696
+ PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
2208
2697
 
2209
2698
  DESCRIPTION
2210
2699
  Updates a project
@@ -2216,14 +2705,14 @@ Get a Server.
2216
2705
 
2217
2706
  ```
2218
2707
  USAGE
2219
- $ mw server get SERVERID [--output json|yaml | | ]
2708
+ $ mw server get SERVERID [-o json|yaml | | ]
2220
2709
 
2221
2710
  ARGUMENTS
2222
2711
  SERVERID ID of the Server to be retrieved.
2223
2712
 
2224
2713
  FLAGS
2225
- --output=<option> output in a more machine friendly format
2226
- <options: json|yaml>
2714
+ -o, --output=<option> output in a more machine friendly format
2715
+ <options: json|yaml>
2227
2716
 
2228
2717
  DESCRIPTION
2229
2718
  Get a Server.
@@ -2253,15 +2742,53 @@ DESCRIPTION
2253
2742
  List Servers for an Organization or User.
2254
2743
  ```
2255
2744
 
2745
+ ## `mw update [CHANNEL]`
2746
+
2747
+ update the mw CLI
2748
+
2749
+ ```
2750
+ USAGE
2751
+ $ mw update [CHANNEL] [-a] [-v <value> | -i] [--force]
2752
+
2753
+ FLAGS
2754
+ -a, --available Install a specific version.
2755
+ -i, --interactive Interactively select version to install. This is ignored if a channel is provided.
2756
+ -v, --version=<value> Install a specific version.
2757
+ --force Force a re-download of the requested version.
2758
+
2759
+ DESCRIPTION
2760
+ update the mw CLI
2761
+
2762
+ EXAMPLES
2763
+ Update to the stable channel:
2764
+
2765
+ $ mw update stable
2766
+
2767
+ Update to a specific version:
2768
+
2769
+ $ mw update --version 1.0.0
2770
+
2771
+ Interactively select version:
2772
+
2773
+ $ mw update --interactive
2774
+
2775
+ See available versions:
2776
+
2777
+ $ mw update --available
2778
+ ```
2779
+
2780
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.1.28/src/commands/update.ts)_
2781
+
2256
2782
  ## `mw user api-token create`
2257
2783
 
2258
2784
  Create a new API token
2259
2785
 
2260
2786
  ```
2261
2787
  USAGE
2262
- $ mw user api-token create --description <value> --roles api_read|api_write [--expires-in <value>]
2788
+ $ mw user api-token create --description <value> --roles api_read|api_write [-q] [--expires-in <value>]
2263
2789
 
2264
2790
  FLAGS
2791
+ -q, --quiet suppress process output and only display a machine-readable summary.
2265
2792
  --description=<value> (required) Description of the API token
2266
2793
  --expires-in=<value> Expiration interval of the API token (example: 30d)
2267
2794
  --roles=<option>... (required) Roles of the API token
@@ -2269,6 +2796,12 @@ FLAGS
2269
2796
 
2270
2797
  DESCRIPTION
2271
2798
  Create a new API token
2799
+
2800
+ FLAG DESCRIPTIONS
2801
+ -q, --quiet suppress process output and only display a machine-readable summary.
2802
+
2803
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2804
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2272
2805
  ```
2273
2806
 
2274
2807
  ## `mw user api-token get APITOKENID`
@@ -2277,14 +2810,14 @@ Get a specific ApiToken
2277
2810
 
2278
2811
  ```
2279
2812
  USAGE
2280
- $ mw user api-token get APITOKENID [--output json|yaml | | ]
2813
+ $ mw user api-token get APITOKENID [-o json|yaml | | ]
2281
2814
 
2282
2815
  ARGUMENTS
2283
2816
  APITOKENID The uuid of an ApiToken
2284
2817
 
2285
2818
  FLAGS
2286
- --output=<option> output in a more machine friendly format
2287
- <options: json|yaml>
2819
+ -o, --output=<option> output in a more machine friendly format
2820
+ <options: json|yaml>
2288
2821
 
2289
2822
  DESCRIPTION
2290
2823
  Get a specific ApiToken
@@ -2320,13 +2853,23 @@ Revoke an API token
2320
2853
 
2321
2854
  ```
2322
2855
  USAGE
2323
- $ mw user api-token revoke ID
2856
+ $ mw user api-token revoke ID [-q] [-f]
2324
2857
 
2325
2858
  ARGUMENTS
2326
2859
  ID ID of the API token to revoke
2327
2860
 
2861
+ FLAGS
2862
+ -f, --force Do not ask for confirmation
2863
+ -q, --quiet suppress process output and only display a machine-readable summary.
2864
+
2328
2865
  DESCRIPTION
2329
2866
  Revoke an API token
2867
+
2868
+ FLAG DESCRIPTIONS
2869
+ -q, --quiet suppress process output and only display a machine-readable summary.
2870
+
2871
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2872
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2330
2873
  ```
2331
2874
 
2332
2875
  ## `mw user get`
@@ -2335,11 +2878,11 @@ Get profile information for a user.
2335
2878
 
2336
2879
  ```
2337
2880
  USAGE
2338
- $ mw user get [--output json|yaml | | ]
2881
+ $ mw user get [-o json|yaml | | ]
2339
2882
 
2340
2883
  FLAGS
2341
- --output=<option> output in a more machine friendly format
2342
- <options: json|yaml>
2884
+ -o, --output=<option> output in a more machine friendly format
2885
+ <options: json|yaml>
2343
2886
 
2344
2887
  DESCRIPTION
2345
2888
  Get profile information for a user.
@@ -2351,14 +2894,14 @@ Get a specific Session
2351
2894
 
2352
2895
  ```
2353
2896
  USAGE
2354
- $ mw user session get TOKENID [--output json|yaml | | ]
2897
+ $ mw user session get TOKENID [-o json|yaml | | ]
2355
2898
 
2356
2899
  ARGUMENTS
2357
2900
  TOKENID tokenId to identify the concrete Session
2358
2901
 
2359
2902
  FLAGS
2360
- --output=<option> output in a more machine friendly format
2361
- <options: json|yaml>
2903
+ -o, --output=<option> output in a more machine friendly format
2904
+ <options: json|yaml>
2362
2905
 
2363
2906
  DESCRIPTION
2364
2907
  Get a specific Session
@@ -2394,15 +2937,23 @@ Create and import a new SSH key
2394
2937
 
2395
2938
  ```
2396
2939
  USAGE
2397
- $ mw user ssh-key create [--no-passphrase] [--comment <value>] [--expiresAt <value>]
2940
+ $ mw user ssh-key create [-q] [--output <value>] [--no-passphrase] [--comment <value>] [--expiresAt <value>]
2398
2941
 
2399
2942
  FLAGS
2943
+ -q, --quiet suppress process output and only display a machine-readable summary.
2400
2944
  --comment=<value> A comment for the SSH key.
2401
2945
  --expiresAt=<value> Duration after which the SSH key should expire (example: '1y').
2402
2946
  --no-passphrase Use this flag to not set a passphrase for the SSH key.
2947
+ --output=<value> [default: mstudio-cli] A filename in your ~/.ssh directory to write the SSH key to.
2403
2948
 
2404
2949
  DESCRIPTION
2405
2950
  Create and import a new SSH key
2951
+
2952
+ FLAG DESCRIPTIONS
2953
+ -q, --quiet suppress process output and only display a machine-readable summary.
2954
+
2955
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2956
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2406
2957
  ```
2407
2958
 
2408
2959
  ## `mw user ssh-key delete ID`
@@ -2411,16 +2962,23 @@ Delete an SSH key
2411
2962
 
2412
2963
  ```
2413
2964
  USAGE
2414
- $ mw user ssh-key delete ID [-f]
2965
+ $ mw user ssh-key delete ID [-q] [-f]
2415
2966
 
2416
2967
  ARGUMENTS
2417
2968
  ID ID of the SSH key to be deleted.
2418
2969
 
2419
2970
  FLAGS
2420
- -f, --force delete without prompting for confirmation
2971
+ -f, --force Do not ask for confirmation
2972
+ -q, --quiet suppress process output and only display a machine-readable summary.
2421
2973
 
2422
2974
  DESCRIPTION
2423
2975
  Delete an SSH key
2976
+
2977
+ FLAG DESCRIPTIONS
2978
+ -q, --quiet suppress process output and only display a machine-readable summary.
2979
+
2980
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2981
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2424
2982
  ```
2425
2983
 
2426
2984
  ## `mw user ssh-key get SSHKEYID`
@@ -2429,14 +2987,14 @@ Get a specific stored SshKey
2429
2987
 
2430
2988
  ```
2431
2989
  USAGE
2432
- $ mw user ssh-key get SSHKEYID [--output json|yaml | | ]
2990
+ $ mw user ssh-key get SSHKEYID [-o json|yaml | | ]
2433
2991
 
2434
2992
  ARGUMENTS
2435
2993
  SSHKEYID undefined
2436
2994
 
2437
2995
  FLAGS
2438
- --output=<option> output in a more machine friendly format
2439
- <options: json|yaml>
2996
+ -o, --output=<option> output in a more machine friendly format
2997
+ <options: json|yaml>
2440
2998
 
2441
2999
  DESCRIPTION
2442
3000
  Get a specific stored SshKey
@@ -2465,5 +3023,4 @@ FLAGS
2465
3023
  DESCRIPTION
2466
3024
  Get your stored ssh keys
2467
3025
  ```
2468
-
2469
3026
  <!-- commandsstop -->