@mittwald/cli 1.0.0-alpha.41 → 1.0.0-alpha.43

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 (88) hide show
  1. package/README.md +457 -42
  2. package/dist/commands/app/download.d.ts +2 -0
  3. package/dist/commands/app/download.js +9 -2
  4. package/dist/commands/app/list.js +2 -3
  5. package/dist/commands/app/ssh.d.ts +2 -0
  6. package/dist/commands/app/ssh.js +22 -10
  7. package/dist/commands/app/upload.d.ts +19 -0
  8. package/dist/commands/app/upload.js +76 -0
  9. package/dist/commands/database/mysql/dump.d.ts +3 -2
  10. package/dist/commands/database/mysql/dump.js +21 -56
  11. package/dist/commands/database/mysql/import.d.ts +21 -0
  12. package/dist/commands/database/mysql/import.js +72 -0
  13. package/dist/commands/database/mysql/port-forward.d.ts +2 -0
  14. package/dist/commands/database/mysql/port-forward.js +9 -11
  15. package/dist/commands/database/mysql/shell.d.ts +3 -0
  16. package/dist/commands/database/mysql/shell.js +14 -15
  17. package/dist/commands/database/redis/shell.d.ts +3 -0
  18. package/dist/commands/database/redis/shell.js +15 -4
  19. package/dist/commands/ddev/init.js +5 -3
  20. package/dist/commands/domain/dnszone/list.js +1 -1
  21. package/dist/commands/domain/dnszone/update.js +1 -1
  22. package/dist/commands/domain/virtualhost/create.js +1 -1
  23. package/dist/commands/mail/address/create.d.ts +1 -1
  24. package/dist/commands/mail/address/create.js +6 -6
  25. package/dist/commands/mail/address/get.js +1 -1
  26. package/dist/commands/mail/address/list.js +1 -1
  27. package/dist/commands/mail/address/update.d.ts +35 -0
  28. package/dist/commands/mail/address/update.js +169 -0
  29. package/dist/commands/mail/deliverybox/get.js +1 -1
  30. package/dist/commands/mail/deliverybox/list.js +1 -1
  31. package/dist/commands/project/ssh.d.ts +5 -0
  32. package/dist/commands/project/ssh.js +12 -12
  33. package/dist/lib/app/custom_installation.d.ts +7 -0
  34. package/dist/lib/app/custom_installation.js +16 -0
  35. package/dist/lib/app/flags.js +4 -0
  36. package/dist/lib/context.d.ts +1 -1
  37. package/dist/lib/context_flags.d.ts +4 -0
  38. package/dist/lib/context_flags.js +14 -1
  39. package/dist/lib/database/mysql/connect.d.ts +22 -14
  40. package/dist/lib/database/mysql/connect.js +15 -0
  41. package/dist/lib/database/mysql/flags.d.ts +4 -0
  42. package/dist/lib/database/mysql/flags.js +10 -0
  43. package/dist/lib/database/mysql/temp_user.d.ts +13 -0
  44. package/dist/lib/database/mysql/temp_user.js +52 -0
  45. package/dist/lib/database/redis/connect.d.ts +1 -1
  46. package/dist/lib/database/redis/connect.js +5 -6
  47. package/dist/lib/ddev/config_builder.js +5 -18
  48. package/dist/lib/ddev/flags.js +2 -0
  49. package/dist/lib/ddev/init_projecttype.d.ts +32 -0
  50. package/dist/lib/ddev/init_projecttype.js +102 -0
  51. package/dist/lib/error/UnexpectedShortIDPassedError.d.ts +5 -0
  52. package/dist/lib/error/UnexpectedShortIDPassedError.js +10 -0
  53. package/dist/lib/language.d.ts +10 -0
  54. package/dist/lib/language.js +12 -0
  55. package/dist/lib/mail/flags.d.ts +1 -0
  56. package/dist/lib/mail/flags.js +20 -0
  57. package/dist/lib/project/flags.js +9 -2
  58. package/dist/lib/ssh/connection.d.ts +22 -0
  59. package/dist/lib/ssh/connection.js +19 -0
  60. package/dist/lib/ssh/doc.d.ts +10 -0
  61. package/dist/lib/ssh/doc.js +14 -0
  62. package/dist/lib/ssh/exec.d.ts +6 -1
  63. package/dist/lib/ssh/exec.js +8 -5
  64. package/dist/lib/ssh/flags.d.ts +6 -1
  65. package/dist/lib/ssh/flags.js +11 -0
  66. package/dist/rendering/react/RenderBaseCommand.js +12 -5
  67. package/dist/rendering/react/components/AppInstallation/AppInstallationDetails.js +2 -4
  68. package/dist/rendering/react/components/Error/APIError.d.ts +13 -0
  69. package/dist/rendering/react/components/Error/APIError.js +29 -0
  70. package/dist/rendering/react/components/Error/ErrorBox.d.ts +4 -0
  71. package/dist/rendering/react/components/Error/ErrorBox.js +14 -0
  72. package/dist/rendering/react/components/Error/ErrorStack.d.ts +4 -0
  73. package/dist/rendering/react/components/Error/ErrorStack.js +7 -0
  74. package/dist/rendering/react/components/Error/ErrorText.d.ts +3 -0
  75. package/dist/rendering/react/components/Error/ErrorText.js +6 -0
  76. package/dist/rendering/react/components/Error/GenericError.d.ts +12 -0
  77. package/dist/rendering/react/components/Error/GenericError.js +13 -0
  78. package/dist/rendering/react/components/Error/InvalidArgsError.d.ts +5 -0
  79. package/dist/rendering/react/components/Error/InvalidArgsError.js +8 -0
  80. package/dist/rendering/react/components/Error/InvalidFlagsError.d.ts +5 -0
  81. package/dist/rendering/react/components/Error/InvalidFlagsError.js +8 -0
  82. package/dist/rendering/react/components/Error/UnexpectedShortIDPassedErrorBox.d.ts +4 -0
  83. package/dist/rendering/react/components/Error/UnexpectedShortIDPassedErrorBox.js +7 -0
  84. package/dist/rendering/react/components/ErrorBoundary.d.ts +20 -0
  85. package/dist/rendering/react/components/ErrorBoundary.js +32 -0
  86. package/dist/rendering/react/components/ErrorBox.d.ts +0 -1
  87. package/dist/rendering/react/components/ErrorBox.js +12 -48
  88. package/package.json +1 -1
package/README.md CHANGED
@@ -138,6 +138,7 @@ USAGE
138
138
  * [`mw app list`](#mw-app-list)
139
139
  * [`mw app ssh [INSTALLATION-ID]`](#mw-app-ssh-installation-id)
140
140
  * [`mw app uninstall [INSTALLATION-ID]`](#mw-app-uninstall-installation-id)
141
+ * [`mw app upload [INSTALLATION-ID]`](#mw-app-upload-installation-id)
141
142
  * [`mw app versions [APP]`](#mw-app-versions-app)
142
143
  * [`mw autocomplete [SHELL]`](#mw-autocomplete-shell)
143
144
  * [`mw backup create`](#mw-backup-create)
@@ -170,6 +171,7 @@ USAGE
170
171
  * [`mw database mysql delete DATABASE-ID`](#mw-database-mysql-delete-database-id)
171
172
  * [`mw database mysql dump DATABASE-ID`](#mw-database-mysql-dump-database-id)
172
173
  * [`mw database mysql get DATABASE-ID`](#mw-database-mysql-get-database-id)
174
+ * [`mw database mysql import DATABASE-ID`](#mw-database-mysql-import-database-id)
173
175
  * [`mw database mysql list`](#mw-database-mysql-list)
174
176
  * [`mw database mysql phpmyadmin DATABASE-ID`](#mw-database-mysql-phpmyadmin-database-id)
175
177
  * [`mw database mysql port-forward DATABASE-ID`](#mw-database-mysql-port-forward-database-id)
@@ -202,6 +204,7 @@ USAGE
202
204
  * [`mw mail address delete ID`](#mw-mail-address-delete-id)
203
205
  * [`mw mail address get ID`](#mw-mail-address-get-id)
204
206
  * [`mw mail address list`](#mw-mail-address-list)
207
+ * [`mw mail address update MAILADDRESS-ID`](#mw-mail-address-update-mailaddress-id)
205
208
  * [`mw mail deliverybox get ID`](#mw-mail-deliverybox-get-id)
206
209
  * [`mw mail deliverybox list`](#mw-mail-deliverybox-list)
207
210
  * [`mw org delete [ORG-ID]`](#mw-org-delete-org-id)
@@ -560,28 +563,51 @@ Download the filesystem of an app within a project to your local machine
560
563
 
561
564
  ```
562
565
  USAGE
563
- $ mw app download [INSTALLATION-ID] --target <value> [-q] [--ssh-user <value>] [--dry-run] [--delete]
566
+ $ mw app download [INSTALLATION-ID] --target <value> [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
567
+ [--dry-run] [--delete]
564
568
 
565
569
  ARGUMENTS
566
570
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
567
571
  in the context
568
572
 
569
573
  FLAGS
570
- -q, --quiet suppress process output and only display a machine-readable summary.
571
- --delete delete local files that are not present on the server
572
- --dry-run do not actually download the app installation
573
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
574
- --target=<value> (required) target directory to download the app installation to
574
+ -q, --quiet suppress process output and only display a machine-readable summary.
575
+ --delete delete local files that are not present on the server
576
+ --dry-run do not actually download the app installation
577
+ --target=<value> (required) target directory to download the app installation to
578
+
579
+ SSH CONNECTION FLAGS
580
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
581
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
575
582
 
576
583
  DESCRIPTION
577
584
  Download the filesystem of an app within a project to your local machine
578
585
 
586
+ This command downloads the filesystem of an app installation to your local machine via rsync.
587
+
588
+ For this, rsync needs to be installed on your system.
589
+
590
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
591
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
592
+
593
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
594
+ authenticated mStudio user or the user specified with the --ssh-user flag.
595
+
596
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
597
+
579
598
  FLAG DESCRIPTIONS
580
599
  -q, --quiet suppress process output and only display a machine-readable summary.
581
600
 
582
601
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
583
602
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
584
603
 
604
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
605
+
606
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
607
+ authenticate the connection to the server.
608
+
609
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
610
+
585
611
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
586
612
 
587
613
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -1731,22 +1757,41 @@ Connect to an app via SSH
1731
1757
 
1732
1758
  ```
1733
1759
  USAGE
1734
- $ mw app ssh [INSTALLATION-ID] [--ssh-user <value>] [--cd] [--info] [--test]
1760
+ $ mw app ssh [INSTALLATION-ID] [--ssh-user <value>] [--ssh-identity-file <value>] [--cd] [--info] [--test]
1735
1761
 
1736
1762
  ARGUMENTS
1737
1763
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
1738
1764
  in the context
1739
1765
 
1740
1766
  FLAGS
1741
- --[no-]cd change to installation path after connecting
1742
- --info only print connection information, without actually connecting
1743
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1744
- --test test connection and exit
1767
+ --[no-]cd change to installation path after connecting
1768
+ --info only print connection information, without actually connecting
1769
+ --test test connection and exit
1770
+
1771
+ SSH CONNECTION FLAGS
1772
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
1773
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1745
1774
 
1746
1775
  DESCRIPTION
1747
1776
  Connect to an app via SSH
1748
1777
 
1778
+ Establishes an interactive SSH connection to an app installation.
1779
+
1780
+ This command is a wrapper around your systems SSH client, and will respect your SSH configuration in ~/.ssh/config.
1781
+
1782
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
1783
+ authenticated mStudio user or the user specified with the --ssh-user flag.
1784
+
1785
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
1786
+
1749
1787
  FLAG DESCRIPTIONS
1788
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
1789
+
1790
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
1791
+ authenticate the connection to the server.
1792
+
1793
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
1794
+
1750
1795
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1751
1796
 
1752
1797
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -1781,6 +1826,68 @@ FLAG DESCRIPTIONS
1781
1826
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
1782
1827
  ```
1783
1828
 
1829
+ ## `mw app upload [INSTALLATION-ID]`
1830
+
1831
+ Upload the filesystem of an app to a project
1832
+
1833
+ ```
1834
+ USAGE
1835
+ $ mw app upload [INSTALLATION-ID] --source <value> [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
1836
+ [--dry-run] [--delete]
1837
+
1838
+ ARGUMENTS
1839
+ INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
1840
+ in the context
1841
+
1842
+ FLAGS
1843
+ -q, --quiet suppress process output and only display a machine-readable summary.
1844
+ --delete delete remote files that are not present locally
1845
+ --dry-run do not actually upload the app installation
1846
+ --source=<value> (required) source directory from which to upload the app installation
1847
+
1848
+ SSH CONNECTION FLAGS
1849
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
1850
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1851
+
1852
+ DESCRIPTION
1853
+ Upload the filesystem of an app to a project
1854
+
1855
+ Upload the filesystem of an app from your local machine to a project.
1856
+
1857
+ For this, rsync needs to be installed on your system.
1858
+
1859
+ CAUTION: This is a potentially destructive operation. It will overwrite files on the server with the files from your
1860
+ local machine. This is NOT a turnkey deployment solution. It is intended for development purposes only.
1861
+
1862
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
1863
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
1864
+
1865
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
1866
+ authenticated mStudio user or the user specified with the --ssh-user flag.
1867
+
1868
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
1869
+
1870
+ FLAG DESCRIPTIONS
1871
+ -q, --quiet suppress process output and only display a machine-readable summary.
1872
+
1873
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1874
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
1875
+
1876
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
1877
+
1878
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
1879
+ authenticate the connection to the server.
1880
+
1881
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
1882
+
1883
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1884
+
1885
+ This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
1886
+ will be used for this.
1887
+
1888
+ You can also set this value by setting the MITTWALD_SSH_USER environment variable.
1889
+ ```
1890
+
1784
1891
  ## `mw app versions [APP]`
1785
1892
 
1786
1893
  List supported Apps and Versions
@@ -1825,7 +1932,7 @@ EXAMPLES
1825
1932
  $ mw autocomplete --refresh-cache
1826
1933
  ```
1827
1934
 
1828
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.13/src/commands/autocomplete/index.ts)_
1935
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.16/src/commands/autocomplete/index.ts)_
1829
1936
 
1830
1937
  ## `mw backup create`
1831
1938
 
@@ -2540,7 +2647,8 @@ Create a dump of a MySQL database
2540
2647
 
2541
2648
  ```
2542
2649
  USAGE
2543
- $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--ssh-user <value>] [--temporary-user] [--gzip]
2650
+ $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--temporary-user] [--ssh-user <value>]
2651
+ [--ssh-identity-file <value>] [--gzip]
2544
2652
 
2545
2653
  ARGUMENTS
2546
2654
  DATABASE-ID The ID or name of the database
@@ -2550,9 +2658,25 @@ FLAGS
2550
2658
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2551
2659
  -q, --quiet suppress process output and only display a machine-readable summary.
2552
2660
  --gzip compress the dump with gzip
2553
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2554
2661
  --[no-]temporary-user create a temporary user for the dump
2555
2662
 
2663
+ SSH CONNECTION FLAGS
2664
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2665
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2666
+
2667
+ DESCRIPTION
2668
+ Create a dump of a MySQL database
2669
+
2670
+ This command creates a dump of a MySQL database via mysqldump and saves it to a local file.
2671
+
2672
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
2673
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
2674
+
2675
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
2676
+ authenticated mStudio user or the user specified with the --ssh-user flag.
2677
+
2678
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
2679
+
2556
2680
  FLAG DESCRIPTIONS
2557
2681
  -o, --output=<value> the output file to write the dump to ("-" for stdout)
2558
2682
 
@@ -2578,6 +2702,13 @@ FLAG DESCRIPTIONS
2578
2702
  Compress the dump with gzip. This is useful for large databases, as it can significantly reduce the size of the
2579
2703
  dump.
2580
2704
 
2705
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2706
+
2707
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
2708
+ authenticate the connection to the server.
2709
+
2710
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
2711
+
2581
2712
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2582
2713
 
2583
2714
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -2587,8 +2718,8 @@ FLAG DESCRIPTIONS
2587
2718
 
2588
2719
  --[no-]temporary-user create a temporary user for the dump
2589
2720
 
2590
- Create a temporary user for the dump. This user will be deleted after the dump has been created. This is useful if
2591
- you want to dump a database that is not accessible from the outside.
2721
+ Create a temporary user for this operation. This user will be deleted after the operation has completed. This is
2722
+ useful if you want to work with a database that is not accessible from the outside.
2592
2723
 
2593
2724
  If this flag is disabled, you will need to specify the password of the default user; either via the --mysql-password
2594
2725
  flag or via the MYSQL_PWD environment variable.
@@ -2613,6 +2744,89 @@ DESCRIPTION
2613
2744
  Get a MySQLDatabase.
2614
2745
  ```
2615
2746
 
2747
+ ## `mw database mysql import DATABASE-ID`
2748
+
2749
+ Imports a dump of a MySQL database
2750
+
2751
+ ```
2752
+ USAGE
2753
+ $ mw database mysql import DATABASE-ID -i <value> [-q] [-p <value>] [--temporary-user] [--ssh-user <value>]
2754
+ [--ssh-identity-file <value>] [--gzip]
2755
+
2756
+ ARGUMENTS
2757
+ DATABASE-ID The ID or name of the database
2758
+
2759
+ FLAGS
2760
+ -i, --input=<value> (required) the input file from which to read the dump ("-" for stdin)
2761
+ -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2762
+ -q, --quiet suppress process output and only display a machine-readable summary.
2763
+ --gzip uncompress the dump with gzip
2764
+ --[no-]temporary-user create a temporary user for the dump
2765
+
2766
+ SSH CONNECTION FLAGS
2767
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2768
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2769
+
2770
+ DESCRIPTION
2771
+ Imports a dump of a MySQL database
2772
+
2773
+ This command imports a mysqldump file from your local filesystem into a MySQL database.
2774
+
2775
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
2776
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
2777
+
2778
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
2779
+ authenticated mStudio user or the user specified with the --ssh-user flag.
2780
+
2781
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
2782
+
2783
+ FLAG DESCRIPTIONS
2784
+ -i, --input=<value> the input file from which to read the dump ("-" for stdin)
2785
+
2786
+ The input file from which to read the dump to. You can specify "-" or "/dev/stdin" to read the dump directly from
2787
+ STDIN.
2788
+
2789
+ -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2790
+
2791
+ The password to use for the MySQL user. If not provided, the environment variable MYSQL_PWD will be used. If that is
2792
+ not set either, the command will interactively ask for the password.
2793
+
2794
+ NOTE: This is a security risk, as the password will be visible in the process list of your system, and will be
2795
+ visible in your Shell history. It is recommended to use the environment variable instead.
2796
+
2797
+ -q, --quiet suppress process output and only display a machine-readable summary.
2798
+
2799
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2800
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
2801
+
2802
+ --gzip uncompress the dump with gzip
2803
+
2804
+ Uncompress the dump with gzip while importing. This is useful for large databases, as it can significantly reduce
2805
+ the size of the dump.
2806
+
2807
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2808
+
2809
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
2810
+ authenticate the connection to the server.
2811
+
2812
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
2813
+
2814
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2815
+
2816
+ This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
2817
+ will be used for this.
2818
+
2819
+ You can also set this value by setting the MITTWALD_SSH_USER environment variable.
2820
+
2821
+ --[no-]temporary-user create a temporary user for the dump
2822
+
2823
+ Create a temporary user for this operation. This user will be deleted after the operation has completed. This is
2824
+ useful if you want to work with a database that is not accessible from the outside.
2825
+
2826
+ If this flag is disabled, you will need to specify the password of the default user; either via the --mysql-password
2827
+ flag or via the MYSQL_PWD environment variable.
2828
+ ```
2829
+
2616
2830
  ## `mw database mysql list`
2617
2831
 
2618
2832
  List MySQLDatabases belonging to a Project.
@@ -2662,15 +2876,32 @@ Forward the TCP port of a MySQL database to a local port
2662
2876
 
2663
2877
  ```
2664
2878
  USAGE
2665
- $ mw database mysql port-forward DATABASE-ID [-q] [--ssh-user <value>] [--port <value>]
2879
+ $ mw database mysql port-forward DATABASE-ID [-q] [--ssh-user <value>] [--ssh-identity-file <value>] [--port <value>]
2666
2880
 
2667
2881
  ARGUMENTS
2668
2882
  DATABASE-ID The ID or name of the database
2669
2883
 
2670
2884
  FLAGS
2671
- -q, --quiet suppress process output and only display a machine-readable summary.
2672
- --port=<value> [default: 3306] The local TCP port to forward to
2673
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2885
+ -q, --quiet suppress process output and only display a machine-readable summary.
2886
+ --port=<value> [default: 3306] The local TCP port to forward to
2887
+
2888
+ SSH CONNECTION FLAGS
2889
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2890
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2891
+
2892
+ DESCRIPTION
2893
+ Forward the TCP port of a MySQL database to a local port
2894
+
2895
+ This command forwards the TCP port of a MySQL database to a local port on your machine. This allows you to connect to
2896
+ the database as if it were running on your local machine.
2897
+
2898
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
2899
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
2900
+
2901
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
2902
+ authenticated mStudio user or the user specified with the --ssh-user flag.
2903
+
2904
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
2674
2905
 
2675
2906
  FLAG DESCRIPTIONS
2676
2907
  -q, --quiet suppress process output and only display a machine-readable summary.
@@ -2678,6 +2909,13 @@ FLAG DESCRIPTIONS
2678
2909
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2679
2910
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
2680
2911
 
2912
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2913
+
2914
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
2915
+ authenticate the connection to the server.
2916
+
2917
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
2918
+
2681
2919
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2682
2920
 
2683
2921
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -2692,7 +2930,7 @@ Connect to a MySQL database via the MySQL shell
2692
2930
 
2693
2931
  ```
2694
2932
  USAGE
2695
- $ mw database mysql shell DATABASE-ID [-q] [-p <value>]
2933
+ $ mw database mysql shell DATABASE-ID [-q] [--ssh-user <value>] [--ssh-identity-file <value>] [-p <value>]
2696
2934
 
2697
2935
  ARGUMENTS
2698
2936
  DATABASE-ID The ID or name of the database
@@ -2701,6 +2939,23 @@ FLAGS
2701
2939
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2702
2940
  -q, --quiet suppress process output and only display a machine-readable summary.
2703
2941
 
2942
+ SSH CONNECTION FLAGS
2943
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2944
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2945
+
2946
+ DESCRIPTION
2947
+ Connect to a MySQL database via the MySQL shell
2948
+
2949
+ This command opens an interactive mysql shell to a MySQL database.
2950
+
2951
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
2952
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
2953
+
2954
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
2955
+ authenticated mStudio user or the user specified with the --ssh-user flag.
2956
+
2957
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
2958
+
2704
2959
  FLAG DESCRIPTIONS
2705
2960
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2706
2961
 
@@ -2714,6 +2969,20 @@ FLAG DESCRIPTIONS
2714
2969
 
2715
2970
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2716
2971
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
2972
+
2973
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
2974
+
2975
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
2976
+ authenticate the connection to the server.
2977
+
2978
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
2979
+
2980
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2981
+
2982
+ This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
2983
+ will be used for this.
2984
+
2985
+ You can also set this value by setting the MITTWALD_SSH_USER environment variable.
2717
2986
  ```
2718
2987
 
2719
2988
  ## `mw database mysql user delete USER-ID`
@@ -2912,7 +3181,7 @@ Connect to a Redis database via the redis-cli
2912
3181
 
2913
3182
  ```
2914
3183
  USAGE
2915
- $ mw database redis shell DATABASE-ID [-q]
3184
+ $ mw database redis shell DATABASE-ID [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
2916
3185
 
2917
3186
  ARGUMENTS
2918
3187
  DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
@@ -2920,11 +3189,42 @@ ARGUMENTS
2920
3189
  FLAGS
2921
3190
  -q, --quiet suppress process output and only display a machine-readable summary.
2922
3191
 
3192
+ SSH CONNECTION FLAGS
3193
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
3194
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
3195
+
3196
+ DESCRIPTION
3197
+ Connect to a Redis database via the redis-cli
3198
+
3199
+ This command opens an interactive redis-cli shell to a Redis database.
3200
+
3201
+ This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
3202
+ under the hood, and will respect your SSH configuration in ~/.ssh/config.
3203
+
3204
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
3205
+ authenticated mStudio user or the user specified with the --ssh-user flag.
3206
+
3207
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
3208
+
2923
3209
  FLAG DESCRIPTIONS
2924
3210
  -q, --quiet suppress process output and only display a machine-readable summary.
2925
3211
 
2926
3212
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2927
3213
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
3214
+
3215
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
3216
+
3217
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
3218
+ authenticate the connection to the server.
3219
+
3220
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
3221
+
3222
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
3223
+
3224
+ This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
3225
+ will be used for this.
3226
+
3227
+ You can also set this value by setting the MITTWALD_SSH_USER environment variable.
2928
3228
  ```
2929
3229
 
2930
3230
  ## `mw database redis versions`
@@ -2964,19 +3264,23 @@ Initialize a new ddev project in the current directory.
2964
3264
 
2965
3265
  ```
2966
3266
  USAGE
2967
- $ mw ddev init [INSTALLATION-ID] [-q] [--override-type <value>] [--without-database | --database-id <value>]
2968
- [--project-name <value>] [--override-mittwald-plugin <value>]
3267
+ $ mw ddev init [INSTALLATION-ID] [-q] [--override-type
3268
+ backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wo
3269
+ rdpress|auto] [--without-database | --database-id <value>] [--project-name <value>] [--override-mittwald-plugin
3270
+ <value>]
2969
3271
 
2970
3272
  ARGUMENTS
2971
3273
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
2972
3274
  in the context
2973
3275
 
2974
3276
  FLAGS
2975
- -q, --quiet suppress process output and only display a machine-readable summary.
2976
- --database-id=<value> ID of the application database
2977
- --override-type=<value> [default: auto] Override the type of the generated DDEV configuration
2978
- --project-name=<value> DDEV project name
2979
- --without-database Create a DDEV project without a database
3277
+ -q, --quiet suppress process output and only display a machine-readable summary.
3278
+ --database-id=<value> ID of the application database
3279
+ --override-type=<option> [default: auto] Override the type of the generated DDEV configuration
3280
+ <options: backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|
3281
+ python|shopware6|silverstripe|typo3|wordpress|auto>
3282
+ --project-name=<value> DDEV project name
3283
+ --without-database Create a DDEV project without a database
2980
3284
 
2981
3285
  DEVELOPMENT FLAGS
2982
3286
  --override-mittwald-plugin=<value> [default: mittwald/ddev] override the mittwald plugin
@@ -3016,7 +3320,9 @@ FLAG DESCRIPTIONS
3016
3320
  This flag allows you to override the mittwald plugin that should be installed by default; this is useful for testing
3017
3321
  purposes
3018
3322
 
3019
- --override-type=<value> Override the type of the generated DDEV configuration
3323
+ --override-type=backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wordpress|auto
3324
+
3325
+ Override the type of the generated DDEV configuration
3020
3326
 
3021
3327
  The type of the generated DDEV configuration; this can be any of the documented DDEV project types, or 'auto' (which
3022
3328
  is also the default) for automatic discovery.
@@ -3039,16 +3345,20 @@ Generate a DDEV configuration YAML file for the current app.
3039
3345
 
3040
3346
  ```
3041
3347
  USAGE
3042
- $ mw ddev render-config [INSTALLATION-ID] [--override-type <value>] [--without-database | --database-id <value>]
3348
+ $ mw ddev render-config [INSTALLATION-ID] [--override-type
3349
+ backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wo
3350
+ rdpress|auto] [--without-database | --database-id <value>]
3043
3351
 
3044
3352
  ARGUMENTS
3045
3353
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
3046
3354
  in the context
3047
3355
 
3048
3356
  FLAGS
3049
- --database-id=<value> ID of the application database
3050
- --override-type=<value> [default: auto] Override the type of the generated DDEV configuration
3051
- --without-database Create a DDEV project without a database
3357
+ --database-id=<value> ID of the application database
3358
+ --override-type=<option> [default: auto] Override the type of the generated DDEV configuration
3359
+ <options: backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|pyth
3360
+ on|shopware6|silverstripe|typo3|wordpress|auto>
3361
+ --without-database Create a DDEV project without a database
3052
3362
 
3053
3363
  DESCRIPTION
3054
3364
  Generate a DDEV configuration YAML file for the current app.
@@ -3064,7 +3374,9 @@ FLAG DESCRIPTIONS
3064
3374
  Setting a database ID (either automatically or manually) is required. To create a DDEV project without a database,
3065
3375
  set the --without-database flag.
3066
3376
 
3067
- --override-type=<value> Override the type of the generated DDEV configuration
3377
+ --override-type=backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wordpress|auto
3378
+
3379
+ Override the type of the generated DDEV configuration
3068
3380
 
3069
3381
  The type of the generated DDEV configuration; this can be any of the documented DDEV project types, or 'auto' (which
3070
3382
  is also the default) for automatic discovery.
@@ -3391,7 +3703,7 @@ DESCRIPTION
3391
3703
  Display help for mw.
3392
3704
  ```
3393
3705
 
3394
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.20/src/commands/help.ts)_
3706
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
3395
3707
 
3396
3708
  ## `mw login reset`
3397
3709
 
@@ -3448,7 +3760,7 @@ FLAGS
3448
3760
  -q, --quiet suppress process output and only display a machine-readable summary.
3449
3761
  --catch-all make this a catch-all mail address
3450
3762
  --[no-]enable-spam-protection enable spam protection for this mailbox
3451
- --forward-to=<value>... forward mail to another address
3763
+ --forward-to=<value>... forward mail to other addresses
3452
3764
  --password=<value> mailbox password
3453
3765
  --quota=<value> [default: 1024] mailbox quota in mebibytes
3454
3766
  --random-password generate a random password
@@ -3495,11 +3807,12 @@ FLAG DESCRIPTIONS
3495
3807
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
3496
3808
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
3497
3809
 
3498
- --forward-to=<value>... forward mail to another address
3810
+ --forward-to=<value>... forward mail to other addresses
3499
3811
 
3500
- This flag will cause the mailbox to forward all incoming mail to the given address.
3812
+ This flag will cause the mailbox to forward all incoming mail to the given addresses. This will replace any
3813
+ forwarding addresses, that have already been set.
3501
3814
 
3502
- Note: This flag is exclusive with --catch-all, --enable-spam-protection, --quota, --password and --random-password.
3815
+ Note: This flag is exclusive with --catch-all, --quota, --password and --random-password.
3503
3816
 
3504
3817
  --password=<value> mailbox password
3505
3818
 
@@ -3589,6 +3902,80 @@ FLAG DESCRIPTIONS
3589
3902
  to persistently set a default project for all commands that accept this flag.
3590
3903
  ```
3591
3904
 
3905
+ ## `mw mail address update MAILADDRESS-ID`
3906
+
3907
+ Update a mail address
3908
+
3909
+ ```
3910
+ USAGE
3911
+ $ mw mail address update MAILADDRESS-ID [-q] [-a <value>] [--catch-all] [--quota <value>] [--password <value>]
3912
+ [--random-password] [--forward-to <value>]
3913
+
3914
+ ARGUMENTS
3915
+ MAILADDRESS-ID ID or mail address of a mailaddress
3916
+
3917
+ FLAGS
3918
+ -a, --address=<value> mail address
3919
+ -q, --quiet suppress process output and only display a machine-readable summary.
3920
+ --[no-]catch-all Change this from or to a catch-all mail address; omit to leave unchanged
3921
+ --forward-to=<value>... forward mail to other addresses
3922
+ --password=<value> mailbox password
3923
+ --quota=<value> mailbox quota in mebibytes
3924
+ --random-password generate a random password
3925
+
3926
+ DESCRIPTION
3927
+ Update a mail address
3928
+
3929
+ This command can be used to update a mail address in a project.
3930
+
3931
+ A mail address is either associated with a mailbox, or forwards to another address.
3932
+
3933
+ To set forwarding addresses, use the --forward-to flag.
3934
+
3935
+ Use the --catch-all flag to make the mailbox a catch-all mailbox.
3936
+ Use the --no-catch-all flag to make the mailbox a regular mailbox.
3937
+
3938
+ When running this command with --generated-password the output will be the newly generated and set password.
3939
+
3940
+ EXAMPLES
3941
+ Update non-interactively with password
3942
+
3943
+ $ read -s PASSWORD && \
3944
+ mw mail address update --password $PASSWORD --address foo@bar.example
3945
+
3946
+ Update non-interactively with random password
3947
+
3948
+ $ mw mail address update --random-password --address foo@bar.example
3949
+
3950
+ Set forwarding addresses
3951
+
3952
+ $ mw mail address update --address foo@bar.example --forward-to bar@bar.example --forward-to baz@bar.example
3953
+
3954
+ FLAG DESCRIPTIONS
3955
+ -q, --quiet suppress process output and only display a machine-readable summary.
3956
+
3957
+ This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
3958
+ scripts), you can use this flag to easily get the IDs of created resources for further processing.
3959
+
3960
+ --forward-to=<value>... forward mail to other addresses
3961
+
3962
+ This flag will cause the mailbox to forward all incoming mail to the given addresses. This will replace any
3963
+ forwarding addresses, that have already been set.
3964
+
3965
+ Note: This flag is exclusive with --catch-all, --no-catch-all, --quota, --password and --random-password.
3966
+
3967
+ --password=<value> mailbox password
3968
+
3969
+ If set, the mailbox will be updated to this password. If omitted, the password will remain unchanged.
3970
+
3971
+ CAUTION: providing this flag may log your password in your shell history!
3972
+
3973
+ --random-password generate a random password
3974
+
3975
+ This flag will cause the command to generate a random 32-character password for the mailbox; when running with
3976
+ --quiet, the password will be printed to stdout.
3977
+ ```
3978
+
3592
3979
  ## `mw mail deliverybox get ID`
3593
3980
 
3594
3981
  Get a specific delivery box
@@ -4532,13 +4919,41 @@ Connect to a project via SSH
4532
4919
 
4533
4920
  ```
4534
4921
  USAGE
4535
- $ mw project ssh [PROJECT-ID]
4922
+ $ mw project ssh [PROJECT-ID] [--ssh-user <value>] [--ssh-identity-file <value>]
4536
4923
 
4537
4924
  ARGUMENTS
4538
4925
  PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
4539
4926
 
4927
+ SSH CONNECTION FLAGS
4928
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
4929
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
4930
+
4540
4931
  DESCRIPTION
4541
4932
  Connect to a project via SSH
4933
+
4934
+ Establishes an interactive SSH connection to a project.
4935
+
4936
+ This command is a wrapper around your systems SSH client, and will respect your SSH configuration in ~/.ssh/config.
4937
+
4938
+ An exception to this is the 'User' configuration, which will be overridden by this command to either your
4939
+ authenticated mStudio user or the user specified with the --ssh-user flag.
4940
+
4941
+ See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
4942
+
4943
+ FLAG DESCRIPTIONS
4944
+ --ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
4945
+
4946
+ The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
4947
+ authenticate the connection to the server.
4948
+
4949
+ You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
4950
+
4951
+ --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
4952
+
4953
+ This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
4954
+ will be used for this.
4955
+
4956
+ You can also set this value by setting the MITTWALD_SSH_USER environment variable.
4542
4957
  ```
4543
4958
 
4544
4959
  ## `mw project ssh-user list`
@@ -4785,7 +5200,7 @@ EXAMPLES
4785
5200
  $ mw update --available
4786
5201
  ```
4787
5202
 
4788
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.2.3/src/commands/update.ts)_
5203
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.2.8/src/commands/update.ts)_
4789
5204
 
4790
5205
  ## `mw user api-token create`
4791
5206