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

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 (81) hide show
  1. package/README.md +889 -56
  2. package/dist/esm/commands/app/install/contao.d.ts +11 -0
  3. package/dist/esm/commands/app/install/contao.js +24 -0
  4. package/dist/esm/commands/app/install/joomla.d.ts +11 -0
  5. package/dist/esm/commands/app/install/joomla.js +23 -0
  6. package/dist/esm/commands/app/install/matomo.d.ts +11 -0
  7. package/dist/esm/commands/app/install/matomo.js +21 -0
  8. package/dist/esm/commands/app/install/node.d.ts +11 -0
  9. package/dist/esm/commands/app/install/node.js +13 -0
  10. package/dist/esm/commands/app/install/php.d.ts +11 -0
  11. package/dist/esm/commands/app/install/php.js +13 -0
  12. package/dist/esm/commands/app/install/shopware5.d.ts +11 -0
  13. package/dist/esm/commands/app/install/shopware5.js +26 -0
  14. package/dist/esm/commands/app/install/shopware6.d.ts +11 -0
  15. package/dist/esm/commands/app/install/shopware6.js +26 -0
  16. package/dist/esm/commands/app/install/typo3.d.ts +11 -0
  17. package/dist/esm/commands/app/install/typo3.js +22 -0
  18. package/dist/esm/commands/app/install/wordpress.d.ts +4 -16
  19. package/dist/esm/commands/app/install/wordpress.js +16 -107
  20. package/dist/esm/commands/app/versions.js +1 -1
  21. package/dist/esm/commands/org/invite.d.ts +1 -2
  22. package/dist/esm/commands/org/invite.js +3 -16
  23. package/dist/esm/commands/project/backup/create.d.ts +18 -0
  24. package/dist/esm/commands/project/backup/create.js +59 -0
  25. package/dist/esm/commands/project/backup/delete.d.ts +13 -0
  26. package/dist/esm/commands/project/backup/delete.js +21 -0
  27. package/dist/esm/commands/project/backup/download.d.ts +27 -0
  28. package/dist/esm/commands/project/backup/download.js +177 -0
  29. package/dist/esm/commands/project/backup/get.d.ts +11 -2
  30. package/dist/esm/commands/project/backup/get.js +26 -5
  31. package/dist/esm/commands/project/backup/list.d.ts +9 -9
  32. package/dist/esm/commands/project/backupschedule/list.d.ts +13 -7
  33. package/dist/esm/commands/project/backupschedule/list.js +15 -7
  34. package/dist/esm/commands/project/create.d.ts +2 -1
  35. package/dist/esm/commands/project/create.js +3 -6
  36. package/dist/esm/lib/app/Installer.d.ts +21 -0
  37. package/dist/esm/lib/app/Installer.js +49 -0
  38. package/dist/esm/lib/app/flags.d.ts +25 -0
  39. package/dist/esm/lib/app/flags.js +190 -1
  40. package/dist/esm/lib/app/install.d.ts +4 -0
  41. package/dist/esm/lib/app/install.js +20 -0
  42. package/dist/esm/lib/app/{appVersionHelpers.d.ts → versions.d.ts} +3 -0
  43. package/dist/esm/lib/app/{appVersionHelpers.js → versions.js} +18 -0
  44. package/dist/esm/lib/app/wait.d.ts +3 -0
  45. package/dist/esm/lib/app/wait.js +19 -0
  46. package/dist/esm/lib/expires.d.ts +11 -0
  47. package/dist/esm/lib/expires.js +31 -0
  48. package/dist/esm/lib/password.d.ts +2 -0
  49. package/dist/esm/lib/password.js +20 -0
  50. package/dist/esm/lib/project/hooks.d.ts +3 -0
  51. package/dist/esm/lib/project/hooks.js +11 -0
  52. package/dist/esm/lib/project/ingress.d.ts +2 -0
  53. package/dist/esm/lib/project/ingress.js +16 -0
  54. package/dist/esm/lib/project/shortId.d.ts +2 -0
  55. package/dist/esm/lib/project/shortId.js +11 -0
  56. package/dist/esm/lib/projectbackup/hooks.d.ts +5 -0
  57. package/dist/esm/lib/projectbackup/hooks.js +19 -0
  58. package/dist/esm/lib/viewhelpers/size.d.ts +2 -1
  59. package/dist/esm/lib/viewhelpers/size.js +2 -2
  60. package/dist/esm/lib/wait.d.ts +4 -0
  61. package/dist/esm/lib/wait.js +13 -2
  62. package/dist/esm/rendering/process/components/ProcessStateSummary.js +3 -0
  63. package/dist/esm/rendering/process/process.d.ts +2 -0
  64. package/dist/esm/rendering/process/process.js +4 -0
  65. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupDetails.d.ts +6 -0
  66. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupDetails.js +29 -0
  67. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupStatus.d.ts +6 -0
  68. package/dist/esm/rendering/react/components/ProjectBackup/ProjectBackupStatus.js +8 -0
  69. package/package.json +1 -1
  70. package/dist/esm/commands/project/backupschedule/get.d.ts +0 -3
  71. package/dist/esm/commands/project/backupschedule/get.js +0 -6
  72. package/dist/esm/generated/backup/getProjectBackup.d.ts +0 -16
  73. package/dist/esm/generated/backup/getProjectBackup.js +0 -25
  74. package/dist/esm/generated/backup/getProjectBackupSchedule.d.ts +0 -16
  75. package/dist/esm/generated/backup/getProjectBackupSchedule.js +0 -25
  76. package/dist/esm/generated/backup/listProjectBackupSchedules.d.ts +0 -13
  77. package/dist/esm/generated/backup/listProjectBackupSchedules.js +0 -24
  78. package/dist/esm/generated/backup/listProjectBackups.d.ts +0 -13
  79. package/dist/esm/generated/backup/listProjectBackups.js +0 -24
  80. /package/dist/esm/lib/app/{appHelpers.d.ts → uuid.d.ts} +0 -0
  81. /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)
@@ -276,26 +324,684 @@ DESCRIPTION
276
324
  Get details about an app installation
277
325
  ```
278
326
 
327
+ ## `mw app install contao`
328
+
329
+ Creates new Contao Installation.
330
+
331
+ ```
332
+ USAGE
333
+ $ mw app install contao --version <value> [-p <value>] [-q] [--host <value>] [--admin-firstname <value>] [--admin-user
334
+ <value>] [--admin-email <value>] [--admin-pass <value>] [--admin-lastname <value>] [--site-title <value>] [-w]
335
+ [--json]
336
+
337
+ FLAGS
338
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
339
+ context
340
+ -q, --quiet suppress process output and only display a machine-readable summary.
341
+ -w, --wait Wait for your Contao to be ready.
342
+ --admin-email=<value> E-Mail-Address of your administrator-user.
343
+ --admin-firstname=<value> Firstname of your administrator-user.
344
+ --admin-lastname=<value> Lastname of your administrator-user.
345
+ --admin-pass=<value> Password of your administrator-user.
346
+ --admin-user=<value> Username for your administrator-user.
347
+ --host=<value> Host to initially configure your Contao installation with; needs to be created separately.
348
+ --json
349
+ --site-title=<value> Site Title for your Contao installation.
350
+ --version=<value> (required) [default: latest] Version of Contao to be installed.
351
+
352
+ DESCRIPTION
353
+ Creates new Contao Installation.
354
+
355
+ FLAG DESCRIPTIONS
356
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
357
+
358
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
359
+ to persistently set a default project for all commands that accept this flag.
360
+
361
+ -q, --quiet suppress process output and only display a machine-readable summary.
362
+
363
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
364
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
365
+
366
+ --admin-email=<value> E-Mail-Address of your administrator-user.
367
+
368
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Contao
369
+ installation.
370
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
371
+ installation is finished.
372
+
373
+ --admin-firstname=<value> Firstname of your administrator-user.
374
+
375
+ Firstname that will correlate to the first administrator-user which will be created during the Contao installation.
376
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
377
+ is finished
378
+
379
+ --admin-lastname=<value> Lastname of your administrator-user.
380
+
381
+ Lastname that will correlate to the first administrator-user which will be created during the Contao installation.
382
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
383
+ finished
384
+
385
+ --admin-pass=<value> Password of your administrator-user.
386
+
387
+ Password that will correlate to the first administrator-user which will be created during the Contao installation.
388
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
389
+ installation is finished
390
+
391
+ --admin-user=<value> Username for your administrator-user.
392
+
393
+ Username of the first administrator-user which will be created during the Contao installation.
394
+ If not given an adequate username will be created from your mStudio Account Data.
395
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
396
+
397
+ --host=<value> Host to initially configure your Contao installation with; needs to be created separately.
398
+
399
+ Specify a host which will be used during the installation and as an initial host for the Contao configuration.
400
+ If not given the default host for the given Project will be used.
401
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Contao
402
+ installation.
403
+
404
+ --site-title=<value> Site Title for your Contao installation.
405
+
406
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Contao installation.
407
+ It is also the Title shown in the App-Overview in the mStudio.
408
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
409
+ installation is finished
410
+
411
+ --version=<value> Version of Contao to be installed.
412
+
413
+ Specify the Version in which your Contao will be installed.
414
+ If none is given the Contao will be installed in the latest available version.
415
+ ```
416
+
417
+ ## `mw app install joomla`
418
+
419
+ Creates new Joomla! Installation.
420
+
421
+ ```
422
+ USAGE
423
+ $ mw app install joomla --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
424
+ <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>] [-w]
425
+ [--json]
426
+
427
+ FLAGS
428
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
429
+ context
430
+ -q, --quiet suppress process output and only display a machine-readable summary.
431
+ -w, --wait Wait for your Joomla! to be ready.
432
+ --admin-email=<value> E-Mail-Address of your administrator-user.
433
+ --admin-firstname=<value> Firstname of your administrator-user.
434
+ --admin-lastname=<value> Lastname of your administrator-user.
435
+ --admin-pass=<value> Password of your administrator-user.
436
+ --admin-user=<value> Username for your administrator-user.
437
+ --host=<value> Host to initially configure your Joomla! installation with; needs to be created separately.
438
+ --json
439
+ --site-title=<value> Site Title for your Joomla! installation.
440
+ --version=<value> (required) [default: latest] Version of Joomla! to be installed.
441
+
442
+ DESCRIPTION
443
+ Creates new Joomla! Installation.
444
+
445
+ FLAG DESCRIPTIONS
446
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
447
+
448
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
449
+ to persistently set a default project for all commands that accept this flag.
450
+
451
+ -q, --quiet suppress process output and only display a machine-readable summary.
452
+
453
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
454
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
455
+
456
+ --admin-email=<value> E-Mail-Address of your administrator-user.
457
+
458
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Joomla!
459
+ installation.
460
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
461
+ installation is finished.
462
+
463
+ --admin-firstname=<value> Firstname of your administrator-user.
464
+
465
+ Firstname that will correlate to the first administrator-user which will be created during the Joomla! installation.
466
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
467
+ is finished
468
+
469
+ --admin-lastname=<value> Lastname of your administrator-user.
470
+
471
+ Lastname that will correlate to the first administrator-user which will be created during the Joomla! installation.
472
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
473
+ finished
474
+
475
+ --admin-pass=<value> Password of your administrator-user.
476
+
477
+ Password that will correlate to the first administrator-user which will be created during the Joomla! installation.
478
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
479
+ installation is finished
480
+
481
+ --admin-user=<value> Username for your administrator-user.
482
+
483
+ Username of the first administrator-user which will be created during the Joomla! installation.
484
+ If not given an adequate username will be created from your mStudio Account Data.
485
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
486
+
487
+ --host=<value> Host to initially configure your Joomla! installation with; needs to be created separately.
488
+
489
+ Specify a host which will be used during the installation and as an initial host for the Joomla! configuration.
490
+ If not given the default host for the given Project will be used.
491
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Joomla!
492
+ installation.
493
+
494
+ --site-title=<value> Site Title for your Joomla! installation.
495
+
496
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Joomla! installation.
497
+ It is also the Title shown in the App-Overview in the mStudio.
498
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
499
+ installation is finished
500
+
501
+ --version=<value> Version of Joomla! to be installed.
502
+
503
+ Specify the Version in which your Joomla! will be installed.
504
+ If none is given the Joomla! will be installed in the latest available version.
505
+ ```
506
+
507
+ ## `mw app install matomo`
508
+
509
+ Creates new Matomo Installation.
510
+
511
+ ```
512
+ USAGE
513
+ $ mw app install matomo --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
514
+ <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
515
+
516
+ FLAGS
517
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
518
+ context
519
+ -q, --quiet suppress process output and only display a machine-readable summary.
520
+ -w, --wait Wait for your Matomo to be ready.
521
+ --admin-email=<value> E-Mail-Address of your administrator-user.
522
+ --admin-pass=<value> Password of your administrator-user.
523
+ --admin-user=<value> Username for your administrator-user.
524
+ --host=<value> Host to initially configure your Matomo installation with; needs to be created separately.
525
+ --json
526
+ --site-title=<value> Site Title for your Matomo installation.
527
+ --version=<value> (required) [default: latest] Version of Matomo to be installed.
528
+
529
+ DESCRIPTION
530
+ Creates new Matomo Installation.
531
+
532
+ FLAG DESCRIPTIONS
533
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
534
+
535
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
536
+ to persistently set a default project for all commands that accept this flag.
537
+
538
+ -q, --quiet suppress process output and only display a machine-readable summary.
539
+
540
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
541
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
542
+
543
+ --admin-email=<value> E-Mail-Address of your administrator-user.
544
+
545
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Matomo
546
+ installation.
547
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
548
+ installation is finished.
549
+
550
+ --admin-pass=<value> Password of your administrator-user.
551
+
552
+ Password that will correlate to the first administrator-user which will be created during the Matomo installation.
553
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
554
+ installation is finished
555
+
556
+ --admin-user=<value> Username for your administrator-user.
557
+
558
+ Username of the first administrator-user which will be created during the Matomo installation.
559
+ If not given an adequate username will be created from your mStudio Account Data.
560
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
561
+
562
+ --host=<value> Host to initially configure your Matomo installation with; needs to be created separately.
563
+
564
+ Specify a host which will be used during the installation and as an initial host for the Matomo configuration.
565
+ If not given the default host for the given Project will be used.
566
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Matomo
567
+ installation.
568
+
569
+ --site-title=<value> Site Title for your Matomo installation.
570
+
571
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Matomo installation.
572
+ It is also the Title shown in the App-Overview in the mStudio.
573
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
574
+ installation is finished
575
+
576
+ --version=<value> Version of Matomo to be installed.
577
+
578
+ Specify the Version in which your Matomo will be installed.
579
+ If none is given the Matomo will be installed in the latest available version.
580
+ ```
581
+
582
+ ## `mw app install node`
583
+
584
+ Creates new Node.js Project Installation.
585
+
586
+ ```
587
+ USAGE
588
+ $ mw app install node --version <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
589
+
590
+ FLAGS
591
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
592
+ context
593
+ -q, --quiet suppress process output and only display a machine-readable summary.
594
+ -w, --wait Wait for your Node.js Project to be ready.
595
+ --json
596
+ --site-title=<value> Site Title for your Node.js Project installation.
597
+ --version=<value> (required) [default: latest] Version of Node.js Project to be installed.
598
+
599
+ DESCRIPTION
600
+ Creates new Node.js Project Installation.
601
+
602
+ FLAG DESCRIPTIONS
603
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
604
+
605
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
606
+ to persistently set a default project for all commands that accept this flag.
607
+
608
+ -q, --quiet suppress process output and only display a machine-readable summary.
609
+
610
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
611
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
612
+
613
+ --site-title=<value> Site Title for your Node.js Project installation.
614
+
615
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Node.js Project installation.
616
+ It is also the Title shown in the App-Overview in the mStudio.
617
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
618
+ installation is finished
619
+
620
+ --version=<value> Version of Node.js Project to be installed.
621
+
622
+ Specify the Version in which your Node.js Project will be installed.
623
+ If none is given the Node.js Project will be installed in the latest available version.
624
+ ```
625
+
626
+ ## `mw app install php`
627
+
628
+ Creates new PHP Project Installation.
629
+
630
+ ```
631
+ USAGE
632
+ $ mw app install php --version <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
633
+
634
+ FLAGS
635
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
636
+ context
637
+ -q, --quiet suppress process output and only display a machine-readable summary.
638
+ -w, --wait Wait for your PHP Project to be ready.
639
+ --json
640
+ --site-title=<value> Site Title for your PHP Project installation.
641
+ --version=<value> (required) [default: latest] Version of PHP Project to be installed.
642
+
643
+ DESCRIPTION
644
+ Creates new PHP Project Installation.
645
+
646
+ FLAG DESCRIPTIONS
647
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
648
+
649
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
650
+ to persistently set a default project for all commands that accept this flag.
651
+
652
+ -q, --quiet suppress process output and only display a machine-readable summary.
653
+
654
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
655
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
656
+
657
+ --site-title=<value> Site Title for your PHP Project installation.
658
+
659
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your PHP Project installation.
660
+ It is also the Title shown in the App-Overview in the mStudio.
661
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
662
+ installation is finished
663
+
664
+ --version=<value> Version of PHP Project to be installed.
665
+
666
+ Specify the Version in which your PHP Project will be installed.
667
+ If none is given the PHP Project will be installed in the latest available version.
668
+ ```
669
+
670
+ ## `mw app install shopware5`
671
+
672
+ Creates new Shopware 5 Installation.
673
+
674
+ ```
675
+ USAGE
676
+ $ mw app install shopware5 --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
677
+ <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>]
678
+ [--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
679
+
680
+ FLAGS
681
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
682
+ context
683
+ -q, --quiet suppress process output and only display a machine-readable summary.
684
+ -w, --wait Wait for your Shopware 5 to be ready.
685
+ --admin-email=<value> E-Mail-Address of your administrator-user.
686
+ --admin-firstname=<value> Firstname of your administrator-user.
687
+ --admin-lastname=<value> Lastname of your administrator-user.
688
+ --admin-pass=<value> Password of your administrator-user.
689
+ --admin-user=<value> Username for your administrator-user.
690
+ --host=<value> Host to initially configure your Shopware 5 installation with; needs to be created
691
+ separately.
692
+ --json
693
+ --shop-currency=<value> Currency your Shopware 5 will be working with.
694
+ --shop-email=<value> E-Mail-Address your Shopware 5 will be working with.
695
+ --shop-lang=<value> Language your Shopware 5 will be working with.
696
+ --site-title=<value> Site Title for your Shopware 5 installation.
697
+ --version=<value> (required) [default: latest] Version of Shopware 5 to be installed.
698
+
699
+ DESCRIPTION
700
+ Creates new Shopware 5 Installation.
701
+
702
+ FLAG DESCRIPTIONS
703
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
704
+
705
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
706
+ to persistently set a default project for all commands that accept this flag.
707
+
708
+ -q, --quiet suppress process output and only display a machine-readable summary.
709
+
710
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
711
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
712
+
713
+ --admin-email=<value> E-Mail-Address of your administrator-user.
714
+
715
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Shopware 5
716
+ installation.
717
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
718
+ installation is finished.
719
+
720
+ --admin-firstname=<value> Firstname of your administrator-user.
721
+
722
+ Firstname that will correlate to the first administrator-user which will be created during the Shopware 5
723
+ installation.
724
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
725
+ is finished
726
+
727
+ --admin-lastname=<value> Lastname of your administrator-user.
728
+
729
+ Lastname that will correlate to the first administrator-user which will be created during the Shopware 5
730
+ installation.
731
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
732
+ finished
733
+
734
+ --admin-pass=<value> Password of your administrator-user.
735
+
736
+ Password that will correlate to the first administrator-user which will be created during the Shopware 5
737
+ installation.
738
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
739
+ installation is finished
740
+
741
+ --admin-user=<value> Username for your administrator-user.
742
+
743
+ Username of the first administrator-user which will be created during the Shopware 5 installation.
744
+ If not given an adequate username will be created from your mStudio Account Data.
745
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
746
+
747
+ --host=<value> Host to initially configure your Shopware 5 installation with; needs to be created separately.
748
+
749
+ Specify a host which will be used during the installation and as an initial host for the Shopware 5 configuration.
750
+ If not given the default host for the given Project will be used.
751
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Shopware
752
+ 5 installation.
753
+
754
+ --shop-currency=<value> Currency your Shopware 5 will be working with.
755
+
756
+ The default Currency your Shopware 5 shop communicates prices and calculates transactions with.
757
+ If not given will default to EUR(€). The currency can be changed after the installation is finished.
758
+
759
+ --shop-email=<value> E-Mail-Address your Shopware 5 will be working with.
760
+
761
+ The E-Mail-Address your Shopware 5 shop will be using for correspondence..
762
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
763
+ installation is finished.
764
+
765
+ --shop-lang=<value> Language your Shopware 5 will be working with.
766
+
767
+ The default Language your Shopware 5 shop will be using.
768
+ The Front- and Backend will be displayed using the given language.
769
+ If not given will default to German(de_DE). The language can be changed after the installation is finished.
770
+
771
+ --site-title=<value> Site Title for your Shopware 5 installation.
772
+
773
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Shopware 5 installation.
774
+ It is also the Title shown in the App-Overview in the mStudio.
775
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
776
+ installation is finished
777
+
778
+ --version=<value> Version of Shopware 5 to be installed.
779
+
780
+ Specify the Version in which your Shopware 5 will be installed.
781
+ If none is given the Shopware 5 will be installed in the latest available version.
782
+ ```
783
+
784
+ ## `mw app install shopware6`
785
+
786
+ Creates new Shopware 6 Installation.
787
+
788
+ ```
789
+ USAGE
790
+ $ mw app install shopware6 --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
791
+ <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>]
792
+ [--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
793
+
794
+ FLAGS
795
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
796
+ context
797
+ -q, --quiet suppress process output and only display a machine-readable summary.
798
+ -w, --wait Wait for your Shopware 6 to be ready.
799
+ --admin-email=<value> E-Mail-Address of your administrator-user.
800
+ --admin-firstname=<value> Firstname of your administrator-user.
801
+ --admin-lastname=<value> Lastname of your administrator-user.
802
+ --admin-pass=<value> Password of your administrator-user.
803
+ --admin-user=<value> Username for your administrator-user.
804
+ --host=<value> Host to initially configure your Shopware 6 installation with; needs to be created
805
+ separately.
806
+ --json
807
+ --shop-currency=<value> Currency your Shopware 6 will be working with.
808
+ --shop-email=<value> E-Mail-Address your Shopware 6 will be working with.
809
+ --shop-lang=<value> Language your Shopware 6 will be working with.
810
+ --site-title=<value> Site Title for your Shopware 6 installation.
811
+ --version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
812
+
813
+ DESCRIPTION
814
+ Creates new Shopware 6 Installation.
815
+
816
+ FLAG DESCRIPTIONS
817
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
818
+
819
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
820
+ to persistently set a default project for all commands that accept this flag.
821
+
822
+ -q, --quiet suppress process output and only display a machine-readable summary.
823
+
824
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
825
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
826
+
827
+ --admin-email=<value> E-Mail-Address of your administrator-user.
828
+
829
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the Shopware 6
830
+ installation.
831
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
832
+ installation is finished.
833
+
834
+ --admin-firstname=<value> Firstname of your administrator-user.
835
+
836
+ Firstname that will correlate to the first administrator-user which will be created during the Shopware 6
837
+ installation.
838
+ If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
839
+ is finished
840
+
841
+ --admin-lastname=<value> Lastname of your administrator-user.
842
+
843
+ Lastname that will correlate to the first administrator-user which will be created during the Shopware 6
844
+ installation.
845
+ If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
846
+ finished
847
+
848
+ --admin-pass=<value> Password of your administrator-user.
849
+
850
+ Password that will correlate to the first administrator-user which will be created during the Shopware 6
851
+ installation.
852
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
853
+ installation is finished
854
+
855
+ --admin-user=<value> Username for your administrator-user.
856
+
857
+ Username of the first administrator-user which will be created during the Shopware 6 installation.
858
+ If not given an adequate username will be created from your mStudio Account Data.
859
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
860
+
861
+ --host=<value> Host to initially configure your Shopware 6 installation with; needs to be created separately.
862
+
863
+ Specify a host which will be used during the installation and as an initial host for the Shopware 6 configuration.
864
+ If not given the default host for the given Project will be used.
865
+ This does not change the target of the used Host and can be changed later by configuring the Host and your Shopware
866
+ 6 installation.
867
+
868
+ --shop-currency=<value> Currency your Shopware 6 will be working with.
869
+
870
+ The default Currency your Shopware 6 shop communicates prices and calculates transactions with.
871
+ If not given will default to EUR(€). The currency can be changed after the installation is finished.
872
+
873
+ --shop-email=<value> E-Mail-Address your Shopware 6 will be working with.
874
+
875
+ The E-Mail-Address your Shopware 6 shop will be using for correspondence..
876
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
877
+ installation is finished.
878
+
879
+ --shop-lang=<value> Language your Shopware 6 will be working with.
880
+
881
+ The default Language your Shopware 6 shop will be using.
882
+ The Front- and Backend will be displayed using the given language.
883
+ If not given will default to German(de_DE). The language can be changed after the installation is finished.
884
+
885
+ --site-title=<value> Site Title for your Shopware 6 installation.
886
+
887
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your Shopware 6 installation.
888
+ It is also the Title shown in the App-Overview in the mStudio.
889
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
890
+ installation is finished
891
+
892
+ --version=<value> Version of Shopware 6 to be installed.
893
+
894
+ Specify the Version in which your Shopware 6 will be installed.
895
+ If none is given the Shopware 6 will be installed in the latest available version.
896
+ ```
897
+
898
+ ## `mw app install typo3`
899
+
900
+ Creates new TYPO3 Installation.
901
+
902
+ ```
903
+ USAGE
904
+ $ mw app install typo3 --version <value> --install-mode composer|symlink [-p <value>] [-q] [--host <value>]
905
+ [--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
906
+
907
+ FLAGS
908
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
909
+ context
910
+ -q, --quiet suppress process output and only display a machine-readable summary.
911
+ -w, --wait Wait for your TYPO3 to be ready.
912
+ --admin-email=<value> E-Mail-Address of your administrator-user.
913
+ --admin-pass=<value> Password of your administrator-user.
914
+ --admin-user=<value> Username for your administrator-user.
915
+ --host=<value> Host to initially configure your TYPO3 installation with; needs to be created separately.
916
+ --install-mode=<option> (required) [default: composer] The installation variant your TYPO3 will be installed with.
917
+ <options: composer|symlink>
918
+ --json
919
+ --site-title=<value> Site Title for your TYPO3 installation.
920
+ --version=<value> (required) [default: latest] Version of TYPO3 to be installed.
921
+
922
+ DESCRIPTION
923
+ Creates new TYPO3 Installation.
924
+
925
+ FLAG DESCRIPTIONS
926
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
927
+
928
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
929
+ to persistently set a default project for all commands that accept this flag.
930
+
931
+ -q, --quiet suppress process output and only display a machine-readable summary.
932
+
933
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
934
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
935
+
936
+ --admin-email=<value> E-Mail-Address of your administrator-user.
937
+
938
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the TYPO3
939
+ installation.
940
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
941
+ installation is finished.
942
+
943
+ --admin-pass=<value> Password of your administrator-user.
944
+
945
+ Password that will correlate to the first administrator-user which will be created during the TYPO3 installation.
946
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
947
+ installation is finished
948
+
949
+ --admin-user=<value> Username for your administrator-user.
950
+
951
+ Username of the first administrator-user which will be created during the TYPO3 installation.
952
+ If not given an adequate username will be created from your mStudio Account Data.
953
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
954
+
955
+ --host=<value> Host to initially configure your TYPO3 installation with; needs to be created separately.
956
+
957
+ Specify a host which will be used during the installation and as an initial host for the TYPO3 configuration.
958
+ If not given the default host for the given Project will be used.
959
+ This does not change the target of the used Host and can be changed later by configuring the Host and your TYPO3
960
+ installation.
961
+
962
+ --install-mode=composer|symlink The installation variant your TYPO3 will be installed with.
963
+
964
+ TYPO3 can be installed in one of two different ways. your TYPO3 shop communicates prices and calculates
965
+ transactions with.
966
+ Either as a composer project or in a more manual fashion using the source directory and the TYPO3 console install
967
+ wizard.
968
+ If not given will default to composer installation. This can not be changed later.
969
+
970
+ --site-title=<value> Site Title for your TYPO3 installation.
971
+
972
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your TYPO3 installation.
973
+ It is also the Title shown in the App-Overview in the mStudio.
974
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
975
+ installation is finished
976
+
977
+ --version=<value> Version of TYPO3 to be installed.
978
+
979
+ Specify the Version in which your TYPO3 will be installed.
980
+ If none is given the TYPO3 will be installed in the latest available version.
981
+ ```
982
+
279
983
  ## `mw app install wordpress`
280
984
 
281
985
  Creates new WordPress Installation.
282
986
 
283
987
  ```
284
988
  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]
989
+ $ mw app install wordpress --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
990
+ <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
287
991
 
288
992
  FLAGS
289
993
  -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
290
994
  context
291
995
  -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
996
+ -w, --wait Wait for your WordPress to be ready.
997
+ --admin-email=<value> E-Mail-Address of your administrator-user.
998
+ --admin-pass=<value> Password of your administrator-user.
999
+ --admin-user=<value> Username for your administrator-user.
1000
+ --host=<value> Host to initially configure your WordPress installation with; needs to be created
1001
+ separately.
1002
+ --json
1003
+ --site-title=<value> Site Title for your WordPress installation.
1004
+ --version=<value> (required) [default: latest] Version of WordPress to be installed.
299
1005
 
300
1006
  DESCRIPTION
301
1007
  Creates new WordPress Installation.
@@ -310,6 +1016,45 @@ FLAG DESCRIPTIONS
310
1016
 
311
1017
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
312
1018
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
1019
+
1020
+ --admin-email=<value> E-Mail-Address of your administrator-user.
1021
+
1022
+ E-Mail-Address that will correlate to the first administrator-user which will be created during the WordPress
1023
+ installation.
1024
+ If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
1025
+ installation is finished.
1026
+
1027
+ --admin-pass=<value> Password of your administrator-user.
1028
+
1029
+ Password that will correlate to the first administrator-user which will be created during the WordPress
1030
+ installation.
1031
+ If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
1032
+ installation is finished
1033
+
1034
+ --admin-user=<value> Username for your administrator-user.
1035
+
1036
+ Username of the first administrator-user which will be created during the WordPress installation.
1037
+ If not given an adequate username will be created from your mStudio Account Data.
1038
+ After the installation is finished the Username can be changed and additional administrator-users can be created.
1039
+
1040
+ --host=<value> Host to initially configure your WordPress installation with; needs to be created separately.
1041
+
1042
+ Specify a host which will be used during the installation and as an initial host for the WordPress configuration.
1043
+ If not given the default host for the given Project will be used.
1044
+ This does not change the target of the used Host and can be changed later by configuring the Host and your WordPress
1045
+ installation.
1046
+
1047
+ --site-title=<value> Site Title for your WordPress installation.
1048
+
1049
+ Site Title which will be displayed in the Tab and at the top of the Frontend of your WordPress installation.
1050
+ It is also the Title shown in the App-Overview in the mStudio.
1051
+ If none is given the Software Name and the given Project will be used. The Title can be changed after the
1052
+ installation is finished
1053
+
1054
+ --version=<value> Version of WordPress to be installed.
1055
+
1056
+ Specify the Version in which your WordPress will be installed.
1057
+ If none is given the WordPress will be installed in the latest available version.
313
1058
  ```
314
1059
 
315
1060
  ## `mw app list`
@@ -1850,23 +2595,122 @@ FLAG DESCRIPTIONS
1850
2595
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
1851
2596
  ```
1852
2597
 
1853
- ## `mw project backup get PROJECTBACKUPID`
2598
+ ## `mw project backup create`
1854
2599
 
1855
- Get a ProjectBackup.
2600
+ Create a new backup of a project
1856
2601
 
1857
2602
  ```
1858
2603
  USAGE
1859
- $ mw project backup get PROJECTBACKUPID [-o json|yaml | | ]
2604
+ $ mw project backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
2605
+
2606
+ FLAGS
2607
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
2608
+ context
2609
+ -q, --quiet suppress process output and only display a machine-readable summary.
2610
+ -w, --wait Wait for the resource to be ready.
2611
+ --description=<value> a description for the backup.
2612
+ --expires=<value> (required) An interval after which the backup expires (examples: 30m, 30d, 1y).
2613
+ --wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
2614
+
2615
+ FLAG DESCRIPTIONS
2616
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
2617
+
2618
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
2619
+ to persistently set a default project for all commands that accept this flag.
2620
+
2621
+ -q, --quiet suppress process output and only display a machine-readable summary.
2622
+
2623
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2624
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2625
+ ```
2626
+
2627
+ ## `mw project backup delete BACKUP-ID`
2628
+
2629
+ Delete a backup
2630
+
2631
+ ```
2632
+ USAGE
2633
+ $ mw project backup delete BACKUP-ID [-q] [-f]
2634
+
2635
+ ARGUMENTS
2636
+ BACKUP-ID The ID of the Backup to show.
2637
+
2638
+ FLAGS
2639
+ -f, --force Do not ask for confirmation
2640
+ -q, --quiet suppress process output and only display a machine-readable summary.
2641
+
2642
+ DESCRIPTION
2643
+ Delete a backup
2644
+
2645
+ FLAG DESCRIPTIONS
2646
+ -q, --quiet suppress process output and only display a machine-readable summary.
2647
+
2648
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2649
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2650
+ ```
2651
+
2652
+ ## `mw project backup download BACKUP-ID`
2653
+
2654
+ Download a backup to your local disk
2655
+
2656
+ ```
2657
+ USAGE
2658
+ $ mw project backup download BACKUP-ID [-q] [--format tar|zip] [--password <value> | --generate-password |
2659
+ --prompt-password] [--resume --output <value>]
1860
2660
 
1861
2661
  ARGUMENTS
1862
- PROJECTBACKUPID ID of the ProjectBackup to retrieve.
2662
+ BACKUP-ID the ID of the Backup to download.
2663
+
2664
+ FLAGS
2665
+ -q, --quiet suppress process output and only display a machine-readable summary.
2666
+ --format=<option> [default: tar] the file format to download the backup in.
2667
+ <options: tar|zip>
2668
+ --generate-password generate a random password to encrypt the backup with.
2669
+ --output=<value> the file to write the backup to; if omitted, the filename will be determined by the server.
2670
+ --password=<value> the password to encrypt the backup with.
2671
+ --prompt-password prompt for a password to encrypt the backup with.
2672
+ --resume resume a previously interrupted download.
2673
+
2674
+ DESCRIPTION
2675
+ Download a backup to your local disk
2676
+
2677
+ FLAG DESCRIPTIONS
2678
+ -q, --quiet suppress process output and only display a machine-readable summary.
2679
+
2680
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2681
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2682
+
2683
+ --generate-password generate a random password to encrypt the backup with.
2684
+
2685
+ CAUTION: this is not stored anywhere.
2686
+
2687
+ --password=<value> the password to encrypt the backup with.
2688
+
2689
+ CAUTION #1: this is not stored anywhere.
2690
+ CAUTION #2: it is dangerous to use this option, as the password might be stored in your shell history.
2691
+
2692
+ --prompt-password prompt for a password to encrypt the backup with.
2693
+
2694
+ CAUTION: this is not stored anywhere.
2695
+ ```
2696
+
2697
+ ## `mw project backup get BACKUP-ID`
2698
+
2699
+ show details of a backup.
2700
+
2701
+ ```
2702
+ USAGE
2703
+ $ mw project backup get BACKUP-ID [-o json|yaml | | ]
2704
+
2705
+ ARGUMENTS
2706
+ BACKUP-ID The ID of the Backup to show.
1863
2707
 
1864
2708
  FLAGS
1865
2709
  -o, --output=<option> output in a more machine friendly format
1866
2710
  <options: json|yaml>
1867
2711
 
1868
2712
  DESCRIPTION
1869
- Get a ProjectBackup.
2713
+ show details of a backup.
1870
2714
  ```
1871
2715
 
1872
2716
  ## `mw project backup list`
@@ -1901,48 +2745,36 @@ FLAG DESCRIPTIONS
1901
2745
  to persistently set a default project for all commands that accept this flag.
1902
2746
  ```
1903
2747
 
1904
- ## `mw project backupschedule get PROJECTBACKUPSCHEDULEID`
2748
+ ## `mw project backupschedule list`
1905
2749
 
1906
- Get a ProjectBackupSchedule.
2750
+ List backup schedules belonging to a given project.
1907
2751
 
1908
2752
  ```
1909
2753
  USAGE
1910
- $ mw project backupschedule get PROJECTBACKUPSCHEDULEID [-o json|yaml | | ]
1911
-
1912
- ARGUMENTS
1913
- PROJECTBACKUPSCHEDULEID ID of the ProjectBackupSchedule to retrieve.
2754
+ $ mw project backupschedule list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
2755
+ [--csv | --no-truncate]] [--no-header | ] [-p <value>]
1914
2756
 
1915
2757
  FLAGS
1916
- -o, --output=<option> output in a more machine friendly format
1917
- <options: json|yaml>
2758
+ -p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
2759
+ context
2760
+ -x, --extended show extra columns
2761
+ --columns=<value> only show provided columns (comma-separated)
2762
+ --csv output is csv format [alias: --output=csv]
2763
+ --filter=<value> filter property by partial string matching, ex: name=foo
2764
+ --no-header hide table header from output
2765
+ --no-truncate do not truncate output to fit screen
2766
+ --output=<option> output in a more machine friendly format
2767
+ <options: csv|json|yaml>
2768
+ --sort=<value> property to sort by (prepend '-' for descending)
1918
2769
 
1919
2770
  DESCRIPTION
1920
- Get a ProjectBackupSchedule.
1921
- ```
1922
-
1923
- ## `mw project backupschedule list`
1924
-
1925
- List BackupSchedules belonging to a given Project.
2771
+ List backup schedules belonging to a given project.
1926
2772
 
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)
2773
+ FLAG DESCRIPTIONS
2774
+ -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
2775
 
1944
- DESCRIPTION
1945
- List BackupSchedules belonging to a given Project.
2776
+ May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
2777
+ to persistently set a default project for all commands that accept this flag.
1946
2778
  ```
1947
2779
 
1948
2780
  ## `mw project create`
@@ -1951,14 +2783,15 @@ Get the details of a project
1951
2783
 
1952
2784
  ```
1953
2785
  USAGE
1954
- $ mw project create -d <value> [-s <value>] [-q] [-w] [--update-context]
2786
+ $ mw project create -d <value> [-s <value>] [-q] [-w] [--wait-timeout <value>] [--update-context]
1955
2787
 
1956
2788
  FLAGS
1957
2789
  -d, --description=<value> (required) A description for the project.
1958
2790
  -q, --quiet suppress process output and only display a machine-readable summary.
1959
2791
  -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.
2792
+ -w, --wait Wait for the resource to be ready.
1961
2793
  --update-context Update the CLI context to use the newly created project
2794
+ --wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
1962
2795
 
1963
2796
  DESCRIPTION
1964
2797
  Get the details of a project