@mittwald/cli 1.0.0-alpha.42 → 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 (49) hide show
  1. package/README.md +360 -47
  2. package/dist/commands/app/download.d.ts +2 -0
  3. package/dist/commands/app/download.js +9 -2
  4. package/dist/commands/app/ssh.d.ts +2 -0
  5. package/dist/commands/app/ssh.js +22 -10
  6. package/dist/commands/app/upload.d.ts +1 -0
  7. package/dist/commands/app/upload.js +4 -2
  8. package/dist/commands/database/mysql/dump.d.ts +2 -0
  9. package/dist/commands/database/mysql/dump.js +4 -1
  10. package/dist/commands/database/mysql/import.d.ts +2 -0
  11. package/dist/commands/database/mysql/import.js +4 -1
  12. package/dist/commands/database/mysql/port-forward.d.ts +2 -0
  13. package/dist/commands/database/mysql/port-forward.js +9 -11
  14. package/dist/commands/database/mysql/shell.d.ts +3 -0
  15. package/dist/commands/database/mysql/shell.js +14 -15
  16. package/dist/commands/database/redis/shell.d.ts +3 -0
  17. package/dist/commands/database/redis/shell.js +15 -4
  18. package/dist/commands/ddev/init.js +5 -3
  19. package/dist/commands/domain/dnszone/list.js +1 -1
  20. package/dist/commands/domain/dnszone/update.js +1 -1
  21. package/dist/commands/domain/virtualhost/create.js +1 -1
  22. package/dist/commands/mail/address/create.d.ts +1 -1
  23. package/dist/commands/mail/address/create.js +6 -6
  24. package/dist/commands/mail/address/get.js +1 -1
  25. package/dist/commands/mail/address/list.js +1 -1
  26. package/dist/commands/mail/address/update.d.ts +35 -0
  27. package/dist/commands/mail/address/update.js +169 -0
  28. package/dist/commands/mail/deliverybox/get.js +1 -1
  29. package/dist/commands/mail/deliverybox/list.js +1 -1
  30. package/dist/commands/project/ssh.d.ts +5 -0
  31. package/dist/commands/project/ssh.js +12 -12
  32. package/dist/lib/context.d.ts +1 -1
  33. package/dist/lib/database/redis/connect.d.ts +1 -1
  34. package/dist/lib/database/redis/connect.js +5 -6
  35. package/dist/lib/ddev/config_builder.js +5 -18
  36. package/dist/lib/ddev/flags.js +2 -0
  37. package/dist/lib/ddev/init_projecttype.d.ts +32 -0
  38. package/dist/lib/ddev/init_projecttype.js +102 -0
  39. package/dist/lib/mail/flags.d.ts +1 -0
  40. package/dist/lib/mail/flags.js +20 -0
  41. package/dist/lib/ssh/connection.d.ts +22 -0
  42. package/dist/lib/ssh/connection.js +19 -0
  43. package/dist/lib/ssh/doc.d.ts +10 -0
  44. package/dist/lib/ssh/doc.js +14 -0
  45. package/dist/lib/ssh/exec.d.ts +2 -1
  46. package/dist/lib/ssh/exec.js +7 -4
  47. package/dist/lib/ssh/flags.d.ts +6 -1
  48. package/dist/lib/ssh/flags.js +11 -0
  49. package/package.json +1 -1
package/README.md CHANGED
@@ -204,6 +204,7 @@ USAGE
204
204
  * [`mw mail address delete ID`](#mw-mail-address-delete-id)
205
205
  * [`mw mail address get ID`](#mw-mail-address-get-id)
206
206
  * [`mw mail address list`](#mw-mail-address-list)
207
+ * [`mw mail address update MAILADDRESS-ID`](#mw-mail-address-update-mailaddress-id)
207
208
  * [`mw mail deliverybox get ID`](#mw-mail-deliverybox-get-id)
208
209
  * [`mw mail deliverybox list`](#mw-mail-deliverybox-list)
209
210
  * [`mw org delete [ORG-ID]`](#mw-org-delete-org-id)
@@ -562,28 +563,51 @@ Download the filesystem of an app within a project to your local machine
562
563
 
563
564
  ```
564
565
  USAGE
565
- $ 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]
566
568
 
567
569
  ARGUMENTS
568
570
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
569
571
  in the context
570
572
 
571
573
  FLAGS
572
- -q, --quiet suppress process output and only display a machine-readable summary.
573
- --delete delete local files that are not present on the server
574
- --dry-run do not actually download the app installation
575
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
576
- --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
577
582
 
578
583
  DESCRIPTION
579
584
  Download the filesystem of an app within a project to your local machine
580
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
+
581
598
  FLAG DESCRIPTIONS
582
599
  -q, --quiet suppress process output and only display a machine-readable summary.
583
600
 
584
601
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
585
602
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
586
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
+
587
611
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
588
612
 
589
613
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -1733,22 +1757,41 @@ Connect to an app via SSH
1733
1757
 
1734
1758
  ```
1735
1759
  USAGE
1736
- $ 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]
1737
1761
 
1738
1762
  ARGUMENTS
1739
1763
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
1740
1764
  in the context
1741
1765
 
1742
1766
  FLAGS
1743
- --[no-]cd change to installation path after connecting
1744
- --info only print connection information, without actually connecting
1745
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1746
- --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
1747
1774
 
1748
1775
  DESCRIPTION
1749
1776
  Connect to an app via SSH
1750
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
+
1751
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
+
1752
1795
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1753
1796
 
1754
1797
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -1789,33 +1832,54 @@ Upload the filesystem of an app to a project
1789
1832
 
1790
1833
  ```
1791
1834
  USAGE
1792
- $ mw app upload [INSTALLATION-ID] --source <value> [-q] [--ssh-user <value>] [--dry-run] [--delete]
1835
+ $ mw app upload [INSTALLATION-ID] --source <value> [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
1836
+ [--dry-run] [--delete]
1793
1837
 
1794
1838
  ARGUMENTS
1795
1839
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
1796
1840
  in the context
1797
1841
 
1798
1842
  FLAGS
1799
- -q, --quiet suppress process output and only display a machine-readable summary.
1800
- --delete delete remote files that are not present locally
1801
- --dry-run do not actually upload the app installation
1802
- --source=<value> (required) source directory from which to upload the app installation
1803
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
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
1804
1851
 
1805
1852
  DESCRIPTION
1806
1853
  Upload the filesystem of an app to a project
1807
1854
 
1808
1855
  Upload the filesystem of an app from your local machine to a project.
1809
1856
 
1857
+ For this, rsync needs to be installed on your system.
1858
+
1810
1859
  CAUTION: This is a potentially destructive operation. It will overwrite files on the server with the files from your
1811
1860
  local machine. This is NOT a turnkey deployment solution. It is intended for development purposes only.
1812
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
+
1813
1870
  FLAG DESCRIPTIONS
1814
1871
  -q, --quiet suppress process output and only display a machine-readable summary.
1815
1872
 
1816
1873
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
1817
1874
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
1818
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
+
1819
1883
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
1820
1884
 
1821
1885
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -1868,7 +1932,7 @@ EXAMPLES
1868
1932
  $ mw autocomplete --refresh-cache
1869
1933
  ```
1870
1934
 
1871
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.15/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)_
1872
1936
 
1873
1937
  ## `mw backup create`
1874
1938
 
@@ -2583,7 +2647,8 @@ Create a dump of a MySQL database
2583
2647
 
2584
2648
  ```
2585
2649
  USAGE
2586
- $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--temporary-user] [--ssh-user <value>] [--gzip]
2650
+ $ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--temporary-user] [--ssh-user <value>]
2651
+ [--ssh-identity-file <value>] [--gzip]
2587
2652
 
2588
2653
  ARGUMENTS
2589
2654
  DATABASE-ID The ID or name of the database
@@ -2593,9 +2658,25 @@ FLAGS
2593
2658
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2594
2659
  -q, --quiet suppress process output and only display a machine-readable summary.
2595
2660
  --gzip compress the dump with gzip
2596
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2597
2661
  --[no-]temporary-user create a temporary user for the dump
2598
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
+
2599
2680
  FLAG DESCRIPTIONS
2600
2681
  -o, --output=<value> the output file to write the dump to ("-" for stdout)
2601
2682
 
@@ -2621,6 +2702,13 @@ FLAG DESCRIPTIONS
2621
2702
  Compress the dump with gzip. This is useful for large databases, as it can significantly reduce the size of the
2622
2703
  dump.
2623
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
+
2624
2712
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2625
2713
 
2626
2714
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -2662,7 +2750,8 @@ Imports a dump of a MySQL database
2662
2750
 
2663
2751
  ```
2664
2752
  USAGE
2665
- $ mw database mysql import DATABASE-ID -i <value> [-q] [-p <value>] [--temporary-user] [--ssh-user <value>] [--gzip]
2753
+ $ mw database mysql import DATABASE-ID -i <value> [-q] [-p <value>] [--temporary-user] [--ssh-user <value>]
2754
+ [--ssh-identity-file <value>] [--gzip]
2666
2755
 
2667
2756
  ARGUMENTS
2668
2757
  DATABASE-ID The ID or name of the database
@@ -2672,9 +2761,25 @@ FLAGS
2672
2761
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2673
2762
  -q, --quiet suppress process output and only display a machine-readable summary.
2674
2763
  --gzip uncompress the dump with gzip
2675
- --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2676
2764
  --[no-]temporary-user create a temporary user for the dump
2677
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
+
2678
2783
  FLAG DESCRIPTIONS
2679
2784
  -i, --input=<value> the input file from which to read the dump ("-" for stdin)
2680
2785
 
@@ -2699,6 +2804,13 @@ FLAG DESCRIPTIONS
2699
2804
  Uncompress the dump with gzip while importing. This is useful for large databases, as it can significantly reduce
2700
2805
  the size of the dump.
2701
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
+
2702
2814
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2703
2815
 
2704
2816
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -2764,15 +2876,32 @@ Forward the TCP port of a MySQL database to a local port
2764
2876
 
2765
2877
  ```
2766
2878
  USAGE
2767
- $ 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>]
2768
2880
 
2769
2881
  ARGUMENTS
2770
2882
  DATABASE-ID The ID or name of the database
2771
2883
 
2772
2884
  FLAGS
2773
- -q, --quiet suppress process output and only display a machine-readable summary.
2774
- --port=<value> [default: 3306] The local TCP port to forward to
2775
- --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.
2776
2905
 
2777
2906
  FLAG DESCRIPTIONS
2778
2907
  -q, --quiet suppress process output and only display a machine-readable summary.
@@ -2780,6 +2909,13 @@ FLAG DESCRIPTIONS
2780
2909
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2781
2910
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
2782
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
+
2783
2919
  --ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
2784
2920
 
2785
2921
  This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
@@ -2794,7 +2930,7 @@ Connect to a MySQL database via the MySQL shell
2794
2930
 
2795
2931
  ```
2796
2932
  USAGE
2797
- $ 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>]
2798
2934
 
2799
2935
  ARGUMENTS
2800
2936
  DATABASE-ID The ID or name of the database
@@ -2803,6 +2939,23 @@ FLAGS
2803
2939
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2804
2940
  -q, --quiet suppress process output and only display a machine-readable summary.
2805
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
+
2806
2959
  FLAG DESCRIPTIONS
2807
2960
  -p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
2808
2961
 
@@ -2816,6 +2969,20 @@ FLAG DESCRIPTIONS
2816
2969
 
2817
2970
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
2818
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.
2819
2986
  ```
2820
2987
 
2821
2988
  ## `mw database mysql user delete USER-ID`
@@ -3014,7 +3181,7 @@ Connect to a Redis database via the redis-cli
3014
3181
 
3015
3182
  ```
3016
3183
  USAGE
3017
- $ mw database redis shell DATABASE-ID [-q]
3184
+ $ mw database redis shell DATABASE-ID [-q] [--ssh-user <value>] [--ssh-identity-file <value>]
3018
3185
 
3019
3186
  ARGUMENTS
3020
3187
  DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
@@ -3022,11 +3189,42 @@ ARGUMENTS
3022
3189
  FLAGS
3023
3190
  -q, --quiet suppress process output and only display a machine-readable summary.
3024
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
+
3025
3209
  FLAG DESCRIPTIONS
3026
3210
  -q, --quiet suppress process output and only display a machine-readable summary.
3027
3211
 
3028
3212
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
3029
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.
3030
3228
  ```
3031
3229
 
3032
3230
  ## `mw database redis versions`
@@ -3066,19 +3264,23 @@ Initialize a new ddev project in the current directory.
3066
3264
 
3067
3265
  ```
3068
3266
  USAGE
3069
- $ mw ddev init [INSTALLATION-ID] [-q] [--override-type <value>] [--without-database | --database-id <value>]
3070
- [--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>]
3071
3271
 
3072
3272
  ARGUMENTS
3073
3273
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
3074
3274
  in the context
3075
3275
 
3076
3276
  FLAGS
3077
- -q, --quiet suppress process output and only display a machine-readable summary.
3078
- --database-id=<value> ID of the application database
3079
- --override-type=<value> [default: auto] Override the type of the generated DDEV configuration
3080
- --project-name=<value> DDEV project name
3081
- --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
3082
3284
 
3083
3285
  DEVELOPMENT FLAGS
3084
3286
  --override-mittwald-plugin=<value> [default: mittwald/ddev] override the mittwald plugin
@@ -3118,7 +3320,9 @@ FLAG DESCRIPTIONS
3118
3320
  This flag allows you to override the mittwald plugin that should be installed by default; this is useful for testing
3119
3321
  purposes
3120
3322
 
3121
- --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
3122
3326
 
3123
3327
  The type of the generated DDEV configuration; this can be any of the documented DDEV project types, or 'auto' (which
3124
3328
  is also the default) for automatic discovery.
@@ -3141,16 +3345,20 @@ Generate a DDEV configuration YAML file for the current app.
3141
3345
 
3142
3346
  ```
3143
3347
  USAGE
3144
- $ 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>]
3145
3351
 
3146
3352
  ARGUMENTS
3147
3353
  INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
3148
3354
  in the context
3149
3355
 
3150
3356
  FLAGS
3151
- --database-id=<value> ID of the application database
3152
- --override-type=<value> [default: auto] Override the type of the generated DDEV configuration
3153
- --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
3154
3362
 
3155
3363
  DESCRIPTION
3156
3364
  Generate a DDEV configuration YAML file for the current app.
@@ -3166,7 +3374,9 @@ FLAG DESCRIPTIONS
3166
3374
  Setting a database ID (either automatically or manually) is required. To create a DDEV project without a database,
3167
3375
  set the --without-database flag.
3168
3376
 
3169
- --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
3170
3380
 
3171
3381
  The type of the generated DDEV configuration; this can be any of the documented DDEV project types, or 'auto' (which
3172
3382
  is also the default) for automatic discovery.
@@ -3550,7 +3760,7 @@ FLAGS
3550
3760
  -q, --quiet suppress process output and only display a machine-readable summary.
3551
3761
  --catch-all make this a catch-all mail address
3552
3762
  --[no-]enable-spam-protection enable spam protection for this mailbox
3553
- --forward-to=<value>... forward mail to another address
3763
+ --forward-to=<value>... forward mail to other addresses
3554
3764
  --password=<value> mailbox password
3555
3765
  --quota=<value> [default: 1024] mailbox quota in mebibytes
3556
3766
  --random-password generate a random password
@@ -3597,11 +3807,12 @@ FLAG DESCRIPTIONS
3597
3807
  This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
3598
3808
  scripts), you can use this flag to easily get the IDs of created resources for further processing.
3599
3809
 
3600
- --forward-to=<value>... forward mail to another address
3810
+ --forward-to=<value>... forward mail to other addresses
3601
3811
 
3602
- 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.
3603
3814
 
3604
- 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.
3605
3816
 
3606
3817
  --password=<value> mailbox password
3607
3818
 
@@ -3691,6 +3902,80 @@ FLAG DESCRIPTIONS
3691
3902
  to persistently set a default project for all commands that accept this flag.
3692
3903
  ```
3693
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
+
3694
3979
  ## `mw mail deliverybox get ID`
3695
3980
 
3696
3981
  Get a specific delivery box
@@ -4634,13 +4919,41 @@ Connect to a project via SSH
4634
4919
 
4635
4920
  ```
4636
4921
  USAGE
4637
- $ mw project ssh [PROJECT-ID]
4922
+ $ mw project ssh [PROJECT-ID] [--ssh-user <value>] [--ssh-identity-file <value>]
4638
4923
 
4639
4924
  ARGUMENTS
4640
4925
  PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
4641
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
+
4642
4931
  DESCRIPTION
4643
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.
4644
4957
  ```
4645
4958
 
4646
4959
  ## `mw project ssh-user list`
@@ -4887,7 +5200,7 @@ EXAMPLES
4887
5200
  $ mw update --available
4888
5201
  ```
4889
5202
 
4890
- _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.2.6/src/commands/update.ts)_
5203
+ _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.2.8/src/commands/update.ts)_
4891
5204
 
4892
5205
  ## `mw user api-token create`
4893
5206