@mittwald/cli 1.0.0-alpha.19 → 1.0.0-alpha.21

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 (147) hide show
  1. package/README.md +904 -83
  2. package/dist/esm/BaseCommand.js +1 -0
  3. package/dist/esm/commands/app/copy.d.ts +1 -0
  4. package/dist/esm/commands/app/copy.js +1 -0
  5. package/dist/esm/commands/app/dependency/list.js +1 -1
  6. package/dist/esm/commands/app/dependency/versions.js +1 -1
  7. package/dist/esm/commands/app/install/contao.d.ts +11 -0
  8. package/dist/esm/commands/app/install/contao.js +24 -0
  9. package/dist/esm/commands/app/install/joomla.d.ts +11 -0
  10. package/dist/esm/commands/app/install/joomla.js +23 -0
  11. package/dist/esm/commands/app/install/matomo.d.ts +11 -0
  12. package/dist/esm/commands/app/install/matomo.js +21 -0
  13. package/dist/esm/commands/app/install/node.d.ts +11 -0
  14. package/dist/esm/commands/app/install/node.js +13 -0
  15. package/dist/esm/commands/app/install/php.d.ts +11 -0
  16. package/dist/esm/commands/app/install/php.js +13 -0
  17. package/dist/esm/commands/app/install/shopware5.d.ts +11 -0
  18. package/dist/esm/commands/app/install/shopware5.js +26 -0
  19. package/dist/esm/commands/app/install/shopware6.d.ts +11 -0
  20. package/dist/esm/commands/app/install/shopware6.js +26 -0
  21. package/dist/esm/commands/app/install/typo3.d.ts +11 -0
  22. package/dist/esm/commands/app/install/typo3.js +22 -0
  23. package/dist/esm/commands/app/install/wordpress.d.ts +4 -16
  24. package/dist/esm/commands/app/install/wordpress.js +16 -107
  25. package/dist/esm/commands/app/list.d.ts +1 -1
  26. package/dist/esm/commands/app/list.js +1 -1
  27. package/dist/esm/commands/app/versions.js +1 -1
  28. package/dist/esm/commands/database/mysql/create.d.ts +1 -0
  29. package/dist/esm/commands/database/mysql/create.js +1 -1
  30. package/dist/esm/commands/database/mysql/list.d.ts +1 -1
  31. package/dist/esm/commands/database/mysql/list.js +1 -1
  32. package/dist/esm/commands/database/redis/create.d.ts +1 -0
  33. package/dist/esm/commands/database/redis/create.js +1 -1
  34. package/dist/esm/commands/database/redis/list.d.ts +1 -1
  35. package/dist/esm/commands/database/redis/list.js +1 -1
  36. package/dist/esm/commands/database/redis/versions.d.ts +2 -2
  37. package/dist/esm/commands/database/redis/versions.js +2 -2
  38. package/dist/esm/commands/domain/list.d.ts +1 -1
  39. package/dist/esm/commands/domain/list.js +1 -1
  40. package/dist/esm/commands/domain/ownership/list.d.ts +10 -3
  41. package/dist/esm/commands/domain/ownership/list.js +17 -3
  42. package/dist/esm/commands/domain/virtualhost/create.d.ts +1 -0
  43. package/dist/esm/commands/domain/virtualhost/create.js +1 -1
  44. package/dist/esm/commands/domain/virtualhost/list.d.ts +1 -0
  45. package/dist/esm/commands/domain/virtualhost/list.js +1 -1
  46. package/dist/esm/commands/mail/address/create.d.ts +1 -0
  47. package/dist/esm/commands/mail/address/create.js +1 -1
  48. package/dist/esm/commands/mail/address/list.d.ts +1 -1
  49. package/dist/esm/commands/mail/address/list.js +1 -1
  50. package/dist/esm/commands/org/delete.d.ts +1 -1
  51. package/dist/esm/commands/org/delete.js +1 -1
  52. package/dist/esm/commands/org/get.d.ts +1 -1
  53. package/dist/esm/commands/org/get.js +1 -1
  54. package/dist/esm/commands/org/invite/list.d.ts +1 -1
  55. package/dist/esm/commands/org/invite/list.js +1 -1
  56. package/dist/esm/commands/org/invite.d.ts +2 -2
  57. package/dist/esm/commands/org/invite.js +4 -17
  58. package/dist/esm/commands/org/membership/list.d.ts +1 -1
  59. package/dist/esm/commands/org/membership/list.js +1 -1
  60. package/dist/esm/commands/project/backup/create.d.ts +19 -0
  61. package/dist/esm/commands/project/backup/create.js +59 -0
  62. package/dist/esm/commands/project/backup/delete.d.ts +13 -0
  63. package/dist/esm/commands/project/backup/delete.js +21 -0
  64. package/dist/esm/commands/project/backup/download.d.ts +27 -0
  65. package/dist/esm/commands/project/backup/download.js +177 -0
  66. package/dist/esm/commands/project/backup/get.d.ts +11 -2
  67. package/dist/esm/commands/project/backup/get.js +26 -5
  68. package/dist/esm/commands/project/backup/list.d.ts +10 -10
  69. package/dist/esm/commands/project/backup/list.js +1 -1
  70. package/dist/esm/commands/project/backupschedule/list.d.ts +13 -7
  71. package/dist/esm/commands/project/backupschedule/list.js +15 -7
  72. package/dist/esm/commands/project/create.d.ts +3 -1
  73. package/dist/esm/commands/project/create.js +5 -8
  74. package/dist/esm/commands/project/cronjob/list.d.ts +1 -1
  75. package/dist/esm/commands/project/cronjob/list.js +1 -1
  76. package/dist/esm/commands/project/delete.d.ts +1 -1
  77. package/dist/esm/commands/project/delete.js +1 -1
  78. package/dist/esm/commands/project/filesystem/usage.d.ts +1 -1
  79. package/dist/esm/commands/project/filesystem/usage.js +1 -1
  80. package/dist/esm/commands/project/get.d.ts +1 -1
  81. package/dist/esm/commands/project/get.js +2 -2
  82. package/dist/esm/commands/project/list.d.ts +10 -2
  83. package/dist/esm/commands/project/list.js +10 -2
  84. package/dist/esm/commands/project/ssh.d.ts +1 -1
  85. package/dist/esm/commands/project/ssh.js +1 -1
  86. package/dist/esm/commands/project/update.d.ts +1 -1
  87. package/dist/esm/commands/project/update.js +1 -1
  88. package/dist/esm/lib/app/Installer.d.ts +21 -0
  89. package/dist/esm/lib/app/Installer.js +49 -0
  90. package/dist/esm/lib/app/flags.d.ts +25 -0
  91. package/dist/esm/lib/app/flags.js +190 -1
  92. package/dist/esm/lib/app/install.d.ts +4 -0
  93. package/dist/esm/lib/app/install.js +20 -0
  94. package/dist/esm/lib/app/{appVersionHelpers.d.ts → versions.d.ts} +3 -0
  95. package/dist/esm/lib/app/{appVersionHelpers.js → versions.js} +18 -0
  96. package/dist/esm/lib/app/wait.d.ts +3 -0
  97. package/dist/esm/lib/app/wait.js +19 -0
  98. package/dist/esm/lib/context_flags.d.ts +20 -9
  99. package/dist/esm/lib/context_flags.js +25 -2
  100. package/dist/esm/lib/database/mysql/flags.js +1 -1
  101. package/dist/esm/lib/database/redis/flags.js +1 -1
  102. package/dist/esm/lib/expires.d.ts +11 -0
  103. package/dist/esm/lib/expires.js +31 -0
  104. package/dist/esm/lib/handleError.js +3 -20
  105. package/dist/esm/lib/org/flags.d.ts +11 -3
  106. package/dist/esm/lib/password.d.ts +2 -0
  107. package/dist/esm/lib/password.js +20 -0
  108. package/dist/esm/lib/project/flags.d.ts +11 -3
  109. package/dist/esm/lib/project/hooks.d.ts +3 -0
  110. package/dist/esm/lib/project/hooks.js +11 -0
  111. package/dist/esm/lib/project/ingress.d.ts +2 -0
  112. package/dist/esm/lib/project/ingress.js +16 -0
  113. package/dist/esm/lib/project/shortId.d.ts +2 -0
  114. package/dist/esm/lib/project/shortId.js +11 -0
  115. package/dist/esm/lib/projectbackup/hooks.d.ts +5 -0
  116. package/dist/esm/lib/projectbackup/hooks.js +19 -0
  117. package/dist/esm/lib/server/flags.d.ts +11 -3
  118. package/dist/esm/lib/viewhelpers/size.d.ts +2 -1
  119. package/dist/esm/lib/viewhelpers/size.js +2 -2
  120. package/dist/esm/lib/wait.d.ts +4 -0
  121. package/dist/esm/lib/wait.js +13 -2
  122. package/dist/esm/rendering/process/components/ProcessStateSummary.js +3 -0
  123. package/dist/esm/rendering/process/process.d.ts +2 -0
  124. package/dist/esm/rendering/process/process.js +4 -0
  125. package/dist/esm/rendering/react/ExecRenderBaseCommand.js +11 -1
  126. package/dist/esm/rendering/react/components/ErrorBox.js +27 -1
  127. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupDetails.d.ts +6 -0
  128. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupDetails.js +29 -0
  129. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupStatus.d.ts +6 -0
  130. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupStatus.js +8 -0
  131. package/package.json +37 -3
  132. package/dist/esm/commands/project/backupschedule/get.d.ts +0 -3
  133. package/dist/esm/commands/project/backupschedule/get.js +0 -6
  134. package/dist/esm/commands/project/list-react.d.ts +0 -11
  135. package/dist/esm/commands/project/list-react.js +0 -42
  136. package/dist/esm/generated/backup/getProjectBackup.d.ts +0 -16
  137. package/dist/esm/generated/backup/getProjectBackup.js +0 -25
  138. package/dist/esm/generated/backup/getProjectBackupSchedule.d.ts +0 -16
  139. package/dist/esm/generated/backup/getProjectBackupSchedule.js +0 -25
  140. package/dist/esm/generated/backup/listProjectBackupSchedules.d.ts +0 -13
  141. package/dist/esm/generated/backup/listProjectBackupSchedules.js +0 -24
  142. package/dist/esm/generated/backup/listProjectBackups.d.ts +0 -13
  143. package/dist/esm/generated/backup/listProjectBackups.js +0 -24
  144. package/dist/esm/generated/domain/listDomainOwnerships.d.ts +0 -13
  145. package/dist/esm/generated/domain/listDomainOwnerships.js +0 -21
  146. /package/dist/esm/lib/app/{appHelpers.d.ts → uuid.d.ts} +0 -0
  147. /package/dist/esm/lib/app/{appHelpers.js → uuid.js} +0 -0
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  <center>
2
2
 
3
- # `mw` -- the mittwald command-line tool
3
+ # `mw` &mdash; the mittwald command-line tool
4
4
 
5
5
  ![](docs/demo.png)
6
6
 
7
7
  </center>
8
8
 
9
- > ⚠️ **EXPERIMENTAL -- STABILITY NOTICE**
9
+ > ⚠️ **EXPERIMENTAL &mdash; STABILITY NOTICE**
10
10
  >
11
11
  > This project is **experimental**, and we do not offer any stability guarantees
12
12
  > of any kind for the command structure, input flags and arguments and output
@@ -18,11 +18,49 @@
18
18
 
19
19
  `mw` is the command-line tool for interacting with the mittwald mStudio v2 API.
20
20
 
21
- ## Installation and first steps
21
+ ## Getting started
22
22
 
23
- Have a look at the
24
- [documentation](https://developer.mittwald.de/docs/v2/api/sdks/cli/) for
25
- installation instructions.
23
+ ### Installation
24
+
25
+ #### macOS, using Homebrew
26
+
27
+ Installation using [Homebrew](https://brew.sh/) is the recommended way of installation on macOS.
28
+
29
+ ```shell
30
+ $ brew tap mittwald/cli
31
+ $ brew install mw
32
+ ```
33
+
34
+ #### Windows, using the Installer
35
+
36
+ Find the appropriate Windows installer from the [releases page](https://github.com/mittwald/cli/releases) and run the installer. After running the installer, you should be able to use the `mw` command on either the CMD prompt or PowerShell.
37
+
38
+ #### Any OS, using Node.js+NPM
39
+
40
+ Installing the CLI via NPM will work on any OS; however we cannot guarantee stability, because functionality of the CLI may depend in the Node.js runtime already installed on your system. Also, the automatic upgrade will not work when using NPM; remember to run `npm upgrade -g @mittwald/cli` occasionally.
41
+
42
+ ```shell
43
+ $ npm install -g @mittwald/cli
44
+ ```
45
+
46
+ #### Any OS, using Docker
47
+
48
+ There is also the [`mittwald/cli` Docker image](https://hub.docker.com/r/mittwald/cli) that you can use instead of installing the CLI on your system. In case of the Docker container, authentication works a bit differently than described below: Make sure that there is an environment variable `MITTWALD_API_TOKEN` present on your system; you can then pass that environment variable into your container:
49
+
50
+ ```shell
51
+ $ export MITTWALD_API_TOKEN=<enter token here>
52
+ $ docker run --rm -it -e MITTWALD_API_TOKEN mittwald/cli help
53
+ ```
54
+
55
+ ### Authentication
56
+
57
+ To use the CLI, you will need an [mStudio API token](https://studio.mittwald.de/app/profile/api-tokens). With your token in your clipboard, run the `mw login token` command:
58
+
59
+ ```shell
60
+ $ mw login token
61
+ Enter your mStudio API token: ****************
62
+ token saved to '/Users/mhelmich/.config/mw/token'
63
+ ```
26
64
 
27
65
  ## Usage
28
66
 
@@ -46,6 +84,14 @@ USAGE
46
84
  * [`mw app dependency update INSTALLATION-ID`](#mw-app-dependency-update-installation-id)
47
85
  * [`mw app dependency versions SYSTEMSOFTWARE`](#mw-app-dependency-versions-systemsoftware)
48
86
  * [`mw app get INSTALLATION-ID`](#mw-app-get-installation-id)
87
+ * [`mw app install contao`](#mw-app-install-contao)
88
+ * [`mw app install joomla`](#mw-app-install-joomla)
89
+ * [`mw app install matomo`](#mw-app-install-matomo)
90
+ * [`mw app install node`](#mw-app-install-node)
91
+ * [`mw app install php`](#mw-app-install-php)
92
+ * [`mw app install shopware5`](#mw-app-install-shopware5)
93
+ * [`mw app install shopware6`](#mw-app-install-shopware6)
94
+ * [`mw app install typo3`](#mw-app-install-typo3)
49
95
  * [`mw app install wordpress`](#mw-app-install-wordpress)
50
96
  * [`mw app list`](#mw-app-list)
51
97
  * [`mw app uninstall INSTALLATION-ID`](#mw-app-uninstall-installation-id)
@@ -109,9 +155,11 @@ USAGE
109
155
  * [`mw org membership list`](#mw-org-membership-list)
110
156
  * [`mw org membership list-own`](#mw-org-membership-list-own)
111
157
  * [`mw org membership revoke MEMBERSHIP-ID`](#mw-org-membership-revoke-membership-id)
112
- * [`mw project backup get PROJECTBACKUPID`](#mw-project-backup-get-projectbackupid)
158
+ * [`mw project backup create`](#mw-project-backup-create)
159
+ * [`mw project backup delete BACKUP-ID`](#mw-project-backup-delete-backup-id)
160
+ * [`mw project backup download BACKUP-ID`](#mw-project-backup-download-backup-id)
161
+ * [`mw project backup get BACKUP-ID`](#mw-project-backup-get-backup-id)
113
162
  * [`mw project backup list`](#mw-project-backup-list)
114
- * [`mw project backupschedule get PROJECTBACKUPSCHEDULEID`](#mw-project-backupschedule-get-projectbackupscheduleid)
115
163
  * [`mw project backupschedule list`](#mw-project-backupschedule-list)
116
164
  * [`mw project create`](#mw-project-create)
117
165
  * [`mw project cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-get-cronjob-id-execution-id)
@@ -126,7 +174,6 @@ USAGE
126
174
  * [`mw project invite list`](#mw-project-invite-list)
127
175
  * [`mw project invite list-own`](#mw-project-invite-list-own)
128
176
  * [`mw project list`](#mw-project-list)
129
- * [`mw project list-react`](#mw-project-list-react)
130
177
  * [`mw project membership get MEMBERSHIPID`](#mw-project-membership-get-membershipid)
131
178
  * [`mw project membership get-own`](#mw-project-membership-get-own)
132
179
  * [`mw project membership list`](#mw-project-membership-list)
@@ -152,6 +199,8 @@ USAGE
152
199
 
153
200
  ## `mw app copy INSTALLATION-ID`
154
201
 
202
+ Copy an app within a project
203
+
155
204
  ```
156
205
  USAGE
157
206
  $ mw app copy INSTALLATION-ID --description <value> [-q]
@@ -163,6 +212,9 @@ FLAGS
163
212
  -q, --quiet suppress process output and only display a machine-readable summary.
164
213
  --description=<value> (required) set a description for the new app installation
165
214
 
215
+ DESCRIPTION
216
+ Copy an app within a project
217
+
166
218
  FLAG DESCRIPTIONS
167
219
  -q, --quiet suppress process output and only display a machine-readable summary.
168
220
 
@@ -172,7 +224,7 @@ FLAG DESCRIPTIONS
172
224
 
173
225
  ## `mw app dependency list`
174
226
 
175
- get all available dependencies
227
+ Get all available dependencies
176
228
 
177
229
  ```
178
230
  USAGE
@@ -191,7 +243,7 @@ FLAGS
191
243
  --sort=<value> property to sort by (prepend '-' for descending)
192
244
 
193
245
  DESCRIPTION
194
- get all available dependencies
246
+ Get all available dependencies
195
247
  ```
196
248
 
197
249
  ## `mw app dependency update INSTALLATION-ID`
@@ -232,7 +284,7 @@ FLAG DESCRIPTIONS
232
284
 
233
285
  ## `mw app dependency versions SYSTEMSOFTWARE`
234
286
 
235
- get all available versions of a particular dependency
287
+ Get all available versions of a particular dependency
236
288
 
237
289
  ```
238
290
  USAGE
@@ -254,7 +306,7 @@ FLAGS
254
306
  --sort=<value> property to sort by (prepend '-' for descending)
255
307
 
256
308
  DESCRIPTION
257
- get all available versions of a particular dependency
309
+ Get all available versions of a particular dependency
258
310
  ```
259
311
 
260
312
  ## `mw app get INSTALLATION-ID`
@@ -276,26 +328,684 @@ DESCRIPTION
276
328
  Get details about an app installation
277
329
  ```
278
330
 
331
+ ## `mw app install contao`
332
+
333
+ Creates new Contao Installation.
334
+
335
+ ```
336
+ USAGE
337
+ $ mw app install contao --version <value> [-p <value>] [-q] [--host <value>] [--admin-firstname <value>] [--admin-user
338
+ <value>] [--admin-email <value>] [--admin-pass <value>] [--admin-lastname <value>] [--site-title <value>] [-w]
339
+ [--json]
340
+
341
+ FLAGS
342
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
343
+ context
344
+ -q, --quiet suppress process output and only display a machine-readable summary.
345
+ -w, --wait Wait for your Contao to be ready.
346
+ --admin-email=<value> E-Mail-Address of your administrator-user.
347
+ --admin-firstname=<value> Firstname of your administrator-user.
348
+ --admin-lastname=<value> Lastname of your administrator-user.
349
+ --admin-pass=<value> Password of your administrator-user.
350
+ --admin-user=<value> Username for your administrator-user.
351
+ --host=<value> Host to initially configure your Contao installation with; needs to be created separately.
352
+ --json
353
+ --site-title=<value> Site Title for your Contao installation.
354
+ --version=<value> (required) [default: latest] Version of Contao to be installed.
355
+
356
+ DESCRIPTION
357
+ Creates new Contao Installation.
358
+
359
+ FLAG DESCRIPTIONS
360
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
361
+
362
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
363
+ to persistently set a default project for all commands that accept this flag.
364
+
365
+ -q, --quiet suppress process output and only display a machine-readable summary.
366
+
367
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
368
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
369
+
370
+ --admin-email=<value> E-Mail-Address of your administrator-user.
371
+
372
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Contao
373
+ installation.
374
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
375
+ installation is finished.
376
+
377
+ --admin-firstname=<value> Firstname of your administrator-user.
378
+
379
+ Firstname that will correlate to the first administrator-user which will be created during the Contao installation.
380
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
381
+ is finished
382
+
383
+ --admin-lastname=<value> Lastname of your administrator-user.
384
+
385
+ Lastname that will correlate to the first administrator-user which will be created during the Contao installation.
386
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
387
+ finished
388
+
389
+ --admin-pass=<value> Password of your administrator-user.
390
+
391
+ Password that will correlate to the first administrator-user which will be created during the Contao installation.
392
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
393
+ installation is finished
394
+
395
+ --admin-user=<value> Username for your administrator-user.
396
+
397
+ Username of the first administrator-user which will be created during the Contao installation.
398
+ If not given an adequate username will be created from your mStudio Account Data.
399
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
400
+
401
+ --host=<value> Host to initially configure your Contao installation with; needs to be created separately.
402
+
403
+ Specify a host which will be used during the installation and as an initial host for the Contao configuration.
404
+ If not given the default host for the given Project will be used.
405
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Contao
406
+ installation.
407
+
408
+ --site-title=<value> Site Title for your Contao installation.
409
+
410
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Contao installation.
411
+ It is also the Title shown in the App-Overview in the mStudio.
412
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
413
+ installation is finished
414
+
415
+ --version=<value> Version of Contao to be installed.
416
+
417
+ Specify the Version in which your Contao will be installed.
418
+ If none is given the Contao will be installed in the latest available version.
419
+ ```
420
+
421
+ ## `mw app install joomla`
422
+
423
+ Creates new Joomla! Installation.
424
+
425
+ ```
426
+ USAGE
427
+ $ mw app install joomla --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
428
+ <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>] [-w]
429
+ [--json]
430
+
431
+ FLAGS
432
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
433
+ context
434
+ -q, --quiet suppress process output and only display a machine-readable summary.
435
+ -w, --wait Wait for your Joomla! to be ready.
436
+ --admin-email=<value> E-Mail-Address of your administrator-user.
437
+ --admin-firstname=<value> Firstname of your administrator-user.
438
+ --admin-lastname=<value> Lastname of your administrator-user.
439
+ --admin-pass=<value> Password of your administrator-user.
440
+ --admin-user=<value> Username for your administrator-user.
441
+ --host=<value> Host to initially configure your Joomla! installation with; needs to be created separately.
442
+ --json
443
+ --site-title=<value> Site Title for your Joomla! installation.
444
+ --version=<value> (required) [default: latest] Version of Joomla! to be installed.
445
+
446
+ DESCRIPTION
447
+ Creates new Joomla! Installation.
448
+
449
+ FLAG DESCRIPTIONS
450
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
451
+
452
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
453
+ to persistently set a default project for all commands that accept this flag.
454
+
455
+ -q, --quiet suppress process output and only display a machine-readable summary.
456
+
457
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
458
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
459
+
460
+ --admin-email=<value> E-Mail-Address of your administrator-user.
461
+
462
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Joomla!
463
+ installation.
464
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
465
+ installation is finished.
466
+
467
+ --admin-firstname=<value> Firstname of your administrator-user.
468
+
469
+ Firstname that will correlate to the first administrator-user which will be created during the Joomla! installation.
470
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
471
+ is finished
472
+
473
+ --admin-lastname=<value> Lastname of your administrator-user.
474
+
475
+ Lastname that will correlate to the first administrator-user which will be created during the Joomla! installation.
476
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
477
+ finished
478
+
479
+ --admin-pass=<value> Password of your administrator-user.
480
+
481
+ Password that will correlate to the first administrator-user which will be created during the Joomla! installation.
482
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
483
+ installation is finished
484
+
485
+ --admin-user=<value> Username for your administrator-user.
486
+
487
+ Username of the first administrator-user which will be created during the Joomla! installation.
488
+ If not given an adequate username will be created from your mStudio Account Data.
489
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
490
+
491
+ --host=<value> Host to initially configure your Joomla! installation with; needs to be created separately.
492
+
493
+ Specify a host which will be used during the installation and as an initial host for the Joomla! configuration.
494
+ If not given the default host for the given Project will be used.
495
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Joomla!
496
+ installation.
497
+
498
+ --site-title=<value> Site Title for your Joomla! installation.
499
+
500
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Joomla! installation.
501
+ It is also the Title shown in the App-Overview in the mStudio.
502
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
503
+ installation is finished
504
+
505
+ --version=<value> Version of Joomla! to be installed.
506
+
507
+ Specify the Version in which your Joomla! will be installed.
508
+ If none is given the Joomla! will be installed in the latest available version.
509
+ ```
510
+
511
+ ## `mw app install matomo`
512
+
513
+ Creates new Matomo Installation.
514
+
515
+ ```
516
+ USAGE
517
+ $ mw app install matomo --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
518
+ <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
519
+
520
+ FLAGS
521
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
522
+ context
523
+ -q, --quiet suppress process output and only display a machine-readable summary.
524
+ -w, --wait Wait for your Matomo to be ready.
525
+ --admin-email=<value> E-Mail-Address of your administrator-user.
526
+ --admin-pass=<value> Password of your administrator-user.
527
+ --admin-user=<value> Username for your administrator-user.
528
+ --host=<value> Host to initially configure your Matomo installation with; needs to be created separately.
529
+ --json
530
+ --site-title=<value> Site Title for your Matomo installation.
531
+ --version=<value> (required) [default: latest] Version of Matomo to be installed.
532
+
533
+ DESCRIPTION
534
+ Creates new Matomo Installation.
535
+
536
+ FLAG DESCRIPTIONS
537
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
538
+
539
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
540
+ to persistently set a default project for all commands that accept this flag.
541
+
542
+ -q, --quiet suppress process output and only display a machine-readable summary.
543
+
544
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
545
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
546
+
547
+ --admin-email=<value> E-Mail-Address of your administrator-user.
548
+
549
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Matomo
550
+ installation.
551
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
552
+ installation is finished.
553
+
554
+ --admin-pass=<value> Password of your administrator-user.
555
+
556
+ Password that will correlate to the first administrator-user which will be created during the Matomo installation.
557
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
558
+ installation is finished
559
+
560
+ --admin-user=<value> Username for your administrator-user.
561
+
562
+ Username of the first administrator-user which will be created during the Matomo installation.
563
+ If not given an adequate username will be created from your mStudio Account Data.
564
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
565
+
566
+ --host=<value> Host to initially configure your Matomo installation with; needs to be created separately.
567
+
568
+ Specify a host which will be used during the installation and as an initial host for the Matomo configuration.
569
+ If not given the default host for the given Project will be used.
570
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Matomo
571
+ installation.
572
+
573
+ --site-title=<value> Site Title for your Matomo installation.
574
+
575
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Matomo installation.
576
+ It is also the Title shown in the App-Overview in the mStudio.
577
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
578
+ installation is finished
579
+
580
+ --version=<value> Version of Matomo to be installed.
581
+
582
+ Specify the Version in which your Matomo will be installed.
583
+ If none is given the Matomo will be installed in the latest available version.
584
+ ```
585
+
586
+ ## `mw app install node`
587
+
588
+ Creates new Node.js Project Installation.
589
+
590
+ ```
591
+ USAGE
592
+ $ mw app install node --version <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
593
+
594
+ FLAGS
595
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
596
+ context
597
+ -q, --quiet suppress process output and only display a machine-readable summary.
598
+ -w, --wait Wait for your Node.js Project to be ready.
599
+ --json
600
+ --site-title=<value> Site Title for your Node.js Project installation.
601
+ --version=<value> (required) [default: latest] Version of Node.js Project to be installed.
602
+
603
+ DESCRIPTION
604
+ Creates new Node.js Project Installation.
605
+
606
+ FLAG DESCRIPTIONS
607
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
608
+
609
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
610
+ to persistently set a default project for all commands that accept this flag.
611
+
612
+ -q, --quiet suppress process output and only display a machine-readable summary.
613
+
614
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
615
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
616
+
617
+ --site-title=<value> Site Title for your Node.js Project installation.
618
+
619
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Node.js Project installation.
620
+ It is also the Title shown in the App-Overview in the mStudio.
621
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
622
+ installation is finished
623
+
624
+ --version=<value> Version of Node.js Project to be installed.
625
+
626
+ Specify the Version in which your Node.js Project will be installed.
627
+ If none is given the Node.js Project will be installed in the latest available version.
628
+ ```
629
+
630
+ ## `mw app install php`
631
+
632
+ Creates new PHP Project Installation.
633
+
634
+ ```
635
+ USAGE
636
+ $ mw app install php --version <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
637
+
638
+ FLAGS
639
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
640
+ context
641
+ -q, --quiet suppress process output and only display a machine-readable summary.
642
+ -w, --wait Wait for your PHP Project to be ready.
643
+ --json
644
+ --site-title=<value> Site Title for your PHP Project installation.
645
+ --version=<value> (required) [default: latest] Version of PHP Project to be installed.
646
+
647
+ DESCRIPTION
648
+ Creates new PHP Project Installation.
649
+
650
+ FLAG DESCRIPTIONS
651
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
652
+
653
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
654
+ to persistently set a default project for all commands that accept this flag.
655
+
656
+ -q, --quiet suppress process output and only display a machine-readable summary.
657
+
658
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
659
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
660
+
661
+ --site-title=<value> Site Title for your PHP Project installation.
662
+
663
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your PHP Project installation.
664
+ It is also the Title shown in the App-Overview in the mStudio.
665
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
666
+ installation is finished
667
+
668
+ --version=<value> Version of PHP Project to be installed.
669
+
670
+ Specify the Version in which your PHP Project will be installed.
671
+ If none is given the PHP Project will be installed in the latest available version.
672
+ ```
673
+
674
+ ## `mw app install shopware5`
675
+
676
+ Creates new Shopware 5 Installation.
677
+
678
+ ```
679
+ USAGE
680
+ $ mw app install shopware5 --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
681
+ <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>]
682
+ [--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
683
+
684
+ FLAGS
685
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
686
+ context
687
+ -q, --quiet suppress process output and only display a machine-readable summary.
688
+ -w, --wait Wait for your Shopware 5 to be ready.
689
+ --admin-email=<value> E-Mail-Address of your administrator-user.
690
+ --admin-firstname=<value> Firstname of your administrator-user.
691
+ --admin-lastname=<value> Lastname of your administrator-user.
692
+ --admin-pass=<value> Password of your administrator-user.
693
+ --admin-user=<value> Username for your administrator-user.
694
+ --host=<value> Host to initially configure your Shopware 5 installation with; needs to be created
695
+ separately.
696
+ --json
697
+ --shop-currency=<value> Currency your Shopware 5 will be working with.
698
+ --shop-email=<value> E-Mail-Address your Shopware 5 will be working with.
699
+ --shop-lang=<value> Language your Shopware 5 will be working with.
700
+ --site-title=<value> Site Title for your Shopware 5 installation.
701
+ --version=<value> (required) [default: latest] Version of Shopware 5 to be installed.
702
+
703
+ DESCRIPTION
704
+ Creates new Shopware 5 Installation.
705
+
706
+ FLAG DESCRIPTIONS
707
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
708
+
709
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
710
+ to persistently set a default project for all commands that accept this flag.
711
+
712
+ -q, --quiet suppress process output and only display a machine-readable summary.
713
+
714
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
715
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
716
+
717
+ --admin-email=<value> E-Mail-Address of your administrator-user.
718
+
719
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Shopware 5
720
+ installation.
721
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
722
+ installation is finished.
723
+
724
+ --admin-firstname=<value> Firstname of your administrator-user.
725
+
726
+ Firstname that will correlate to the first administrator-user which will be created during the Shopware 5
727
+ installation.
728
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
729
+ is finished
730
+
731
+ --admin-lastname=<value> Lastname of your administrator-user.
732
+
733
+ Lastname that will correlate to the first administrator-user which will be created during the Shopware 5
734
+ installation.
735
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
736
+ finished
737
+
738
+ --admin-pass=<value> Password of your administrator-user.
739
+
740
+ Password that will correlate to the first administrator-user which will be created during the Shopware 5
741
+ installation.
742
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
743
+ installation is finished
744
+
745
+ --admin-user=<value> Username for your administrator-user.
746
+
747
+ Username of the first administrator-user which will be created during the Shopware 5 installation.
748
+ If not given an adequate username will be created from your mStudio Account Data.
749
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
750
+
751
+ --host=<value> Host to initially configure your Shopware 5 installation with; needs to be created separately.
752
+
753
+ Specify a host which will be used during the installation and as an initial host for the Shopware 5 configuration.
754
+ If not given the default host for the given Project will be used.
755
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Shopware
756
+ 5 installation.
757
+
758
+ --shop-currency=<value> Currency your Shopware 5 will be working with.
759
+
760
+ The default Currency your Shopware 5 shop communicates prices and calculates transactions with.
761
+ If not given will default to EUR(€). The currency can be changed after the installation is finished.
762
+
763
+ --shop-email=<value> E-Mail-Address your Shopware 5 will be working with.
764
+
765
+ The E-Mail-Address your Shopware 5 shop will be using for correspondence..
766
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
767
+ installation is finished.
768
+
769
+ --shop-lang=<value> Language your Shopware 5 will be working with.
770
+
771
+ The default Language your Shopware 5 shop will be using.
772
+ The Front- and Backend will be displayed using the given language.
773
+ If not given will default to German(de_DE). The language can be changed after the installation is finished.
774
+
775
+ --site-title=<value> Site Title for your Shopware 5 installation.
776
+
777
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Shopware 5 installation.
778
+ It is also the Title shown in the App-Overview in the mStudio.
779
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
780
+ installation is finished
781
+
782
+ --version=<value> Version of Shopware 5 to be installed.
783
+
784
+ Specify the Version in which your Shopware 5 will be installed.
785
+ If none is given the Shopware 5 will be installed in the latest available version.
786
+ ```
787
+
788
+ ## `mw app install shopware6`
789
+
790
+ Creates new Shopware 6 Installation.
791
+
792
+ ```
793
+ USAGE
794
+ $ mw app install shopware6 --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
795
+ <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>]
796
+ [--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
797
+
798
+ FLAGS
799
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
800
+ context
801
+ -q, --quiet suppress process output and only display a machine-readable summary.
802
+ -w, --wait Wait for your Shopware 6 to be ready.
803
+ --admin-email=<value> E-Mail-Address of your administrator-user.
804
+ --admin-firstname=<value> Firstname of your administrator-user.
805
+ --admin-lastname=<value> Lastname of your administrator-user.
806
+ --admin-pass=<value> Password of your administrator-user.
807
+ --admin-user=<value> Username for your administrator-user.
808
+ --host=<value> Host to initially configure your Shopware 6 installation with; needs to be created
809
+ separately.
810
+ --json
811
+ --shop-currency=<value> Currency your Shopware 6 will be working with.
812
+ --shop-email=<value> E-Mail-Address your Shopware 6 will be working with.
813
+ --shop-lang=<value> Language your Shopware 6 will be working with.
814
+ --site-title=<value> Site Title for your Shopware 6 installation.
815
+ --version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
816
+
817
+ DESCRIPTION
818
+ Creates new Shopware 6 Installation.
819
+
820
+ FLAG DESCRIPTIONS
821
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
822
+
823
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
824
+ to persistently set a default project for all commands that accept this flag.
825
+
826
+ -q, --quiet suppress process output and only display a machine-readable summary.
827
+
828
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
829
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
830
+
831
+ --admin-email=<value> E-Mail-Address of your administrator-user.
832
+
833
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Shopware 6
834
+ installation.
835
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
836
+ installation is finished.
837
+
838
+ --admin-firstname=<value> Firstname of your administrator-user.
839
+
840
+ Firstname that will correlate to the first administrator-user which will be created during the Shopware 6
841
+ installation.
842
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
843
+ is finished
844
+
845
+ --admin-lastname=<value> Lastname of your administrator-user.
846
+
847
+ Lastname that will correlate to the first administrator-user which will be created during the Shopware 6
848
+ installation.
849
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
850
+ finished
851
+
852
+ --admin-pass=<value> Password of your administrator-user.
853
+
854
+ Password that will correlate to the first administrator-user which will be created during the Shopware 6
855
+ installation.
856
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
857
+ installation is finished
858
+
859
+ --admin-user=<value> Username for your administrator-user.
860
+
861
+ Username of the first administrator-user which will be created during the Shopware 6 installation.
862
+ If not given an adequate username will be created from your mStudio Account Data.
863
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
864
+
865
+ --host=<value> Host to initially configure your Shopware 6 installation with; needs to be created separately.
866
+
867
+ Specify a host which will be used during the installation and as an initial host for the Shopware 6 configuration.
868
+ If not given the default host for the given Project will be used.
869
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Shopware
870
+ 6 installation.
871
+
872
+ --shop-currency=<value> Currency your Shopware 6 will be working with.
873
+
874
+ The default Currency your Shopware 6 shop communicates prices and calculates transactions with.
875
+ If not given will default to EUR(€). The currency can be changed after the installation is finished.
876
+
877
+ --shop-email=<value> E-Mail-Address your Shopware 6 will be working with.
878
+
879
+ The E-Mail-Address your Shopware 6 shop will be using for correspondence..
880
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
881
+ installation is finished.
882
+
883
+ --shop-lang=<value> Language your Shopware 6 will be working with.
884
+
885
+ The default Language your Shopware 6 shop will be using.
886
+ The Front- and Backend will be displayed using the given language.
887
+ If not given will default to German(de_DE). The language can be changed after the installation is finished.
888
+
889
+ --site-title=<value> Site Title for your Shopware 6 installation.
890
+
891
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Shopware 6 installation.
892
+ It is also the Title shown in the App-Overview in the mStudio.
893
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
894
+ installation is finished
895
+
896
+ --version=<value> Version of Shopware 6 to be installed.
897
+
898
+ Specify the Version in which your Shopware 6 will be installed.
899
+ If none is given the Shopware 6 will be installed in the latest available version.
900
+ ```
901
+
902
+ ## `mw app install typo3`
903
+
904
+ Creates new TYPO3 Installation.
905
+
906
+ ```
907
+ USAGE
908
+ $ mw app install typo3 --version <value> --install-mode composer|symlink [-p <value>] [-q] [--host <value>]
909
+ [--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
910
+
911
+ FLAGS
912
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
913
+ context
914
+ -q, --quiet suppress process output and only display a machine-readable summary.
915
+ -w, --wait Wait for your TYPO3 to be ready.
916
+ --admin-email=<value> E-Mail-Address of your administrator-user.
917
+ --admin-pass=<value> Password of your administrator-user.
918
+ --admin-user=<value> Username for your administrator-user.
919
+ --host=<value> Host to initially configure your TYPO3 installation with; needs to be created separately.
920
+ --install-mode=<option> (required) [default: composer] The installation variant your TYPO3 will be installed with.
921
+ <options: composer|symlink>
922
+ --json
923
+ --site-title=<value> Site Title for your TYPO3 installation.
924
+ --version=<value> (required) [default: latest] Version of TYPO3 to be installed.
925
+
926
+ DESCRIPTION
927
+ Creates new TYPO3 Installation.
928
+
929
+ FLAG DESCRIPTIONS
930
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
931
+
932
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
933
+ to persistently set a default project for all commands that accept this flag.
934
+
935
+ -q, --quiet suppress process output and only display a machine-readable summary.
936
+
937
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
938
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
939
+
940
+ --admin-email=<value> E-Mail-Address of your administrator-user.
941
+
942
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the TYPO3
943
+ installation.
944
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
945
+ installation is finished.
946
+
947
+ --admin-pass=<value> Password of your administrator-user.
948
+
949
+ Password that will correlate to the first administrator-user which will be created during the TYPO3 installation.
950
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
951
+ installation is finished
952
+
953
+ --admin-user=<value> Username for your administrator-user.
954
+
955
+ Username of the first administrator-user which will be created during the TYPO3 installation.
956
+ If not given an adequate username will be created from your mStudio Account Data.
957
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
958
+
959
+ --host=<value> Host to initially configure your TYPO3 installation with; needs to be created separately.
960
+
961
+ Specify a host which will be used during the installation and as an initial host for the TYPO3 configuration.
962
+ If not given the default host for the given Project will be used.
963
+ This does not change the target of the used Host and can be changed later by configuring the Host and your TYPO3
964
+ installation.
965
+
966
+ --install-mode=composer|symlink The installation variant your TYPO3 will be installed with.
967
+
968
+ TYPO3 can be installed in one of two different ways. your TYPO3 shop communicates prices and calculates
969
+ transactions with.
970
+ Either as a composer project or in a more manual fashion using the source directory and the TYPO3 console install
971
+ wizard.
972
+ If not given will default to composer installation. This can not be changed later.
973
+
974
+ --site-title=<value> Site Title for your TYPO3 installation.
975
+
976
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your TYPO3 installation.
977
+ It is also the Title shown in the App-Overview in the mStudio.
978
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
979
+ installation is finished
980
+
981
+ --version=<value> Version of TYPO3 to be installed.
982
+
983
+ Specify the Version in which your TYPO3 will be installed.
984
+ If none is given the TYPO3 will be installed in the latest available version.
985
+ ```
986
+
279
987
  ## `mw app install wordpress`
280
988
 
281
989
  Creates new WordPress Installation.
282
990
 
283
991
  ```
284
992
  USAGE
285
- $ mw app install wordpress --version <value> --host <value> --admin-user <value> --admin-email <value> --admin-pass
286
- <value> --site-title <value> [-p <value>] [-q] [-w]
993
+ $ mw app install wordpress --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
994
+ <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
287
995
 
288
996
  FLAGS
289
997
  -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
290
998
  context
291
999
  -q, --quiet suppress process output and only display a machine-readable summary.
292
- -w, --wait Wait for the App to be ready.
293
- --admin-email=<value> (required) First Admin Users E-Mail.
294
- --admin-pass=<value> (required) First Admin Users Password.
295
- --admin-user=<value> (required) First Admin User for the app.
296
- --host=<value> (required) Host under which the App will be available (Needs to be created separately).
297
- --site-title=<value> (required) Site Title of the created appInstallation.
298
- --version=<value> (required) [default: latest] Version of the App to be created - Defaults to latest
1000
+ -w, --wait Wait for your WordPress to be ready.
1001
+ --admin-email=<value> E-Mail-Address of your administrator-user.
1002
+ --admin-pass=<value> Password of your administrator-user.
1003
+ --admin-user=<value> Username for your administrator-user.
1004
+ --host=<value> Host to initially configure your WordPress installation with; needs to be created
1005
+ separately.
1006
+ --json
1007
+ --site-title=<value> Site Title for your WordPress installation.
1008
+ --version=<value> (required) [default: latest] Version of WordPress to be installed.
299
1009
 
300
1010
  DESCRIPTION
301
1011
  Creates new WordPress Installation.
@@ -310,6 +1020,45 @@ FLAG DESCRIPTIONS
310
1020
 
311
1021
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
312
1022
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
1023
+
1024
+ --admin-email=<value> E-Mail-Address of your administrator-user.
1025
+
1026
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the WordPress
1027
+ installation.
1028
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
1029
+ installation is finished.
1030
+
1031
+ --admin-pass=<value> Password of your administrator-user.
1032
+
1033
+ Password that will correlate to the first administrator-user which will be created during the WordPress
1034
+ installation.
1035
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
1036
+ installation is finished
1037
+
1038
+ --admin-user=<value> Username for your administrator-user.
1039
+
1040
+ Username of the first administrator-user which will be created during the WordPress installation.
1041
+ If not given an adequate username will be created from your mStudio Account Data.
1042
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
1043
+
1044
+ --host=<value> Host to initially configure your WordPress installation with; needs to be created separately.
1045
+
1046
+ Specify a host which will be used during the installation and as an initial host for the WordPress configuration.
1047
+ If not given the default host for the given Project will be used.
1048
+ This does not change the target of the used Host and can be changed later by configuring the Host and your WordPress
1049
+ installation.
1050
+
1051
+ --site-title=<value> Site Title for your WordPress installation.
1052
+
1053
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your WordPress installation.
1054
+ It is also the Title shown in the App-Overview in the mStudio.
1055
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
1056
+ installation is finished
1057
+
1058
+ --version=<value> Version of WordPress to be installed.
1059
+
1060
+ Specify the Version in which your WordPress will be installed.
1061
+ If none is given the WordPress will be installed in the latest available version.
313
1062
  ```
314
1063
 
315
1064
  ## `mw app list`
@@ -1850,23 +2599,122 @@ FLAG DESCRIPTIONS
1850
2599
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
1851
2600
  ```
1852
2601
 
1853
- ## `mw project backup get PROJECTBACKUPID`
2602
+ ## `mw project backup create`
1854
2603
 
1855
- Get a ProjectBackup.
2604
+ Create a new backup of a project
1856
2605
 
1857
2606
  ```
1858
2607
  USAGE
1859
- $ mw project backup get PROJECTBACKUPID [-o json|yaml | | ]
2608
+ $ mw project backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
2609
+
2610
+ FLAGS
2611
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
2612
+ context
2613
+ -q, --quiet suppress process output and only display a machine-readable summary.
2614
+ -w, --wait Wait for the resource to be ready.
2615
+ --description=<value> a description for the backup.
2616
+ --expires=<value> (required) An interval after which the backup expires (examples: 30m, 30d, 1y).
2617
+ --wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
2618
+
2619
+ FLAG DESCRIPTIONS
2620
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
2621
+
2622
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
2623
+ to persistently set a default project for all commands that accept this flag.
2624
+
2625
+ -q, --quiet suppress process output and only display a machine-readable summary.
2626
+
2627
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2628
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2629
+ ```
2630
+
2631
+ ## `mw project backup delete BACKUP-ID`
2632
+
2633
+ Delete a backup
2634
+
2635
+ ```
2636
+ USAGE
2637
+ $ mw project backup delete BACKUP-ID [-q] [-f]
2638
+
2639
+ ARGUMENTS
2640
+ BACKUP-ID The ID of the Backup to show.
2641
+
2642
+ FLAGS
2643
+ -f, --force Do not ask for confirmation
2644
+ -q, --quiet suppress process output and only display a machine-readable summary.
2645
+
2646
+ DESCRIPTION
2647
+ Delete a backup
2648
+
2649
+ FLAG DESCRIPTIONS
2650
+ -q, --quiet suppress process output and only display a machine-readable summary.
2651
+
2652
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2653
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2654
+ ```
2655
+
2656
+ ## `mw project backup download BACKUP-ID`
2657
+
2658
+ Download a backup to your local disk
2659
+
2660
+ ```
2661
+ USAGE
2662
+ $ mw project backup download BACKUP-ID [-q] [--format tar|zip] [--password <value> | --generate-password |
2663
+ --prompt-password] [--resume --output <value>]
2664
+
2665
+ ARGUMENTS
2666
+ BACKUP-ID the ID of the Backup to download.
2667
+
2668
+ FLAGS
2669
+ -q, --quiet suppress process output and only display a machine-readable summary.
2670
+ --format=<option> [default: tar] the file format to download the backup in.
2671
+ <options: tar|zip>
2672
+ --generate-password generate a random password to encrypt the backup with.
2673
+ --output=<value> the file to write the backup to; if omitted, the filename will be determined by the server.
2674
+ --password=<value> the password to encrypt the backup with.
2675
+ --prompt-password prompt for a password to encrypt the backup with.
2676
+ --resume resume a previously interrupted download.
2677
+
2678
+ DESCRIPTION
2679
+ Download a backup to your local disk
2680
+
2681
+ FLAG DESCRIPTIONS
2682
+ -q, --quiet suppress process output and only display a machine-readable summary.
2683
+
2684
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2685
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2686
+
2687
+ --generate-password generate a random password to encrypt the backup with.
2688
+
2689
+ CAUTION: this is not stored anywhere.
2690
+
2691
+ --password=<value> the password to encrypt the backup with.
2692
+
2693
+ CAUTION #1: this is not stored anywhere.
2694
+ CAUTION #2: it is dangerous to use this option, as the password might be stored in your shell history.
2695
+
2696
+ --prompt-password prompt for a password to encrypt the backup with.
2697
+
2698
+ CAUTION: this is not stored anywhere.
2699
+ ```
2700
+
2701
+ ## `mw project backup get BACKUP-ID`
2702
+
2703
+ show details of a backup.
2704
+
2705
+ ```
2706
+ USAGE
2707
+ $ mw project backup get BACKUP-ID [-o json|yaml | | ]
1860
2708
 
1861
2709
  ARGUMENTS
1862
- PROJECTBACKUPID ID of the ProjectBackup to retrieve.
2710
+ BACKUP-ID The ID of the Backup to show.
1863
2711
 
1864
2712
  FLAGS
1865
2713
  -o, --output=<option> output in a more machine friendly format
1866
2714
  <options: json|yaml>
1867
2715
 
1868
2716
  DESCRIPTION
1869
- Get a ProjectBackup.
2717
+ show details of a backup.
1870
2718
  ```
1871
2719
 
1872
2720
  ## `mw project backup list`
@@ -1901,67 +2749,56 @@ FLAG DESCRIPTIONS
1901
2749
  to persistently set a default project for all commands that accept this flag.
1902
2750
  ```
1903
2751
 
1904
- ## `mw project backupschedule get PROJECTBACKUPSCHEDULEID`
2752
+ ## `mw project backupschedule list`
1905
2753
 
1906
- Get a ProjectBackupSchedule.
2754
+ List backup schedules belonging to a given project.
1907
2755
 
1908
2756
  ```
1909
2757
  USAGE
1910
- $ mw project backupschedule get PROJECTBACKUPSCHEDULEID [-o json|yaml | | ]
1911
-
1912
- ARGUMENTS
1913
- PROJECTBACKUPSCHEDULEID ID of the ProjectBackupSchedule to retrieve.
2758
+ $ mw project backupschedule list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
2759
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1914
2760
 
1915
2761
  FLAGS
1916
- -o, --output=<option> output in a more machine friendly format
1917
- <options: json|yaml>
2762
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
2763
+ context
2764
+ -x, --extended show extra columns
2765
+ --columns=<value> only show provided columns (comma-separated)
2766
+ --csv output is csv format [alias: --output=csv]
2767
+ --filter=<value> filter property by partial string matching, ex: name=foo
2768
+ --no-header hide table header from output
2769
+ --no-truncate do not truncate output to fit screen
2770
+ --output=<option> output in a more machine friendly format
2771
+ <options: csv|json|yaml>
2772
+ --sort=<value> property to sort by (prepend '-' for descending)
1918
2773
 
1919
2774
  DESCRIPTION
1920
- Get a ProjectBackupSchedule.
1921
- ```
1922
-
1923
- ## `mw project backupschedule list`
1924
-
1925
- List BackupSchedules belonging to a given Project.
2775
+ List backup schedules belonging to a given project.
1926
2776
 
1927
- ```
1928
- USAGE
1929
- $ mw project backupschedule list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
1930
- csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
1931
-
1932
- FLAGS
1933
- -x, --extended show extra columns
1934
- --columns=<value> only show provided columns (comma-separated)
1935
- --csv output is csv format [alias: --output=csv]
1936
- --filter=<value> filter property by partial string matching, ex: name=foo
1937
- --no-header hide table header from output
1938
- --no-truncate do not truncate output to fit screen
1939
- --output=<option> output in a more machine friendly format
1940
- <options: csv|json|yaml>
1941
- --project-id=<value> (required) ID of the Project to list BackupSchedules for.
1942
- --sort=<value> property to sort by (prepend '-' for descending)
2777
+ FLAG DESCRIPTIONS
2778
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
1943
2779
 
1944
- DESCRIPTION
1945
- List BackupSchedules belonging to a given Project.
2780
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
2781
+ to persistently set a default project for all commands that accept this flag.
1946
2782
  ```
1947
2783
 
1948
2784
  ## `mw project create`
1949
2785
 
1950
- Get the details of a project
2786
+ Create a new project
1951
2787
 
1952
2788
  ```
1953
2789
  USAGE
1954
- $ mw project create -d <value> [-s <value>] [-q] [-w] [--update-context]
2790
+ $ mw project create -d <value> [-s <value>] [-q] [-w] [--wait-timeout <value>] [--update-context]
1955
2791
 
1956
2792
  FLAGS
1957
2793
  -d, --description=<value> (required) A description for the project.
1958
2794
  -q, --quiet suppress process output and only display a machine-readable summary.
1959
2795
  -s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the context
1960
- -w, --wait Wait for the project to be ready.
2796
+ -w, --wait Wait for the resource to be ready.
1961
2797
  --update-context Update the CLI context to use the newly created project
2798
+ --wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
1962
2799
 
1963
2800
  DESCRIPTION
1964
- Get the details of a project
2801
+ Create a new project
1965
2802
 
1966
2803
  FLAG DESCRIPTIONS
1967
2804
  -q, --quiet suppress process output and only display a machine-readable summary.
@@ -2143,7 +2980,7 @@ DESCRIPTION
2143
2980
 
2144
2981
  ## `mw project get [PROJECT-ID]`
2145
2982
 
2146
- Get a Project.
2983
+ Get details of a project
2147
2984
 
2148
2985
  ```
2149
2986
  USAGE
@@ -2157,7 +2994,7 @@ FLAGS
2157
2994
  <options: json|yaml>
2158
2995
 
2159
2996
  DESCRIPTION
2160
- Get a Project.
2997
+ Get details of a project
2161
2998
  ```
2162
2999
 
2163
3000
  ## `mw project invite get INVITEID`
@@ -2230,7 +3067,7 @@ DESCRIPTION
2230
3067
 
2231
3068
  ## `mw project list`
2232
3069
 
2233
- List Project's for an Organization or Server.
3070
+ List all projects that you have access to
2234
3071
 
2235
3072
  ```
2236
3073
  USAGE
@@ -2249,23 +3086,7 @@ FLAGS
2249
3086
  --sort=<value> property to sort by (prepend '-' for descending)
2250
3087
 
2251
3088
  DESCRIPTION
2252
- List Project's for an Organization or Server.
2253
- ```
2254
-
2255
- ## `mw project list-react`
2256
-
2257
- ```
2258
- USAGE
2259
- $ mw project list-react -o txt|json [--wait] [--columns <value> | ] [--extended] [--noTruncate]
2260
-
2261
- FLAGS
2262
- -o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
2263
- representation, and 'json' for a machine-readable JSON representation.
2264
- <options: txt|json>
2265
- --columns=<value> only show provided columns (comma-seperated)
2266
- --extended show extra columns
2267
- --noTruncate do not truncate output to fit screen
2268
- --wait
3089
+ List all projects that you have access to
2269
3090
  ```
2270
3091
 
2271
3092
  ## `mw project membership get MEMBERSHIPID`