@mittwald/cli 1.0.0-alpha.27 → 1.0.0-alpha.29
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.
- package/README.md +905 -806
- package/dist/esm/ExtendedBaseCommand.d.ts +4 -0
- package/dist/esm/ExtendedBaseCommand.js +12 -0
- package/dist/esm/Formatter.js +13 -1
- package/dist/esm/GetBaseCommand.d.ts +2 -3
- package/dist/esm/GetBaseCommand.js +2 -4
- package/dist/esm/ListBaseCommand.d.ts +2 -3
- package/dist/esm/ListBaseCommand.js +2 -4
- package/dist/esm/commands/app/copy.d.ts +2 -1
- package/dist/esm/commands/app/copy.js +3 -3
- package/dist/esm/commands/app/dependency/list.d.ts +1 -1
- package/dist/esm/commands/app/dependency/update.d.ts +2 -1
- package/dist/esm/commands/app/dependency/update.js +3 -3
- package/dist/esm/commands/app/dependency/versions.d.ts +1 -1
- package/dist/esm/commands/app/get.d.ts +2 -1
- package/dist/esm/commands/app/get.js +4 -3
- package/dist/esm/commands/app/list.d.ts +1 -1
- package/dist/esm/commands/app/list.js +4 -0
- package/dist/esm/commands/app/ssh.d.ts +5 -3
- package/dist/esm/commands/app/ssh.js +18 -9
- package/dist/esm/commands/app/uninstall.d.ts +2 -1
- package/dist/esm/commands/app/uninstall.js +3 -6
- package/dist/esm/commands/backup/create.js +2 -2
- package/dist/esm/commands/backup/list.js +2 -2
- package/dist/esm/commands/context/get.js +27 -5
- package/dist/esm/commands/context/set.d.ts +1 -0
- package/dist/esm/commands/context/set.js +10 -0
- package/dist/esm/commands/conversation/show.js +1 -2
- package/dist/esm/commands/cronjob/create.d.ts +23 -0
- package/dist/esm/commands/cronjob/create.js +97 -0
- package/dist/esm/commands/cronjob/delete.d.ts +13 -0
- package/dist/esm/commands/cronjob/delete.js +21 -0
- package/dist/esm/commands/cronjob/execute.d.ts +17 -0
- package/dist/esm/commands/cronjob/execute.js +42 -0
- package/dist/esm/commands/cronjob/execution/abort.d.ts +18 -0
- package/dist/esm/commands/cronjob/execution/abort.js +41 -0
- package/dist/esm/commands/cronjob/execution/list.js +4 -5
- package/dist/esm/commands/cronjob/get.d.ts +7 -9
- package/dist/esm/commands/cronjob/get.js +22 -12
- package/dist/esm/commands/cronjob/list.js +4 -6
- package/dist/esm/commands/database/mysql/charsets.d.ts +2 -4
- package/dist/esm/commands/database/mysql/charsets.js +2 -6
- package/dist/esm/commands/database/mysql/create.js +2 -2
- package/dist/esm/commands/database/mysql/delete.js +2 -2
- package/dist/esm/commands/database/mysql/list.d.ts +1 -2
- package/dist/esm/commands/database/mysql/list.js +2 -2
- package/dist/esm/commands/database/mysql/phpmyadmin.js +1 -1
- package/dist/esm/commands/database/mysql/user/list.d.ts +2 -3
- package/dist/esm/commands/database/mysql/user/list.js +3 -4
- package/dist/esm/commands/database/mysql/versions.d.ts +1 -2
- package/dist/esm/commands/database/mysql/versions.js +1 -3
- package/dist/esm/commands/database/redis/create.js +2 -2
- package/dist/esm/commands/database/redis/get.d.ts +1 -3
- package/dist/esm/commands/database/redis/get.js +0 -3
- package/dist/esm/commands/database/redis/list.d.ts +1 -2
- package/dist/esm/commands/database/redis/list.js +3 -5
- package/dist/esm/commands/database/redis/versions.d.ts +1 -2
- package/dist/esm/commands/database/redis/versions.js +2 -3
- package/dist/esm/commands/domain/dnszone/get.d.ts +9 -8
- package/dist/esm/commands/domain/dnszone/get.js +22 -9
- package/dist/esm/commands/domain/dnszone/list.d.ts +11 -6
- package/dist/esm/commands/domain/dnszone/list.js +65 -10
- package/dist/esm/commands/domain/dnszone/update.d.ts +28 -0
- package/dist/esm/commands/domain/dnszone/update.js +176 -0
- package/dist/esm/commands/domain/get.d.ts +9 -7
- package/dist/esm/commands/domain/get.js +23 -10
- package/dist/esm/commands/domain/list.d.ts +4 -3
- package/dist/esm/commands/domain/list.js +30 -5
- package/dist/esm/commands/domain/virtualhost/create.d.ts +1 -3
- package/dist/esm/commands/domain/virtualhost/create.js +9 -25
- package/dist/esm/commands/domain/virtualhost/delete.js +1 -1
- package/dist/esm/commands/domain/virtualhost/get.js +2 -14
- package/dist/esm/commands/domain/virtualhost/list.d.ts +1 -3
- package/dist/esm/commands/domain/virtualhost/list.js +5 -8
- package/dist/esm/commands/mail/address/create.d.ts +4 -0
- package/dist/esm/commands/mail/address/create.js +59 -5
- package/dist/esm/commands/mail/address/delete.js +1 -1
- package/dist/esm/commands/mail/address/list.d.ts +2 -2
- package/dist/esm/commands/mail/address/list.js +2 -4
- package/dist/esm/commands/mail/deliverybox/list.js +2 -2
- package/dist/esm/commands/org/invite/list-own.d.ts +1 -1
- package/dist/esm/commands/org/invite/revoke.js +2 -2
- package/dist/esm/commands/org/membership/list-own.d.ts +1 -1
- package/dist/esm/commands/org/membership/revoke.js +2 -2
- package/dist/esm/commands/project/create.js +2 -2
- package/dist/esm/commands/project/delete.d.ts +0 -1
- package/dist/esm/commands/project/delete.js +4 -8
- package/dist/esm/commands/project/filesystem/usage.d.ts +1 -1
- package/dist/esm/commands/project/filesystem/usage.js +3 -3
- package/dist/esm/commands/project/get.js +5 -5
- package/dist/esm/commands/project/invite/get.js +1 -1
- package/dist/esm/commands/project/invite/list.js +2 -2
- package/dist/esm/commands/project/membership/get.js +1 -1
- package/dist/esm/commands/project/membership/list.js +5 -5
- package/dist/esm/commands/project/ssh.d.ts +2 -2
- package/dist/esm/commands/project/ssh.js +4 -5
- package/dist/esm/commands/project/update.d.ts +2 -2
- package/dist/esm/commands/project/update.js +4 -5
- package/dist/esm/commands/server/get.d.ts +1 -3
- package/dist/esm/commands/server/get.js +2 -5
- package/dist/esm/commands/sftp-user/list.js +2 -2
- package/dist/esm/commands/ssh-user/list.js +2 -2
- package/dist/esm/lib/app/flags.d.ts +2 -3
- package/dist/esm/lib/app/flags.js +18 -8
- package/dist/esm/lib/assert_success.d.ts +3 -0
- package/dist/esm/lib/assert_success.js +7 -0
- package/dist/esm/lib/context.d.ts +26 -5
- package/dist/esm/lib/context.js +23 -16
- package/dist/esm/lib/context_flags.d.ts +25 -7
- package/dist/esm/lib/context_flags.js +29 -20
- package/dist/esm/lib/context_terraform.d.ts +6 -0
- package/dist/esm/lib/context_terraform.js +61 -0
- package/dist/esm/lib/context_user.d.ts +10 -0
- package/dist/esm/lib/context_user.js +41 -0
- package/dist/esm/lib/database/mysql/connect.js +1 -1
- package/dist/esm/lib/domain/dnszone/flags.d.ts +1 -0
- package/dist/esm/lib/domain/dnszone/flags.js +19 -0
- package/dist/esm/lib/domain/dnszone/records.d.ts +17 -0
- package/dist/esm/lib/domain/dnszone/records.js +18 -0
- package/dist/esm/lib/domain/flags.d.ts +1 -0
- package/dist/esm/lib/domain/flags.js +20 -0
- package/dist/esm/lib/org/flags.d.ts +1 -13
- package/dist/esm/lib/org/flags.js +1 -1
- package/dist/esm/lib/project/flags.d.ts +15 -13
- package/dist/esm/lib/project/flags.js +52 -2
- package/dist/esm/lib/project/ingress.js +4 -2
- package/dist/esm/lib/server/flags.d.ts +1 -13
- package/dist/esm/lib/server/flags.js +1 -1
- package/dist/esm/rendering/process/components/ProcessValidationErrors.js +3 -1
- package/dist/esm/rendering/react/RenderBaseCommand.d.ts +3 -0
- package/dist/esm/rendering/react/RenderBaseCommand.js +7 -0
- package/dist/esm/rendering/react/components/AppInstallation/AppInstallationDetails.js +8 -1
- package/dist/esm/rendering/react/components/BooleanValue.d.ts +4 -0
- package/dist/esm/rendering/react/components/BooleanValue.js +9 -0
- package/dist/esm/rendering/react/components/CronJob/CronJobDetails.d.ts +8 -0
- package/dist/esm/rendering/react/components/CronJob/CronJobDetails.js +48 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneDetails.d.ts +6 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneDetails.js +12 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecords.d.ts +6 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecords.js +17 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsA.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsA.js +14 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsAAAA.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsAAAA.js +14 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsMX.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsMX.js +13 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsSRV.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsSRV.js +9 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsTXT.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/DnsZoneRecordsTXT.js +9 -0
- package/dist/esm/rendering/react/components/DnsZone/RecordComponent.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/RecordComponent.js +1 -0
- package/dist/esm/rendering/react/components/DnsZone/RecordSetManagedByMittwald.d.ts +1 -0
- package/dist/esm/rendering/react/components/DnsZone/RecordSetManagedByMittwald.js +3 -0
- package/dist/esm/rendering/react/components/DnsZone/RecordSetValues.d.ts +4 -0
- package/dist/esm/rendering/react/components/DnsZone/RecordSetValues.js +5 -0
- package/dist/esm/rendering/react/components/Domain/DomainBaseDetails.d.ts +6 -0
- package/dist/esm/rendering/react/components/Domain/DomainBaseDetails.js +13 -0
- package/dist/esm/rendering/react/components/Domain/DomainDetails.d.ts +6 -0
- package/dist/esm/rendering/react/components/Domain/DomainDetails.js +7 -0
- package/dist/esm/rendering/react/components/Domain/DomainHandle.d.ts +7 -0
- package/dist/esm/rendering/react/components/Domain/DomainHandle.js +24 -0
- package/dist/esm/rendering/react/components/LocalFilename.d.ts +5 -0
- package/dist/esm/rendering/react/components/LocalFilename.js +14 -0
- package/dist/esm/rendering/react/components/Note.d.ts +1 -0
- package/dist/esm/rendering/react/components/Note.js +1 -1
- package/dist/esm/rendering/react/components/Project/ProjectSimpleStatus.d.ts +7 -0
- package/dist/esm/rendering/react/components/Project/ProjectSimpleStatus.js +19 -0
- package/dist/esm/rendering/react/components/Project/ProjectStatus.d.ts +2 -2
- package/dist/esm/rendering/react/components/Project/ProjectStatus.js +2 -2
- package/dist/esm/rendering/react/components/Value.js +1 -1
- package/package.json +14 -13
- package/dist/esm/commands/domain/ownership/get.d.ts +0 -15
- package/dist/esm/commands/domain/ownership/get.js +0 -19
- package/dist/esm/commands/domain/ownership/list.d.ts +0 -16
- package/dist/esm/commands/domain/ownership/list.js +0 -21
- package/dist/esm/rendering/react/components/Ingress/DomainOwnership.d.ts +0 -8
- package/dist/esm/rendering/react/components/Ingress/DomainOwnership.js +0 -7
- package/dist/esm/rendering/react/components/Project/ProjectReadiness.d.ts +0 -7
- package/dist/esm/rendering/react/components/Project/ProjectReadiness.js +0 -16
package/README.md
CHANGED
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
|
|
25
25
|
#### macOS, using Homebrew
|
|
26
26
|
|
|
27
|
-
Installation using [Homebrew](https://brew.sh/) is the recommended way of
|
|
27
|
+
Installation using [Homebrew](https://brew.sh/) is the recommended way of
|
|
28
|
+
installation on macOS.
|
|
28
29
|
|
|
29
30
|
```shell
|
|
30
31
|
$ brew tap mittwald/cli
|
|
@@ -33,11 +34,17 @@ $ brew install mw
|
|
|
33
34
|
|
|
34
35
|
#### Windows, using the Installer
|
|
35
36
|
|
|
36
|
-
Find the appropriate Windows installer from the
|
|
37
|
+
Find the appropriate Windows installer from the
|
|
38
|
+
[releases page](https://github.com/mittwald/cli/releases) and run the installer.
|
|
39
|
+
After running the installer, you should be able to use the `mw` command on
|
|
40
|
+
either the CMD prompt or PowerShell.
|
|
37
41
|
|
|
38
42
|
#### Any OS, using Node.js+NPM
|
|
39
43
|
|
|
40
|
-
Installing the CLI via NPM will work on any OS; however we cannot guarantee
|
|
44
|
+
Installing the CLI via NPM will work on any OS; however we cannot guarantee
|
|
45
|
+
stability, because functionality of the CLI may depend in the Node.js runtime
|
|
46
|
+
already installed on your system. Also, the automatic upgrade will not work when
|
|
47
|
+
using NPM; remember to run `npm upgrade -g @mittwald/cli` occasionally.
|
|
41
48
|
|
|
42
49
|
```shell
|
|
43
50
|
$ npm install -g @mittwald/cli
|
|
@@ -45,7 +52,12 @@ $ npm install -g @mittwald/cli
|
|
|
45
52
|
|
|
46
53
|
#### Any OS, using Docker
|
|
47
54
|
|
|
48
|
-
There is also the
|
|
55
|
+
There is also the
|
|
56
|
+
[`mittwald/cli` Docker image](https://hub.docker.com/r/mittwald/cli) that you
|
|
57
|
+
can use instead of installing the CLI on your system. In case of the Docker
|
|
58
|
+
container, authentication works a bit differently than described below: Make
|
|
59
|
+
sure that there is an environment variable `MITTWALD_API_TOKEN` present on your
|
|
60
|
+
system; you can then pass that environment variable into your container:
|
|
49
61
|
|
|
50
62
|
```shell
|
|
51
63
|
$ export MITTWALD_API_TOKEN=<enter token here>
|
|
@@ -54,7 +66,9 @@ $ docker run --rm -it -e MITTWALD_API_TOKEN mittwald/cli help
|
|
|
54
66
|
|
|
55
67
|
### Authentication
|
|
56
68
|
|
|
57
|
-
To use the CLI, you will need an
|
|
69
|
+
To use the CLI, you will need an
|
|
70
|
+
[mStudio API token](https://studio.mittwald.de/app/profile/api-tokens). With
|
|
71
|
+
your token in your clipboard, run the `mw login token` command:
|
|
58
72
|
|
|
59
73
|
```shell
|
|
60
74
|
$ mw login token
|
|
@@ -62,6 +76,25 @@ Enter your mStudio API token: ****************
|
|
|
62
76
|
token saved to '/Users/mhelmich/.config/mw/token'
|
|
63
77
|
```
|
|
64
78
|
|
|
79
|
+
### Setting up shell autocompletion
|
|
80
|
+
|
|
81
|
+
The `mw` CLI offers a lot of commands and flags, and it can be hard to remember
|
|
82
|
+
all of them. To make your life easier, the CLI offers autocompletion for the
|
|
83
|
+
Bash and ZSH shells. To enable autocompletion, run the following command:
|
|
84
|
+
|
|
85
|
+
```shell
|
|
86
|
+
$ mw autocomplete
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
After that, follow the instructions printed by that command (those are specific
|
|
90
|
+
to your shell -- Bash, ZSH and Powershell are supported).
|
|
91
|
+
|
|
92
|
+
## Contributing
|
|
93
|
+
|
|
94
|
+
If you are a developer (either at @mittwald or an external contributor) and want
|
|
95
|
+
to contribute to the CLI, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
96
|
+
document.
|
|
97
|
+
|
|
65
98
|
## Usage
|
|
66
99
|
|
|
67
100
|
```sh-session
|
|
@@ -79,15 +112,15 @@ USAGE
|
|
|
79
112
|
## Commands
|
|
80
113
|
|
|
81
114
|
<!-- commands -->
|
|
82
|
-
* [`mw app copy INSTALLATION-ID`](#mw-app-copy-installation-id)
|
|
115
|
+
* [`mw app copy [INSTALLATION-ID]`](#mw-app-copy-installation-id)
|
|
83
116
|
* [`mw app create node`](#mw-app-create-node)
|
|
84
117
|
* [`mw app create php`](#mw-app-create-php)
|
|
85
118
|
* [`mw app create python`](#mw-app-create-python)
|
|
86
119
|
* [`mw app create static`](#mw-app-create-static)
|
|
87
120
|
* [`mw app dependency list`](#mw-app-dependency-list)
|
|
88
|
-
* [`mw app dependency update INSTALLATION-ID`](#mw-app-dependency-update-installation-id)
|
|
121
|
+
* [`mw app dependency update [INSTALLATION-ID]`](#mw-app-dependency-update-installation-id)
|
|
89
122
|
* [`mw app dependency versions SYSTEMSOFTWARE`](#mw-app-dependency-versions-systemsoftware)
|
|
90
|
-
* [`mw app get INSTALLATION-ID`](#mw-app-get-installation-id)
|
|
123
|
+
* [`mw app get [INSTALLATION-ID]`](#mw-app-get-installation-id)
|
|
91
124
|
* [`mw app install contao`](#mw-app-install-contao)
|
|
92
125
|
* [`mw app install drupal`](#mw-app-install-drupal)
|
|
93
126
|
* [`mw app install grav`](#mw-app-install-grav)
|
|
@@ -99,9 +132,10 @@ USAGE
|
|
|
99
132
|
* [`mw app install typo3`](#mw-app-install-typo3)
|
|
100
133
|
* [`mw app install wordpress`](#mw-app-install-wordpress)
|
|
101
134
|
* [`mw app list`](#mw-app-list)
|
|
102
|
-
* [`mw app ssh INSTALLATION-ID`](#mw-app-ssh-installation-id)
|
|
103
|
-
* [`mw app uninstall INSTALLATION-ID`](#mw-app-uninstall-installation-id)
|
|
135
|
+
* [`mw app ssh [INSTALLATION-ID]`](#mw-app-ssh-installation-id)
|
|
136
|
+
* [`mw app uninstall [INSTALLATION-ID]`](#mw-app-uninstall-installation-id)
|
|
104
137
|
* [`mw app versions [APP]`](#mw-app-versions-app)
|
|
138
|
+
* [`mw autocomplete [SHELL]`](#mw-autocomplete-shell)
|
|
105
139
|
* [`mw backup create`](#mw-backup-create)
|
|
106
140
|
* [`mw backup delete BACKUP-ID`](#mw-backup-delete-backup-id)
|
|
107
141
|
* [`mw backup download BACKUP-ID`](#mw-backup-download-backup-id)
|
|
@@ -117,10 +151,14 @@ USAGE
|
|
|
117
151
|
* [`mw conversation reply ID`](#mw-conversation-reply-id)
|
|
118
152
|
* [`mw conversation show ID`](#mw-conversation-show-id)
|
|
119
153
|
* [`mw conversation show2 CONVERSATIONID`](#mw-conversation-show2-conversationid)
|
|
154
|
+
* [`mw cronjob create`](#mw-cronjob-create)
|
|
155
|
+
* [`mw cronjob delete CRONJOB-ID`](#mw-cronjob-delete-cronjob-id)
|
|
156
|
+
* [`mw cronjob execute CRONJOB-ID`](#mw-cronjob-execute-cronjob-id)
|
|
157
|
+
* [`mw cronjob execution abort CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-abort-cronjob-id-execution-id)
|
|
120
158
|
* [`mw cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-get-cronjob-id-execution-id)
|
|
121
159
|
* [`mw cronjob execution list`](#mw-cronjob-execution-list)
|
|
122
160
|
* [`mw cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-logs-cronjob-id-execution-id)
|
|
123
|
-
* [`mw cronjob get
|
|
161
|
+
* [`mw cronjob get CRONJOB-ID`](#mw-cronjob-get-cronjob-id)
|
|
124
162
|
* [`mw cronjob list`](#mw-cronjob-list)
|
|
125
163
|
* [`mw database mysql charsets`](#mw-database-mysql-charsets)
|
|
126
164
|
* [`mw database mysql create`](#mw-database-mysql-create)
|
|
@@ -139,12 +177,11 @@ USAGE
|
|
|
139
177
|
* [`mw database redis list`](#mw-database-redis-list)
|
|
140
178
|
* [`mw database redis shell DATABASE-ID`](#mw-database-redis-shell-database-id)
|
|
141
179
|
* [`mw database redis versions`](#mw-database-redis-versions)
|
|
142
|
-
* [`mw domain dnszone get
|
|
180
|
+
* [`mw domain dnszone get DNSZONE-ID`](#mw-domain-dnszone-get-dnszone-id)
|
|
143
181
|
* [`mw domain dnszone list`](#mw-domain-dnszone-list)
|
|
182
|
+
* [`mw domain dnszone update DNSZONE-ID RECORD-SET`](#mw-domain-dnszone-update-dnszone-id-record-set)
|
|
144
183
|
* [`mw domain get DOMAIN-ID`](#mw-domain-get-domain-id)
|
|
145
184
|
* [`mw domain list`](#mw-domain-list)
|
|
146
|
-
* [`mw domain ownership get DOMAINOWNERSHIPID`](#mw-domain-ownership-get-domainownershipid)
|
|
147
|
-
* [`mw domain ownership list`](#mw-domain-ownership-list)
|
|
148
185
|
* [`mw domain virtualhost create`](#mw-domain-virtualhost-create)
|
|
149
186
|
* [`mw domain virtualhost delete VIRTUAL-HOST-ID`](#mw-domain-virtualhost-delete-virtual-host-id)
|
|
150
187
|
* [`mw domain virtualhost get INGRESS-ID`](#mw-domain-virtualhost-get-ingress-id)
|
|
@@ -179,7 +216,6 @@ USAGE
|
|
|
179
216
|
* [`mw project cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-get-cronjob-id-execution-id)
|
|
180
217
|
* [`mw project cronjob execution list`](#mw-project-cronjob-execution-list)
|
|
181
218
|
* [`mw project cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-logs-cronjob-id-execution-id)
|
|
182
|
-
* [`mw project cronjob get CRONJOBID`](#mw-project-cronjob-get-cronjobid)
|
|
183
219
|
* [`mw project cronjob list`](#mw-project-cronjob-list)
|
|
184
220
|
* [`mw project delete [PROJECT-ID]`](#mw-project-delete-project-id)
|
|
185
221
|
* [`mw project filesystem usage [PROJECT-ID]`](#mw-project-filesystem-usage-project-id)
|
|
@@ -213,20 +249,21 @@ USAGE
|
|
|
213
249
|
* [`mw user ssh-key get KEY-ID`](#mw-user-ssh-key-get-key-id)
|
|
214
250
|
* [`mw user ssh-key list`](#mw-user-ssh-key-list)
|
|
215
251
|
|
|
216
|
-
## `mw app copy INSTALLATION-ID`
|
|
252
|
+
## `mw app copy [INSTALLATION-ID]`
|
|
217
253
|
|
|
218
254
|
Copy an app within a project
|
|
219
255
|
|
|
220
256
|
```
|
|
221
257
|
USAGE
|
|
222
|
-
$ mw app copy INSTALLATION-ID --description <value> [-q]
|
|
258
|
+
$ mw app copy [INSTALLATION-ID] --description <value> [-q]
|
|
223
259
|
|
|
224
260
|
ARGUMENTS
|
|
225
|
-
INSTALLATION-ID ID of
|
|
261
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
262
|
+
in the context
|
|
226
263
|
|
|
227
264
|
FLAGS
|
|
228
|
-
-q, --quiet
|
|
229
|
-
|
|
265
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
266
|
+
--description=<value> (required) set a description for the new app installation
|
|
230
267
|
|
|
231
268
|
DESCRIPTION
|
|
232
269
|
Copy an app within a project
|
|
@@ -252,7 +289,7 @@ FLAGS
|
|
|
252
289
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
253
290
|
-w, --wait Wait for your custom Node.js to be ready.
|
|
254
291
|
--json
|
|
255
|
-
|
|
292
|
+
--site-title=<value> Site Title for your custom Node.js installation.
|
|
256
293
|
|
|
257
294
|
DESCRIPTION
|
|
258
295
|
Creates new custom Node.js installation.
|
|
@@ -285,14 +322,14 @@ USAGE
|
|
|
285
322
|
$ mw app create php --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
286
323
|
|
|
287
324
|
FLAGS
|
|
288
|
-
-p, --project-id=<value>
|
|
289
|
-
|
|
290
|
-
-q, --quiet
|
|
291
|
-
-w, --wait
|
|
292
|
-
|
|
293
|
-
|
|
325
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
326
|
+
context
|
|
327
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
328
|
+
-w, --wait Wait for your custom PHP to be ready.
|
|
329
|
+
--document-root=<value> (required) [default: /] The document root from which your custom PHP will be served
|
|
330
|
+
(relative to the installation path)
|
|
294
331
|
--json
|
|
295
|
-
|
|
332
|
+
--site-title=<value> Site Title for your custom PHP installation.
|
|
296
333
|
|
|
297
334
|
DESCRIPTION
|
|
298
335
|
Creates new custom PHP installation.
|
|
@@ -332,14 +369,14 @@ USAGE
|
|
|
332
369
|
$ mw app create python --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
333
370
|
|
|
334
371
|
FLAGS
|
|
335
|
-
-p, --project-id=<value>
|
|
336
|
-
|
|
337
|
-
-q, --quiet
|
|
338
|
-
-w, --wait
|
|
339
|
-
|
|
340
|
-
|
|
372
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
373
|
+
context
|
|
374
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
375
|
+
-w, --wait Wait for your custom python site to be ready.
|
|
376
|
+
--document-root=<value> (required) [default: /] The document root from which your custom python site will be
|
|
377
|
+
served (relative to the installation path)
|
|
341
378
|
--json
|
|
342
|
-
|
|
379
|
+
--site-title=<value> Site Title for your custom python site installation.
|
|
343
380
|
|
|
344
381
|
DESCRIPTION
|
|
345
382
|
Creates new custom python site installation.
|
|
@@ -380,14 +417,14 @@ USAGE
|
|
|
380
417
|
$ mw app create static --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
381
418
|
|
|
382
419
|
FLAGS
|
|
383
|
-
-p, --project-id=<value>
|
|
384
|
-
|
|
385
|
-
-q, --quiet
|
|
386
|
-
-w, --wait
|
|
387
|
-
|
|
388
|
-
|
|
420
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
421
|
+
context
|
|
422
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
423
|
+
-w, --wait Wait for your custom static site to be ready.
|
|
424
|
+
--document-root=<value> (required) [default: /] The document root from which your custom static site will be
|
|
425
|
+
served (relative to the installation path)
|
|
389
426
|
--json
|
|
390
|
-
|
|
427
|
+
--site-title=<value> Site Title for your custom static site installation.
|
|
391
428
|
|
|
392
429
|
DESCRIPTION
|
|
393
430
|
Creates new custom static site installation.
|
|
@@ -425,40 +462,38 @@ Get all available dependencies
|
|
|
425
462
|
|
|
426
463
|
```
|
|
427
464
|
USAGE
|
|
428
|
-
$ mw app dependency list [--columns <value> | -x] [--
|
|
429
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
465
|
+
$ mw app dependency list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
430
466
|
|
|
431
467
|
FLAGS
|
|
432
|
-
-
|
|
433
|
-
|
|
434
|
-
--
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
<options: csv|json|yaml>
|
|
440
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
468
|
+
-o, --output=<option> output in a more machine friendly format
|
|
469
|
+
<options: json|yaml|csv>
|
|
470
|
+
-x, --extended show extra columns
|
|
471
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
472
|
+
--csv output is csv format [alias: --output=csv]
|
|
473
|
+
--no-header hide table header from output
|
|
474
|
+
--no-truncate do not truncate output to fit screen
|
|
441
475
|
|
|
442
476
|
DESCRIPTION
|
|
443
477
|
Get all available dependencies
|
|
444
478
|
```
|
|
445
479
|
|
|
446
|
-
## `mw app dependency update INSTALLATION-ID`
|
|
480
|
+
## `mw app dependency update [INSTALLATION-ID]`
|
|
447
481
|
|
|
448
482
|
Update the dependencies of an app
|
|
449
483
|
|
|
450
484
|
```
|
|
451
485
|
USAGE
|
|
452
|
-
$ mw app dependency update INSTALLATION-ID --set <value> [-q] [--update-policy none|inheritedFromApp|patchLevel|all]
|
|
486
|
+
$ mw app dependency update [INSTALLATION-ID] --set <value> [-q] [--update-policy none|inheritedFromApp|patchLevel|all]
|
|
453
487
|
|
|
454
488
|
ARGUMENTS
|
|
455
|
-
INSTALLATION-ID ID of
|
|
489
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
490
|
+
in the context
|
|
456
491
|
|
|
457
492
|
FLAGS
|
|
458
|
-
-q, --quiet
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
493
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
494
|
+
--set=<value>... (required) set a dependency to a specific version
|
|
495
|
+
--update-policy=<option> [default: patchLevel] set the update policy for the configured dependencies
|
|
496
|
+
<options: none|inheritedFromApp|patchLevel|all>
|
|
462
497
|
|
|
463
498
|
EXAMPLES
|
|
464
499
|
Update Node.js version to newest available from the 18.x branch
|
|
@@ -485,37 +520,36 @@ Get all available versions of a particular dependency
|
|
|
485
520
|
|
|
486
521
|
```
|
|
487
522
|
USAGE
|
|
488
|
-
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--
|
|
489
|
-
|
|
523
|
+
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
524
|
+
json|yaml|csv | | ]
|
|
490
525
|
|
|
491
526
|
ARGUMENTS
|
|
492
527
|
SYSTEMSOFTWARE name of the systemsoftware for which to list versions
|
|
493
528
|
|
|
494
529
|
FLAGS
|
|
495
|
-
-
|
|
496
|
-
|
|
497
|
-
--
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
<options: csv|json|yaml>
|
|
503
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
530
|
+
-o, --output=<option> output in a more machine friendly format
|
|
531
|
+
<options: json|yaml|csv>
|
|
532
|
+
-x, --extended show extra columns
|
|
533
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
534
|
+
--csv output is csv format [alias: --output=csv]
|
|
535
|
+
--no-header hide table header from output
|
|
536
|
+
--no-truncate do not truncate output to fit screen
|
|
504
537
|
|
|
505
538
|
DESCRIPTION
|
|
506
539
|
Get all available versions of a particular dependency
|
|
507
540
|
```
|
|
508
541
|
|
|
509
|
-
## `mw app get INSTALLATION-ID`
|
|
542
|
+
## `mw app get [INSTALLATION-ID]`
|
|
510
543
|
|
|
511
544
|
Get details about an app installation
|
|
512
545
|
|
|
513
546
|
```
|
|
514
547
|
USAGE
|
|
515
|
-
$ mw app get INSTALLATION-ID [-o json|yaml | | ]
|
|
548
|
+
$ mw app get [INSTALLATION-ID] [-o json|yaml | | ]
|
|
516
549
|
|
|
517
550
|
ARGUMENTS
|
|
518
|
-
INSTALLATION-ID ID of
|
|
551
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
552
|
+
in the context
|
|
519
553
|
|
|
520
554
|
FLAGS
|
|
521
555
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -536,19 +570,20 @@ USAGE
|
|
|
536
570
|
[--json]
|
|
537
571
|
|
|
538
572
|
FLAGS
|
|
539
|
-
-p, --project-id=<value>
|
|
540
|
-
|
|
541
|
-
-q, --quiet
|
|
542
|
-
-w, --wait
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
573
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
574
|
+
context
|
|
575
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
576
|
+
-w, --wait Wait for your Contao to be ready.
|
|
577
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
578
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
579
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
580
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
581
|
+
--admin-user=<value> Username for your administrator-user.
|
|
582
|
+
--host=<value> Host to initially configure your Contao installation with; needs to be created
|
|
583
|
+
separately.
|
|
549
584
|
--json
|
|
550
|
-
|
|
551
|
-
|
|
585
|
+
--site-title=<value> Site Title for your Contao installation.
|
|
586
|
+
--version=<value> (required) [default: latest] Version of Contao to be installed.
|
|
552
587
|
|
|
553
588
|
DESCRIPTION
|
|
554
589
|
Creates new Contao installation.
|
|
@@ -625,17 +660,17 @@ USAGE
|
|
|
625
660
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
626
661
|
|
|
627
662
|
FLAGS
|
|
628
|
-
-p, --project-id=<value>
|
|
629
|
-
|
|
630
|
-
-q, --quiet
|
|
631
|
-
-w, --wait
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
663
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
664
|
+
context
|
|
665
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
666
|
+
-w, --wait Wait for your Drupal to be ready.
|
|
667
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
668
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
669
|
+
--admin-user=<value> Username for your administrator-user.
|
|
670
|
+
--host=<value> Host to initially configure your Drupal installation with; needs to be created separately.
|
|
636
671
|
--json
|
|
637
|
-
|
|
638
|
-
|
|
672
|
+
--site-title=<value> Site Title for your Drupal installation.
|
|
673
|
+
--version=<value> (required) [default: latest] Version of Drupal to be installed.
|
|
639
674
|
|
|
640
675
|
DESCRIPTION
|
|
641
676
|
Creates new Drupal installation.
|
|
@@ -700,18 +735,18 @@ USAGE
|
|
|
700
735
|
[--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>] [-w] [--json]
|
|
701
736
|
|
|
702
737
|
FLAGS
|
|
703
|
-
-p, --project-id=<value>
|
|
704
|
-
|
|
705
|
-
-q, --quiet
|
|
706
|
-
-w, --wait
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
738
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
739
|
+
context
|
|
740
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
741
|
+
-w, --wait Wait for your Grav to be ready.
|
|
742
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
743
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
744
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
745
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
746
|
+
--admin-user=<value> Username for your administrator-user.
|
|
712
747
|
--json
|
|
713
|
-
|
|
714
|
-
|
|
748
|
+
--site-title=<value> Site Title for your Grav installation.
|
|
749
|
+
--version=<value> (required) [default: latest] Version of Grav to be installed.
|
|
715
750
|
|
|
716
751
|
DESCRIPTION
|
|
717
752
|
Creates new Grav installation.
|
|
@@ -782,19 +817,20 @@ USAGE
|
|
|
782
817
|
[--json]
|
|
783
818
|
|
|
784
819
|
FLAGS
|
|
785
|
-
-p, --project-id=<value>
|
|
786
|
-
|
|
787
|
-
-q, --quiet
|
|
788
|
-
-w, --wait
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
820
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
821
|
+
context
|
|
822
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
823
|
+
-w, --wait Wait for your Joomla! to be ready.
|
|
824
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
825
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
826
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
827
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
828
|
+
--admin-user=<value> Username for your administrator-user.
|
|
829
|
+
--host=<value> Host to initially configure your Joomla! installation with; needs to be created
|
|
830
|
+
separately.
|
|
795
831
|
--json
|
|
796
|
-
|
|
797
|
-
|
|
832
|
+
--site-title=<value> Site Title for your Joomla! installation.
|
|
833
|
+
--version=<value> (required) [default: latest] Version of Joomla! to be installed.
|
|
798
834
|
|
|
799
835
|
DESCRIPTION
|
|
800
836
|
Creates new Joomla! installation.
|
|
@@ -871,17 +907,17 @@ USAGE
|
|
|
871
907
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
872
908
|
|
|
873
909
|
FLAGS
|
|
874
|
-
-p, --project-id=<value>
|
|
875
|
-
|
|
876
|
-
-q, --quiet
|
|
877
|
-
-w, --wait
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
910
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
911
|
+
context
|
|
912
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
913
|
+
-w, --wait Wait for your Matomo to be ready.
|
|
914
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
915
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
916
|
+
--admin-user=<value> Username for your administrator-user.
|
|
917
|
+
--host=<value> Host to initially configure your Matomo installation with; needs to be created separately.
|
|
882
918
|
--json
|
|
883
|
-
|
|
884
|
-
|
|
919
|
+
--site-title=<value> Site Title for your Matomo installation.
|
|
920
|
+
--version=<value> (required) [default: latest] Version of Matomo to be installed.
|
|
885
921
|
|
|
886
922
|
DESCRIPTION
|
|
887
923
|
Creates new Matomo installation.
|
|
@@ -946,18 +982,18 @@ USAGE
|
|
|
946
982
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
947
983
|
|
|
948
984
|
FLAGS
|
|
949
|
-
-p, --project-id=<value>
|
|
950
|
-
|
|
951
|
-
-q, --quiet
|
|
952
|
-
-w, --wait
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
985
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
986
|
+
context
|
|
987
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
988
|
+
-w, --wait Wait for your Shopware 6 to be ready.
|
|
989
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
990
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
991
|
+
--admin-user=<value> Username for your administrator-user.
|
|
992
|
+
--host=<value> Host to initially configure your Shopware 6 installation with; needs to be created
|
|
993
|
+
separately.
|
|
958
994
|
--json
|
|
959
|
-
|
|
960
|
-
|
|
995
|
+
--site-title=<value> Site Title for your Shopware 6 installation.
|
|
996
|
+
--version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
|
|
961
997
|
|
|
962
998
|
DESCRIPTION
|
|
963
999
|
Creates new Shopware 6 installation.
|
|
@@ -1024,23 +1060,23 @@ USAGE
|
|
|
1024
1060
|
[--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
|
|
1025
1061
|
|
|
1026
1062
|
FLAGS
|
|
1027
|
-
-p, --project-id=<value>
|
|
1028
|
-
|
|
1029
|
-
-q, --quiet
|
|
1030
|
-
-w, --wait
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1063
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1064
|
+
context
|
|
1065
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1066
|
+
-w, --wait Wait for your Shopware 5 to be ready.
|
|
1067
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1068
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
1069
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
1070
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1071
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1072
|
+
--host=<value> Host to initially configure your Shopware 5 installation with; needs to be created
|
|
1073
|
+
separately.
|
|
1038
1074
|
--json
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1075
|
+
--shop-currency=<value> Currency your Shopware 5 will be working with.
|
|
1076
|
+
--shop-email=<value> E-Mail-Address your Shopware 5 will be working with.
|
|
1077
|
+
--shop-lang=<value> Language your Shopware 5 will be working with.
|
|
1078
|
+
--site-title=<value> Site Title for your Shopware 5 installation.
|
|
1079
|
+
--version=<value> (required) [default: latest] Version of Shopware 5 to be installed.
|
|
1044
1080
|
|
|
1045
1081
|
DESCRIPTION
|
|
1046
1082
|
Creates new Shopware 5 installation.
|
|
@@ -1138,23 +1174,23 @@ USAGE
|
|
|
1138
1174
|
[--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
|
|
1139
1175
|
|
|
1140
1176
|
FLAGS
|
|
1141
|
-
-p, --project-id=<value>
|
|
1142
|
-
|
|
1143
|
-
-q, --quiet
|
|
1144
|
-
-w, --wait
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1177
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1178
|
+
context
|
|
1179
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1180
|
+
-w, --wait Wait for your Shopware 6 to be ready.
|
|
1181
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1182
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
1183
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
1184
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1185
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1186
|
+
--host=<value> Host to initially configure your Shopware 6 installation with; needs to be created
|
|
1187
|
+
separately.
|
|
1152
1188
|
--json
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1189
|
+
--shop-currency=<value> Currency your Shopware 6 will be working with.
|
|
1190
|
+
--shop-email=<value> E-Mail-Address your Shopware 6 will be working with.
|
|
1191
|
+
--shop-lang=<value> Language your Shopware 6 will be working with.
|
|
1192
|
+
--site-title=<value> Site Title for your Shopware 6 installation.
|
|
1193
|
+
--version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
|
|
1158
1194
|
|
|
1159
1195
|
DESCRIPTION
|
|
1160
1196
|
Creates new Shopware 6 installation.
|
|
@@ -1251,19 +1287,20 @@ USAGE
|
|
|
1251
1287
|
[--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
1252
1288
|
|
|
1253
1289
|
FLAGS
|
|
1254
|
-
-p, --project-id=<value>
|
|
1255
|
-
|
|
1256
|
-
-q, --quiet
|
|
1257
|
-
-w, --wait
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
1290
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1291
|
+
context
|
|
1292
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1293
|
+
-w, --wait Wait for your TYPO3 to be ready.
|
|
1294
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1295
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1296
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1297
|
+
--host=<value> Host to initially configure your TYPO3 installation with; needs to be created separately.
|
|
1298
|
+
--install-mode=<option> (required) [default: composer] The installation variant your TYPO3 will be installed
|
|
1299
|
+
with.
|
|
1300
|
+
<options: composer|symlink>
|
|
1264
1301
|
--json
|
|
1265
|
-
|
|
1266
|
-
|
|
1302
|
+
--site-title=<value> Site Title for your TYPO3 installation.
|
|
1303
|
+
--version=<value> (required) [default: latest] Version of TYPO3 to be installed.
|
|
1267
1304
|
|
|
1268
1305
|
DESCRIPTION
|
|
1269
1306
|
Creates new TYPO3 installation.
|
|
@@ -1336,18 +1373,18 @@ USAGE
|
|
|
1336
1373
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
1337
1374
|
|
|
1338
1375
|
FLAGS
|
|
1339
|
-
-p, --project-id=<value>
|
|
1340
|
-
|
|
1341
|
-
-q, --quiet
|
|
1342
|
-
-w, --wait
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1376
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1377
|
+
context
|
|
1378
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1379
|
+
-w, --wait Wait for your WordPress to be ready.
|
|
1380
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1381
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1382
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1383
|
+
--host=<value> Host to initially configure your WordPress installation with; needs to be created
|
|
1384
|
+
separately.
|
|
1348
1385
|
--json
|
|
1349
|
-
|
|
1350
|
-
|
|
1386
|
+
--site-title=<value> Site Title for your WordPress installation.
|
|
1387
|
+
--version=<value> (required) [default: latest] Version of WordPress to be installed.
|
|
1351
1388
|
|
|
1352
1389
|
DESCRIPTION
|
|
1353
1390
|
Creates new WordPress installation.
|
|
@@ -1409,21 +1446,19 @@ List installed apps in a project.
|
|
|
1409
1446
|
|
|
1410
1447
|
```
|
|
1411
1448
|
USAGE
|
|
1412
|
-
$ mw app list [--columns <value> | -x] [--
|
|
1413
|
-
|
|
1449
|
+
$ mw app list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1450
|
+
<value>]
|
|
1414
1451
|
|
|
1415
1452
|
FLAGS
|
|
1453
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1454
|
+
<options: json|yaml|csv>
|
|
1416
1455
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1417
1456
|
context
|
|
1418
1457
|
-x, --extended show extra columns
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
--no-truncate do not truncate output to fit screen
|
|
1424
|
-
--output=<option> output in a more machine friendly format
|
|
1425
|
-
<options: csv|json|yaml>
|
|
1426
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1458
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1459
|
+
--csv output is csv format [alias: --output=csv]
|
|
1460
|
+
--no-header hide table header from output
|
|
1461
|
+
--no-truncate do not truncate output to fit screen
|
|
1427
1462
|
|
|
1428
1463
|
DESCRIPTION
|
|
1429
1464
|
List installed apps in a project.
|
|
@@ -1435,34 +1470,37 @@ FLAG DESCRIPTIONS
|
|
|
1435
1470
|
to persistently set a default project for all commands that accept this flag.
|
|
1436
1471
|
```
|
|
1437
1472
|
|
|
1438
|
-
## `mw app ssh INSTALLATION-ID`
|
|
1473
|
+
## `mw app ssh [INSTALLATION-ID]`
|
|
1439
1474
|
|
|
1440
1475
|
Connect to an app via SSH
|
|
1441
1476
|
|
|
1442
1477
|
```
|
|
1443
1478
|
USAGE
|
|
1444
|
-
$ mw app ssh INSTALLATION-ID [--cd]
|
|
1479
|
+
$ mw app ssh [INSTALLATION-ID] [--cd] [--info]
|
|
1445
1480
|
|
|
1446
1481
|
ARGUMENTS
|
|
1447
|
-
INSTALLATION-ID ID of
|
|
1482
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
1483
|
+
in the context
|
|
1448
1484
|
|
|
1449
1485
|
FLAGS
|
|
1450
1486
|
--[no-]cd change to installation path after connecting
|
|
1487
|
+
--info only print connection information, without actually connecting
|
|
1451
1488
|
|
|
1452
1489
|
DESCRIPTION
|
|
1453
1490
|
Connect to an app via SSH
|
|
1454
1491
|
```
|
|
1455
1492
|
|
|
1456
|
-
## `mw app uninstall INSTALLATION-ID`
|
|
1493
|
+
## `mw app uninstall [INSTALLATION-ID]`
|
|
1457
1494
|
|
|
1458
1495
|
Uninstall an app
|
|
1459
1496
|
|
|
1460
1497
|
```
|
|
1461
1498
|
USAGE
|
|
1462
|
-
$ mw app uninstall INSTALLATION-ID [-q] [-f]
|
|
1499
|
+
$ mw app uninstall [INSTALLATION-ID] [-q] [-f]
|
|
1463
1500
|
|
|
1464
1501
|
ARGUMENTS
|
|
1465
|
-
INSTALLATION-ID ID of
|
|
1502
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
1503
|
+
in the context
|
|
1466
1504
|
|
|
1467
1505
|
FLAGS
|
|
1468
1506
|
-f, --force Do not ask for confirmation
|
|
@@ -1493,6 +1531,37 @@ DESCRIPTION
|
|
|
1493
1531
|
List supported Apps and Versions
|
|
1494
1532
|
```
|
|
1495
1533
|
|
|
1534
|
+
## `mw autocomplete [SHELL]`
|
|
1535
|
+
|
|
1536
|
+
Display autocomplete installation instructions.
|
|
1537
|
+
|
|
1538
|
+
```
|
|
1539
|
+
USAGE
|
|
1540
|
+
$ mw autocomplete [SHELL] [-r]
|
|
1541
|
+
|
|
1542
|
+
ARGUMENTS
|
|
1543
|
+
SHELL (zsh|bash|powershell) Shell type
|
|
1544
|
+
|
|
1545
|
+
FLAGS
|
|
1546
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
1547
|
+
|
|
1548
|
+
DESCRIPTION
|
|
1549
|
+
Display autocomplete installation instructions.
|
|
1550
|
+
|
|
1551
|
+
EXAMPLES
|
|
1552
|
+
$ mw autocomplete
|
|
1553
|
+
|
|
1554
|
+
$ mw autocomplete bash
|
|
1555
|
+
|
|
1556
|
+
$ mw autocomplete zsh
|
|
1557
|
+
|
|
1558
|
+
$ mw autocomplete powershell
|
|
1559
|
+
|
|
1560
|
+
$ mw autocomplete --refresh-cache
|
|
1561
|
+
```
|
|
1562
|
+
|
|
1563
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.5/src/commands/autocomplete/index.ts)_
|
|
1564
|
+
|
|
1496
1565
|
## `mw backup create`
|
|
1497
1566
|
|
|
1498
1567
|
Create a new backup of a project
|
|
@@ -1502,13 +1571,13 @@ USAGE
|
|
|
1502
1571
|
$ mw backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
|
|
1503
1572
|
|
|
1504
1573
|
FLAGS
|
|
1505
|
-
-p, --project-id=<value>
|
|
1506
|
-
|
|
1507
|
-
-q, --quiet
|
|
1508
|
-
-w, --wait
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1574
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1575
|
+
context
|
|
1576
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1577
|
+
-w, --wait Wait for the resource to be ready.
|
|
1578
|
+
--description=<value> a description for the backup.
|
|
1579
|
+
--expires=<value> (required) An interval after which the backup expires (examples: 30m, 30d, 1y).
|
|
1580
|
+
--wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
|
|
1512
1581
|
|
|
1513
1582
|
ALIASES
|
|
1514
1583
|
$ mw project backup create
|
|
@@ -1566,14 +1635,14 @@ ARGUMENTS
|
|
|
1566
1635
|
BACKUP-ID the ID of the Backup to download.
|
|
1567
1636
|
|
|
1568
1637
|
FLAGS
|
|
1569
|
-
-q, --quiet
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1638
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1639
|
+
--format=<option> [default: tar] the file format to download the backup in.
|
|
1640
|
+
<options: tar|zip>
|
|
1641
|
+
--generate-password generate a random password to encrypt the backup with.
|
|
1642
|
+
--output=<value> the file to write the backup to; if omitted, the filename will be determined by the server.
|
|
1643
|
+
--password=<value> the password to encrypt the backup with.
|
|
1644
|
+
--prompt-password prompt for a password to encrypt the backup with.
|
|
1645
|
+
--resume resume a previously interrupted download.
|
|
1577
1646
|
|
|
1578
1647
|
DESCRIPTION
|
|
1579
1648
|
Download a backup to your local disk
|
|
@@ -1629,21 +1698,19 @@ List Backups for a given Project.
|
|
|
1629
1698
|
|
|
1630
1699
|
```
|
|
1631
1700
|
USAGE
|
|
1632
|
-
$ mw backup list [--columns <value> | -x] [--
|
|
1633
|
-
|
|
1701
|
+
$ mw backup list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1702
|
+
<value>]
|
|
1634
1703
|
|
|
1635
1704
|
FLAGS
|
|
1705
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1706
|
+
<options: json|yaml|csv>
|
|
1636
1707
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1637
1708
|
context
|
|
1638
1709
|
-x, --extended show extra columns
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
--no-truncate do not truncate output to fit screen
|
|
1644
|
-
--output=<option> output in a more machine friendly format
|
|
1645
|
-
<options: csv|json|yaml>
|
|
1646
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1710
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1711
|
+
--csv output is csv format [alias: --output=csv]
|
|
1712
|
+
--no-header hide table header from output
|
|
1713
|
+
--no-truncate do not truncate output to fit screen
|
|
1647
1714
|
|
|
1648
1715
|
DESCRIPTION
|
|
1649
1716
|
List Backups for a given Project.
|
|
@@ -1664,21 +1731,19 @@ List backup schedules belonging to a given project.
|
|
|
1664
1731
|
|
|
1665
1732
|
```
|
|
1666
1733
|
USAGE
|
|
1667
|
-
$ mw backup schedule list [--columns <value> | -x] [--
|
|
1668
|
-
|
|
1734
|
+
$ mw backup schedule list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1735
|
+
<value>]
|
|
1669
1736
|
|
|
1670
1737
|
FLAGS
|
|
1738
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1739
|
+
<options: json|yaml|csv>
|
|
1671
1740
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1672
1741
|
context
|
|
1673
1742
|
-x, --extended show extra columns
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
--no-truncate do not truncate output to fit screen
|
|
1679
|
-
--output=<option> output in a more machine friendly format
|
|
1680
|
-
<options: csv|json|yaml>
|
|
1681
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1743
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1744
|
+
--csv output is csv format [alias: --output=csv]
|
|
1745
|
+
--no-header hide table header from output
|
|
1746
|
+
--no-truncate do not truncate output to fit screen
|
|
1682
1747
|
|
|
1683
1748
|
DESCRIPTION
|
|
1684
1749
|
List backup schedules belonging to a given project.
|
|
@@ -1719,12 +1784,13 @@ Set context values for the current project, org or server
|
|
|
1719
1784
|
|
|
1720
1785
|
```
|
|
1721
1786
|
USAGE
|
|
1722
|
-
$ mw context set [--project-id <value>] [--server-id <value>] [--org-id <value>]
|
|
1787
|
+
$ mw context set [--project-id <value>] [--server-id <value>] [--org-id <value>] [--installation-id <value>]
|
|
1723
1788
|
|
|
1724
1789
|
FLAGS
|
|
1725
|
-
--
|
|
1726
|
-
--
|
|
1727
|
-
--
|
|
1790
|
+
--installation-id=<value> ID or short ID of an app installation
|
|
1791
|
+
--org-id=<value> ID or short ID of an organization
|
|
1792
|
+
--project-id=<value> ID or short ID of a project
|
|
1793
|
+
--server-id=<value> ID or short ID of a server
|
|
1728
1794
|
|
|
1729
1795
|
DESCRIPTION
|
|
1730
1796
|
Set context values for the current project, org or server
|
|
@@ -1739,19 +1805,16 @@ Get all conversation categories.
|
|
|
1739
1805
|
|
|
1740
1806
|
```
|
|
1741
1807
|
USAGE
|
|
1742
|
-
$ mw conversation categories [--columns <value> | -x] [--
|
|
1743
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
1808
|
+
$ mw conversation categories [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1744
1809
|
|
|
1745
1810
|
FLAGS
|
|
1746
|
-
-
|
|
1747
|
-
|
|
1748
|
-
--
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
<options: csv|json|yaml>
|
|
1754
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1811
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1812
|
+
<options: json|yaml|csv>
|
|
1813
|
+
-x, --extended show extra columns
|
|
1814
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1815
|
+
--csv output is csv format [alias: --output=csv]
|
|
1816
|
+
--no-header hide table header from output
|
|
1817
|
+
--no-truncate do not truncate output to fit screen
|
|
1755
1818
|
|
|
1756
1819
|
DESCRIPTION
|
|
1757
1820
|
Get all conversation categories.
|
|
@@ -1802,19 +1865,16 @@ Get all conversations the authenticated user has created or has access to.
|
|
|
1802
1865
|
|
|
1803
1866
|
```
|
|
1804
1867
|
USAGE
|
|
1805
|
-
$ mw conversation list [--columns <value> | -x] [--
|
|
1806
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
1868
|
+
$ mw conversation list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1807
1869
|
|
|
1808
1870
|
FLAGS
|
|
1809
|
-
-
|
|
1810
|
-
|
|
1811
|
-
--
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
<options: csv|json|yaml>
|
|
1817
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1871
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1872
|
+
<options: json|yaml|csv>
|
|
1873
|
+
-x, --extended show extra columns
|
|
1874
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1875
|
+
--csv output is csv format [alias: --output=csv]
|
|
1876
|
+
--no-header hide table header from output
|
|
1877
|
+
--no-truncate do not truncate output to fit screen
|
|
1818
1878
|
|
|
1819
1879
|
DESCRIPTION
|
|
1820
1880
|
Get all conversations the authenticated user has created or has access to.
|
|
@@ -1871,6 +1931,114 @@ FLAGS
|
|
|
1871
1931
|
--wait
|
|
1872
1932
|
```
|
|
1873
1933
|
|
|
1934
|
+
## `mw cronjob create`
|
|
1935
|
+
|
|
1936
|
+
Create a new cron job
|
|
1937
|
+
|
|
1938
|
+
```
|
|
1939
|
+
USAGE
|
|
1940
|
+
$ mw cronjob create --description <value> --interval <value> [-p <value>] [-i <value>] [-q] [--disable] [--email
|
|
1941
|
+
<value>] [--url <value> | --command <value>] [--interpreter <value>]
|
|
1942
|
+
|
|
1943
|
+
FLAGS
|
|
1944
|
+
-i, --installation-id=<value> ID or short ID of an app installation; this flag is optional if a default app
|
|
1945
|
+
installation is set in the context
|
|
1946
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1947
|
+
context
|
|
1948
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1949
|
+
--command=<value> Command to execute for the cron job; either this or `--url` is required.
|
|
1950
|
+
--description=<value> (required) Description of the cron job
|
|
1951
|
+
--disable Disable the cron job after creation
|
|
1952
|
+
--email=<value> Email address to send cron job output to
|
|
1953
|
+
--interpreter=<value> [default: /bin/sh] Interpreter to use for the cron job
|
|
1954
|
+
--interval=<value> (required) Interval of the cron job, in standard UNIX cron syntax
|
|
1955
|
+
--url=<value> URL to call for the cron job; either this or `--command` is required.
|
|
1956
|
+
|
|
1957
|
+
FLAG DESCRIPTIONS
|
|
1958
|
+
-i, --installation-id=<value>
|
|
1959
|
+
|
|
1960
|
+
ID or short ID of an app installation; this flag is optional if a default app installation is set in the context
|
|
1961
|
+
|
|
1962
|
+
May contain a short ID or a full ID of an app installation.; you can also use the "mw context set
|
|
1963
|
+
--installation-id=<VALUE>" command to persistently set a default app installation for all commands that accept this
|
|
1964
|
+
flag.
|
|
1965
|
+
|
|
1966
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
1967
|
+
|
|
1968
|
+
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
|
|
1969
|
+
to persistently set a default project for all commands that accept this flag.
|
|
1970
|
+
|
|
1971
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1972
|
+
|
|
1973
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
1974
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
1975
|
+
```
|
|
1976
|
+
|
|
1977
|
+
## `mw cronjob delete CRONJOB-ID`
|
|
1978
|
+
|
|
1979
|
+
Delete a cron job
|
|
1980
|
+
|
|
1981
|
+
```
|
|
1982
|
+
USAGE
|
|
1983
|
+
$ mw cronjob delete CRONJOB-ID [-q] [-f]
|
|
1984
|
+
|
|
1985
|
+
ARGUMENTS
|
|
1986
|
+
CRONJOB-ID ID of the cronjob to be deleted.
|
|
1987
|
+
|
|
1988
|
+
FLAGS
|
|
1989
|
+
-f, --force Do not ask for confirmation
|
|
1990
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1991
|
+
|
|
1992
|
+
DESCRIPTION
|
|
1993
|
+
Delete a cron job
|
|
1994
|
+
|
|
1995
|
+
FLAG DESCRIPTIONS
|
|
1996
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1997
|
+
|
|
1998
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
1999
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2000
|
+
```
|
|
2001
|
+
|
|
2002
|
+
## `mw cronjob execute CRONJOB-ID`
|
|
2003
|
+
|
|
2004
|
+
Manually run a cron job
|
|
2005
|
+
|
|
2006
|
+
```
|
|
2007
|
+
USAGE
|
|
2008
|
+
$ mw cronjob execute CRONJOB-ID [-q]
|
|
2009
|
+
|
|
2010
|
+
FLAGS
|
|
2011
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2012
|
+
|
|
2013
|
+
FLAG DESCRIPTIONS
|
|
2014
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2015
|
+
|
|
2016
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2017
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2018
|
+
```
|
|
2019
|
+
|
|
2020
|
+
## `mw cronjob execution abort CRONJOB-ID EXECUTION-ID`
|
|
2021
|
+
|
|
2022
|
+
Abort a running cron job execution.
|
|
2023
|
+
|
|
2024
|
+
```
|
|
2025
|
+
USAGE
|
|
2026
|
+
$ mw cronjob execution abort CRONJOB-ID EXECUTION-ID [-q]
|
|
2027
|
+
|
|
2028
|
+
ARGUMENTS
|
|
2029
|
+
CRONJOB-ID ID of the cronjob the execution belongs to
|
|
2030
|
+
EXECUTION-ID ID of the cron job execution to abort
|
|
2031
|
+
|
|
2032
|
+
FLAGS
|
|
2033
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2034
|
+
|
|
2035
|
+
FLAG DESCRIPTIONS
|
|
2036
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2037
|
+
|
|
2038
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2039
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2040
|
+
```
|
|
2041
|
+
|
|
1874
2042
|
## `mw cronjob execution get CRONJOB-ID EXECUTION-ID`
|
|
1875
2043
|
|
|
1876
2044
|
Get a cron job execution.
|
|
@@ -1900,20 +2068,18 @@ List CronjobExecutions belonging to a Cronjob.
|
|
|
1900
2068
|
|
|
1901
2069
|
```
|
|
1902
2070
|
USAGE
|
|
1903
|
-
$ mw cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--
|
|
1904
|
-
|
|
2071
|
+
$ mw cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
2072
|
+
json|yaml|csv | | ]
|
|
1905
2073
|
|
|
1906
2074
|
FLAGS
|
|
1907
|
-
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
<options: csv|json|yaml>
|
|
1916
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2075
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2076
|
+
<options: json|yaml|csv>
|
|
2077
|
+
-x, --extended show extra columns
|
|
2078
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2079
|
+
--cronjob-id=<value> (required) ID of the cron job for which to list executions for.
|
|
2080
|
+
--csv output is csv format [alias: --output=csv]
|
|
2081
|
+
--no-header hide table header from output
|
|
2082
|
+
--no-truncate do not truncate output to fit screen
|
|
1917
2083
|
|
|
1918
2084
|
DESCRIPTION
|
|
1919
2085
|
List CronjobExecutions belonging to a Cronjob.
|
|
@@ -1937,7 +2103,7 @@ ARGUMENTS
|
|
|
1937
2103
|
FLAGS
|
|
1938
2104
|
-o, --output=<option> output in a more machine friendly format
|
|
1939
2105
|
<options: json|yaml>
|
|
1940
|
-
|
|
2106
|
+
--no-pager Disable pager for output.
|
|
1941
2107
|
|
|
1942
2108
|
DESCRIPTION
|
|
1943
2109
|
Get the log output of a cronjob execution.
|
|
@@ -1950,52 +2116,47 @@ ALIASES
|
|
|
1950
2116
|
$ mw project cronjob execution logs
|
|
1951
2117
|
```
|
|
1952
2118
|
|
|
1953
|
-
## `mw cronjob get
|
|
2119
|
+
## `mw cronjob get CRONJOB-ID`
|
|
1954
2120
|
|
|
1955
|
-
Get a
|
|
2121
|
+
Get details of a cron job
|
|
1956
2122
|
|
|
1957
2123
|
```
|
|
1958
2124
|
USAGE
|
|
1959
|
-
$ mw cronjob get
|
|
2125
|
+
$ mw cronjob get CRONJOB-ID [-o json|yaml | | ]
|
|
1960
2126
|
|
|
1961
2127
|
ARGUMENTS
|
|
1962
|
-
|
|
2128
|
+
CRONJOB-ID ID of the cron job to be retrieved.
|
|
1963
2129
|
|
|
1964
2130
|
FLAGS
|
|
1965
2131
|
-o, --output=<option> output in a more machine friendly format
|
|
1966
2132
|
<options: json|yaml>
|
|
1967
2133
|
|
|
1968
2134
|
DESCRIPTION
|
|
1969
|
-
Get a
|
|
1970
|
-
|
|
1971
|
-
ALIASES
|
|
1972
|
-
$ mw project cronjob get
|
|
2135
|
+
Get details of a cron job
|
|
1973
2136
|
```
|
|
1974
2137
|
|
|
1975
2138
|
## `mw cronjob list`
|
|
1976
2139
|
|
|
1977
|
-
List
|
|
2140
|
+
List cron jobs belonging to a project.
|
|
1978
2141
|
|
|
1979
2142
|
```
|
|
1980
2143
|
USAGE
|
|
1981
|
-
$ mw cronjob list [--columns <value> | -x] [--
|
|
1982
|
-
|
|
2144
|
+
$ mw cronjob list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2145
|
+
<value>]
|
|
1983
2146
|
|
|
1984
2147
|
FLAGS
|
|
2148
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2149
|
+
<options: json|yaml|csv>
|
|
1985
2150
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1986
2151
|
context
|
|
1987
2152
|
-x, --extended show extra columns
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
--no-truncate do not truncate output to fit screen
|
|
1993
|
-
--output=<option> output in a more machine friendly format
|
|
1994
|
-
<options: csv|json|yaml>
|
|
1995
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2153
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2154
|
+
--csv output is csv format [alias: --output=csv]
|
|
2155
|
+
--no-header hide table header from output
|
|
2156
|
+
--no-truncate do not truncate output to fit screen
|
|
1996
2157
|
|
|
1997
2158
|
DESCRIPTION
|
|
1998
|
-
List
|
|
2159
|
+
List cron jobs belonging to a project.
|
|
1999
2160
|
|
|
2000
2161
|
ALIASES
|
|
2001
2162
|
$ mw project cronjob list
|
|
@@ -2013,19 +2174,16 @@ List available MySQL character sets and collations, optionally filtered by a MyS
|
|
|
2013
2174
|
|
|
2014
2175
|
```
|
|
2015
2176
|
USAGE
|
|
2016
|
-
$ mw database mysql charsets [--columns <value> | -x] [--
|
|
2017
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
2177
|
+
$ mw database mysql charsets [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2018
2178
|
|
|
2019
2179
|
FLAGS
|
|
2020
|
-
-
|
|
2021
|
-
|
|
2022
|
-
--
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
<options: csv|json|yaml>
|
|
2028
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2180
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2181
|
+
<options: json|yaml|csv>
|
|
2182
|
+
-x, --extended show extra columns
|
|
2183
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2184
|
+
--csv output is csv format [alias: --output=csv]
|
|
2185
|
+
--no-header hide table header from output
|
|
2186
|
+
--no-truncate do not truncate output to fit screen
|
|
2029
2187
|
|
|
2030
2188
|
DESCRIPTION
|
|
2031
2189
|
List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
|
|
@@ -2041,17 +2199,17 @@ USAGE
|
|
|
2041
2199
|
[--user-password <value>] [--user-external] [--user-access-level full|readonly]
|
|
2042
2200
|
|
|
2043
2201
|
FLAGS
|
|
2044
|
-
-d, --description=<value>
|
|
2045
|
-
-p, --project-id=<value>
|
|
2046
|
-
|
|
2047
|
-
-q, --quiet
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
|
|
2202
|
+
-d, --description=<value> (required) a description for the database
|
|
2203
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in
|
|
2204
|
+
the context
|
|
2205
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2206
|
+
--character-set=<value> [default: utf8mb4] the character set to use
|
|
2207
|
+
--collation=<value> [default: utf8mb4_unicode_ci] the collation to use
|
|
2208
|
+
--user-access-level=<option> [default: full] the access level preset for the default user
|
|
2209
|
+
<options: full|readonly>
|
|
2210
|
+
--user-external enable external access for default user
|
|
2211
|
+
--user-password=<value> the password to use for the default user (env: MYSQL_PWD)
|
|
2212
|
+
--version=<value> (required) the MySQL version to use
|
|
2055
2213
|
|
|
2056
2214
|
FLAG DESCRIPTIONS
|
|
2057
2215
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
@@ -2156,21 +2314,19 @@ List MySQLDatabases belonging to a Project.
|
|
|
2156
2314
|
|
|
2157
2315
|
```
|
|
2158
2316
|
USAGE
|
|
2159
|
-
$ mw database mysql list [--columns <value> | -x] [--
|
|
2160
|
-
|
|
2317
|
+
$ mw database mysql list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2318
|
+
<value>]
|
|
2161
2319
|
|
|
2162
2320
|
FLAGS
|
|
2321
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2322
|
+
<options: json|yaml|csv>
|
|
2163
2323
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2164
2324
|
context
|
|
2165
2325
|
-x, --extended show extra columns
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
--no-truncate do not truncate output to fit screen
|
|
2171
|
-
--output=<option> output in a more machine friendly format
|
|
2172
|
-
<options: csv|json|yaml>
|
|
2173
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2326
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2327
|
+
--csv output is csv format [alias: --output=csv]
|
|
2328
|
+
--no-header hide table header from output
|
|
2329
|
+
--no-truncate do not truncate output to fit screen
|
|
2174
2330
|
|
|
2175
2331
|
DESCRIPTION
|
|
2176
2332
|
List MySQLDatabases belonging to a Project.
|
|
@@ -2206,8 +2362,8 @@ ARGUMENTS
|
|
|
2206
2362
|
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
|
|
2207
2363
|
|
|
2208
2364
|
FLAGS
|
|
2209
|
-
-q, --quiet
|
|
2210
|
-
|
|
2365
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2366
|
+
--port=<value> [default: 3306] The local TCP port to forward to
|
|
2211
2367
|
|
|
2212
2368
|
FLAG DESCRIPTIONS
|
|
2213
2369
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
@@ -2271,20 +2427,18 @@ List MySQL users belonging to a database.
|
|
|
2271
2427
|
|
|
2272
2428
|
```
|
|
2273
2429
|
USAGE
|
|
2274
|
-
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--
|
|
2275
|
-
|
|
2430
|
+
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
2431
|
+
json|yaml|csv | | ]
|
|
2276
2432
|
|
|
2277
2433
|
FLAGS
|
|
2278
|
-
-
|
|
2279
|
-
|
|
2280
|
-
--
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
<options: csv|json|yaml>
|
|
2287
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2434
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2435
|
+
<options: json|yaml|csv>
|
|
2436
|
+
-x, --extended show extra columns
|
|
2437
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2438
|
+
--csv output is csv format [alias: --output=csv]
|
|
2439
|
+
--database-id=<value> (required) ID of the MySQL database to list users for.
|
|
2440
|
+
--no-header hide table header from output
|
|
2441
|
+
--no-truncate do not truncate output to fit screen
|
|
2288
2442
|
|
|
2289
2443
|
DESCRIPTION
|
|
2290
2444
|
List MySQL users belonging to a database.
|
|
@@ -2296,19 +2450,16 @@ List available MySQL versions.
|
|
|
2296
2450
|
|
|
2297
2451
|
```
|
|
2298
2452
|
USAGE
|
|
2299
|
-
$ mw database mysql versions [--columns <value> | -x] [--
|
|
2300
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
2453
|
+
$ mw database mysql versions [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2301
2454
|
|
|
2302
2455
|
FLAGS
|
|
2303
|
-
-
|
|
2304
|
-
|
|
2305
|
-
--
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
<options: csv|json|yaml>
|
|
2311
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2456
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2457
|
+
<options: json|yaml|csv>
|
|
2458
|
+
-x, --extended show extra columns
|
|
2459
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2460
|
+
--csv output is csv format [alias: --output=csv]
|
|
2461
|
+
--no-header hide table header from output
|
|
2462
|
+
--no-truncate do not truncate output to fit screen
|
|
2312
2463
|
|
|
2313
2464
|
DESCRIPTION
|
|
2314
2465
|
List available MySQL versions.
|
|
@@ -2325,16 +2476,16 @@ USAGE
|
|
|
2325
2476
|
noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-random|volatile-random|volatile-ttl]
|
|
2326
2477
|
|
|
2327
2478
|
FLAGS
|
|
2328
|
-
-d, --description=<value>
|
|
2329
|
-
-p, --project-id=<value>
|
|
2330
|
-
|
|
2331
|
-
-q, --quiet
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2479
|
+
-d, --description=<value> (required) a description for the database
|
|
2480
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in
|
|
2481
|
+
the context
|
|
2482
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2483
|
+
--max-memory=<value> the maximum memory for the Redis database
|
|
2484
|
+
--max-memory-policy=<option> the Redis eviction policy
|
|
2485
|
+
<options: noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-rando
|
|
2486
|
+
m|volatile-random|volatile-ttl>
|
|
2487
|
+
--[no-]persistent enable persistent storage for the Redis database
|
|
2488
|
+
--version=<value> (required) the Redis version to use
|
|
2338
2489
|
|
|
2339
2490
|
FLAG DESCRIPTIONS
|
|
2340
2491
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
@@ -2388,21 +2539,19 @@ List Redis databases belonging to a project.
|
|
|
2388
2539
|
|
|
2389
2540
|
```
|
|
2390
2541
|
USAGE
|
|
2391
|
-
$ mw database redis list [--columns <value> | -x] [--
|
|
2392
|
-
|
|
2542
|
+
$ mw database redis list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2543
|
+
<value>]
|
|
2393
2544
|
|
|
2394
2545
|
FLAGS
|
|
2546
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2547
|
+
<options: json|yaml|csv>
|
|
2395
2548
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2396
2549
|
context
|
|
2397
2550
|
-x, --extended show extra columns
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
--no-truncate do not truncate output to fit screen
|
|
2403
|
-
--output=<option> output in a more machine friendly format
|
|
2404
|
-
<options: csv|json|yaml>
|
|
2405
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2551
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2552
|
+
--csv output is csv format [alias: --output=csv]
|
|
2553
|
+
--no-header hide table header from output
|
|
2554
|
+
--no-truncate do not truncate output to fit screen
|
|
2406
2555
|
|
|
2407
2556
|
DESCRIPTION
|
|
2408
2557
|
List Redis databases belonging to a project.
|
|
@@ -2441,21 +2590,19 @@ List available Redis versions.
|
|
|
2441
2590
|
|
|
2442
2591
|
```
|
|
2443
2592
|
USAGE
|
|
2444
|
-
$ mw database redis versions [--columns <value> | -x] [--
|
|
2445
|
-
|
|
2593
|
+
$ mw database redis versions [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2594
|
+
<value>]
|
|
2446
2595
|
|
|
2447
2596
|
FLAGS
|
|
2597
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2598
|
+
<options: json|yaml|csv>
|
|
2448
2599
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2449
2600
|
context
|
|
2450
2601
|
-x, --extended show extra columns
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
--no-truncate do not truncate output to fit screen
|
|
2456
|
-
--output=<option> output in a more machine friendly format
|
|
2457
|
-
<options: csv|json|yaml>
|
|
2458
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2602
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2603
|
+
--csv output is csv format [alias: --output=csv]
|
|
2604
|
+
--no-header hide table header from output
|
|
2605
|
+
--no-truncate do not truncate output to fit screen
|
|
2459
2606
|
|
|
2460
2607
|
DESCRIPTION
|
|
2461
2608
|
List available Redis versions.
|
|
@@ -2467,16 +2614,16 @@ FLAG DESCRIPTIONS
|
|
|
2467
2614
|
to persistently set a default project for all commands that accept this flag.
|
|
2468
2615
|
```
|
|
2469
2616
|
|
|
2470
|
-
## `mw domain dnszone get
|
|
2617
|
+
## `mw domain dnszone get DNSZONE-ID`
|
|
2471
2618
|
|
|
2472
2619
|
gets a specific zone
|
|
2473
2620
|
|
|
2474
2621
|
```
|
|
2475
2622
|
USAGE
|
|
2476
|
-
$ mw domain dnszone get
|
|
2623
|
+
$ mw domain dnszone get DNSZONE-ID [-o json|yaml | | ]
|
|
2477
2624
|
|
|
2478
2625
|
ARGUMENTS
|
|
2479
|
-
|
|
2626
|
+
DNSZONE-ID ID or domain name of a DNS zone
|
|
2480
2627
|
|
|
2481
2628
|
FLAGS
|
|
2482
2629
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -2488,20 +2635,26 @@ DESCRIPTION
|
|
|
2488
2635
|
|
|
2489
2636
|
## `mw domain dnszone list`
|
|
2490
2637
|
|
|
2491
|
-
|
|
2638
|
+
list all DNS zones by project ID
|
|
2492
2639
|
|
|
2493
2640
|
```
|
|
2494
2641
|
USAGE
|
|
2495
|
-
$ mw domain dnszone list [-o json|yaml | | ] [-p
|
|
2642
|
+
$ mw domain dnszone list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2643
|
+
<value>]
|
|
2496
2644
|
|
|
2497
2645
|
FLAGS
|
|
2498
2646
|
-o, --output=<option> output in a more machine friendly format
|
|
2499
|
-
<options: json|yaml>
|
|
2647
|
+
<options: json|yaml|csv>
|
|
2500
2648
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2501
2649
|
context
|
|
2650
|
+
-x, --extended show extra columns
|
|
2651
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2652
|
+
--csv output is csv format [alias: --output=csv]
|
|
2653
|
+
--no-header hide table header from output
|
|
2654
|
+
--no-truncate do not truncate output to fit screen
|
|
2502
2655
|
|
|
2503
2656
|
DESCRIPTION
|
|
2504
|
-
|
|
2657
|
+
list all DNS zones by project ID
|
|
2505
2658
|
|
|
2506
2659
|
FLAG DESCRIPTIONS
|
|
2507
2660
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
@@ -2510,100 +2663,105 @@ FLAG DESCRIPTIONS
|
|
|
2510
2663
|
to persistently set a default project for all commands that accept this flag.
|
|
2511
2664
|
```
|
|
2512
2665
|
|
|
2513
|
-
## `mw domain
|
|
2666
|
+
## `mw domain dnszone update DNSZONE-ID RECORD-SET`
|
|
2514
2667
|
|
|
2515
|
-
|
|
2668
|
+
Updates a record set of a DNS zone
|
|
2516
2669
|
|
|
2517
2670
|
```
|
|
2518
2671
|
USAGE
|
|
2519
|
-
$ mw domain
|
|
2672
|
+
$ mw domain dnszone update DNSZONE-ID RECORD-SET [-q] [-p <value>] [--record <value> | --managed | --unset] [--ttl
|
|
2673
|
+
<value>]
|
|
2520
2674
|
|
|
2521
2675
|
ARGUMENTS
|
|
2522
|
-
|
|
2676
|
+
DNSZONE-ID ID or domain name of a DNS zone
|
|
2677
|
+
RECORD-SET (a|mx|txt|srv|cname) The record type of the record set
|
|
2523
2678
|
|
|
2524
2679
|
FLAGS
|
|
2525
|
-
-
|
|
2526
|
-
|
|
2680
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2681
|
+
context
|
|
2682
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2683
|
+
--managed Reset this record set to fully-managed (only for A and MX records)
|
|
2684
|
+
--record=<value>... The records to set; may not be used with --managed
|
|
2685
|
+
--ttl=<value> The TTL of the record set; omit to use the default TTL
|
|
2686
|
+
--unset Set this to remove all records from the record set
|
|
2527
2687
|
|
|
2528
2688
|
DESCRIPTION
|
|
2529
|
-
|
|
2530
|
-
```
|
|
2689
|
+
Updates a record set of a DNS zone
|
|
2531
2690
|
|
|
2532
|
-
|
|
2691
|
+
EXAMPLES
|
|
2692
|
+
Set A and AAAA records
|
|
2533
2693
|
|
|
2534
|
-
|
|
2694
|
+
$ mw domain dnszone update domain.example a --record 203.0.113.123 --record 2001:db8::1
|
|
2535
2695
|
|
|
2536
|
-
|
|
2537
|
-
USAGE
|
|
2538
|
-
$ mw domain list [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output
|
|
2539
|
-
csv|json|yaml | | ] [--sort <value>] [-p <value>]
|
|
2696
|
+
Set MX records
|
|
2540
2697
|
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
context
|
|
2544
|
-
-x, --extended show extra columns
|
|
2545
|
-
--columns=<value> only show provided columns (comma-separated)
|
|
2546
|
-
--csv output is csv format [alias: --output=csv]
|
|
2547
|
-
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
2548
|
-
--no-header hide table header from output
|
|
2549
|
-
--no-truncate do not truncate output to fit screen
|
|
2550
|
-
--output=<option> output in a more machine friendly format
|
|
2551
|
-
<options: csv|json|yaml>
|
|
2552
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2553
|
-
|
|
2554
|
-
DESCRIPTION
|
|
2555
|
-
List Domains belonging to a Project.
|
|
2698
|
+
$ mw domain dnszone update domain.example mx --record "10 mail1.domain.example" --record "20 \
|
|
2699
|
+
mail2.domain.example"
|
|
2556
2700
|
|
|
2557
2701
|
FLAG DESCRIPTIONS
|
|
2558
2702
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
2559
2703
|
|
|
2560
2704
|
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
|
|
2561
2705
|
to persistently set a default project for all commands that accept this flag.
|
|
2706
|
+
|
|
2707
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2708
|
+
|
|
2709
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2710
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2711
|
+
|
|
2712
|
+
--record=<value>... The records to set; may not be used with --managed
|
|
2713
|
+
|
|
2714
|
+
The format depends on the record set type:
|
|
2715
|
+
|
|
2716
|
+
- for "a" records, this parameter should contain a IPv4 or IPv6 address (we will automatically create an A or AAAA
|
|
2717
|
+
record)
|
|
2718
|
+
- for "mx" records, the parameter should be formatted as "<priority> <fqdn>", e.g. "10 mail.example.com"
|
|
2719
|
+
- for "srv" records, the parameter should be formatted as "<priority> <weight> <port> <fqdn>", e.g. "10 1 5060
|
|
2720
|
+
sip.example.com"
|
|
2721
|
+
- for "txt" records, the parameter should be a string containing the TXT record value.
|
|
2562
2722
|
```
|
|
2563
2723
|
|
|
2564
|
-
## `mw domain
|
|
2724
|
+
## `mw domain get DOMAIN-ID`
|
|
2565
2725
|
|
|
2566
|
-
|
|
2726
|
+
gets a specific domain
|
|
2567
2727
|
|
|
2568
2728
|
```
|
|
2569
2729
|
USAGE
|
|
2570
|
-
$ mw domain
|
|
2730
|
+
$ mw domain get DOMAIN-ID [-o json|yaml | | ]
|
|
2571
2731
|
|
|
2572
2732
|
ARGUMENTS
|
|
2573
|
-
|
|
2733
|
+
DOMAIN-ID ID or domain name of a domain
|
|
2574
2734
|
|
|
2575
2735
|
FLAGS
|
|
2576
2736
|
-o, --output=<option> output in a more machine friendly format
|
|
2577
2737
|
<options: json|yaml>
|
|
2578
2738
|
|
|
2579
2739
|
DESCRIPTION
|
|
2580
|
-
|
|
2740
|
+
gets a specific domain
|
|
2581
2741
|
```
|
|
2582
2742
|
|
|
2583
|
-
## `mw domain
|
|
2743
|
+
## `mw domain list`
|
|
2584
2744
|
|
|
2585
|
-
List
|
|
2745
|
+
List domains belonging to a project.
|
|
2586
2746
|
|
|
2587
2747
|
```
|
|
2588
2748
|
USAGE
|
|
2589
|
-
$ mw domain
|
|
2590
|
-
|
|
2749
|
+
$ mw domain list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2750
|
+
<value>]
|
|
2591
2751
|
|
|
2592
2752
|
FLAGS
|
|
2753
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2754
|
+
<options: json|yaml|csv>
|
|
2593
2755
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2594
2756
|
context
|
|
2595
2757
|
-x, --extended show extra columns
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
--no-truncate do not truncate output to fit screen
|
|
2601
|
-
--output=<option> output in a more machine friendly format
|
|
2602
|
-
<options: csv|json|yaml>
|
|
2603
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2758
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2759
|
+
--csv output is csv format [alias: --output=csv]
|
|
2760
|
+
--no-header hide table header from output
|
|
2761
|
+
--no-truncate do not truncate output to fit screen
|
|
2604
2762
|
|
|
2605
2763
|
DESCRIPTION
|
|
2606
|
-
List
|
|
2764
|
+
List domains belonging to a project.
|
|
2607
2765
|
|
|
2608
2766
|
FLAG DESCRIPTIONS
|
|
2609
2767
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
@@ -2622,13 +2780,13 @@ USAGE
|
|
|
2622
2780
|
[--path-to-url <value>]
|
|
2623
2781
|
|
|
2624
2782
|
FLAGS
|
|
2625
|
-
-p, --project-id=<value>
|
|
2626
|
-
|
|
2627
|
-
-q, --quiet
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2783
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2784
|
+
context
|
|
2785
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2786
|
+
--hostname=<value> (required) the hostname of the ingress
|
|
2787
|
+
--path-to-app=<value>... add a path mapping to an app
|
|
2788
|
+
--path-to-dir=<value>... add a path mapping to a directory
|
|
2789
|
+
--path-to-url=<value>... add a path mapping to an external url
|
|
2632
2790
|
|
|
2633
2791
|
DESCRIPTION
|
|
2634
2792
|
Create a new ingress
|
|
@@ -2724,22 +2882,20 @@ List virtualhosts for a project.
|
|
|
2724
2882
|
|
|
2725
2883
|
```
|
|
2726
2884
|
USAGE
|
|
2727
|
-
$ mw domain virtualhost list [--columns <value> | -x] [--
|
|
2728
|
-
|
|
2885
|
+
$ mw domain virtualhost list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2886
|
+
<value>] [-a]
|
|
2729
2887
|
|
|
2730
2888
|
FLAGS
|
|
2731
2889
|
-a, --all List all virtual hosts that you have access to, regardless of project
|
|
2890
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2891
|
+
<options: json|yaml|csv>
|
|
2732
2892
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2733
2893
|
context
|
|
2734
2894
|
-x, --extended show extra columns
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
--no-truncate do not truncate output to fit screen
|
|
2740
|
-
--output=<option> output in a more machine friendly format
|
|
2741
|
-
<options: csv|json|yaml>
|
|
2742
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2895
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2896
|
+
--csv output is csv format [alias: --output=csv]
|
|
2897
|
+
--no-header hide table header from output
|
|
2898
|
+
--no-truncate do not truncate output to fit screen
|
|
2743
2899
|
|
|
2744
2900
|
DESCRIPTION
|
|
2745
2901
|
List virtualhosts for a project.
|
|
@@ -2769,7 +2925,7 @@ DESCRIPTION
|
|
|
2769
2925
|
Display help for mw.
|
|
2770
2926
|
```
|
|
2771
2927
|
|
|
2772
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.
|
|
2928
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.9/src/commands/help.ts)_
|
|
2773
2929
|
|
|
2774
2930
|
## `mw login reset`
|
|
2775
2931
|
|
|
@@ -2817,22 +2973,33 @@ Create a new mail address
|
|
|
2817
2973
|
```
|
|
2818
2974
|
USAGE
|
|
2819
2975
|
$ mw mail address create -a <value> [-p <value>] [-q] [--catch-all] [--enable-spam-protection] [--quota <value>]
|
|
2820
|
-
[--password <value>] [--random-password]
|
|
2976
|
+
[--password <value>] [--random-password] [--forward-to <value>]
|
|
2821
2977
|
|
|
2822
2978
|
FLAGS
|
|
2823
|
-
-a, --address=<value>
|
|
2824
|
-
-p, --project-id=<value>
|
|
2825
|
-
|
|
2826
|
-
-q, --quiet
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2979
|
+
-a, --address=<value> (required) mail address
|
|
2980
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in
|
|
2981
|
+
the context
|
|
2982
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2983
|
+
--catch-all make this a catch-all mail address
|
|
2984
|
+
--[no-]enable-spam-protection enable spam protection for this mailbox
|
|
2985
|
+
--forward-to=<value>... forward mail to another address
|
|
2986
|
+
--password=<value> mailbox password
|
|
2987
|
+
--quota=<value> [default: 1024] mailbox quota in mebibytes
|
|
2988
|
+
--random-password generate a random password
|
|
2832
2989
|
|
|
2833
2990
|
DESCRIPTION
|
|
2834
2991
|
Create a new mail address
|
|
2835
2992
|
|
|
2993
|
+
This command can be used to create a new mail address in a project.
|
|
2994
|
+
|
|
2995
|
+
A mail address is either associated with a mailbox, or forwards to another address.
|
|
2996
|
+
|
|
2997
|
+
To create a forwarding address, use the --forward-to flag. This flag can be used multiple times to forward to multiple
|
|
2998
|
+
addresses.
|
|
2999
|
+
|
|
3000
|
+
When no --forward-to flag is given, the command will create a mailbox for the address. In this case, the --catch-all
|
|
3001
|
+
flag can be used to make the mailbox a catch-all mailbox.
|
|
3002
|
+
|
|
2836
3003
|
When running this command with the --quiet flag, the output will contain the ID of the newly created address.
|
|
2837
3004
|
In addition, when run with --generated-password the output will be the ID of the newly created address, followed by a
|
|
2838
3005
|
tab character and the generated password.
|
|
@@ -2847,6 +3014,10 @@ EXAMPLES
|
|
|
2847
3014
|
|
|
2848
3015
|
$ mw mail address create --random-password --address foo@bar.example
|
|
2849
3016
|
|
|
3017
|
+
Create a forwarding address
|
|
3018
|
+
|
|
3019
|
+
$ mw mail address create --address foo@bar.example --forward-to bar@bar.example --forward-to baz@bar.example
|
|
3020
|
+
|
|
2850
3021
|
FLAG DESCRIPTIONS
|
|
2851
3022
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
2852
3023
|
|
|
@@ -2858,6 +3029,12 @@ FLAG DESCRIPTIONS
|
|
|
2858
3029
|
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2859
3030
|
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2860
3031
|
|
|
3032
|
+
--forward-to=<value>... forward mail to another address
|
|
3033
|
+
|
|
3034
|
+
This flag will cause the mailbox to forward all incoming mail to the given address.
|
|
3035
|
+
|
|
3036
|
+
Note: This flag is exclusive with --catch-all, --enable-spam-protection, --quota, --password and --random-password.
|
|
3037
|
+
|
|
2861
3038
|
--password=<value> mailbox password
|
|
2862
3039
|
|
|
2863
3040
|
This is the password that should be used for the mailbox; if omitted, the command will prompt interactively for a
|
|
@@ -2921,21 +3098,19 @@ Get all mail addresses for a project ID
|
|
|
2921
3098
|
|
|
2922
3099
|
```
|
|
2923
3100
|
USAGE
|
|
2924
|
-
$ mw mail address list [--columns <value> | -x] [--
|
|
2925
|
-
|
|
3101
|
+
$ mw mail address list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3102
|
+
<value>]
|
|
2926
3103
|
|
|
2927
3104
|
FLAGS
|
|
3105
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3106
|
+
<options: json|yaml|csv>
|
|
2928
3107
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2929
3108
|
context
|
|
2930
3109
|
-x, --extended show extra columns
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
--no-truncate do not truncate output to fit screen
|
|
2936
|
-
--output=<option> output in a more machine friendly format
|
|
2937
|
-
<options: csv|json|yaml>
|
|
2938
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3110
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3111
|
+
--csv output is csv format [alias: --output=csv]
|
|
3112
|
+
--no-header hide table header from output
|
|
3113
|
+
--no-truncate do not truncate output to fit screen
|
|
2939
3114
|
|
|
2940
3115
|
DESCRIPTION
|
|
2941
3116
|
Get all mail addresses for a project ID
|
|
@@ -2972,21 +3147,19 @@ Get all deliveryboxes by project ID
|
|
|
2972
3147
|
|
|
2973
3148
|
```
|
|
2974
3149
|
USAGE
|
|
2975
|
-
$ mw mail deliverybox list [--columns <value> | -x] [--
|
|
2976
|
-
|
|
3150
|
+
$ mw mail deliverybox list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3151
|
+
<value>]
|
|
2977
3152
|
|
|
2978
3153
|
FLAGS
|
|
3154
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3155
|
+
<options: json|yaml|csv>
|
|
2979
3156
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2980
3157
|
context
|
|
2981
3158
|
-x, --extended show extra columns
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
--no-truncate do not truncate output to fit screen
|
|
2987
|
-
--output=<option> output in a more machine friendly format
|
|
2988
|
-
<options: csv|json|yaml>
|
|
2989
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3159
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3160
|
+
--csv output is csv format [alias: --output=csv]
|
|
3161
|
+
--no-header hide table header from output
|
|
3162
|
+
--no-truncate do not truncate output to fit screen
|
|
2990
3163
|
|
|
2991
3164
|
DESCRIPTION
|
|
2992
3165
|
Get all deliveryboxes by project ID
|
|
@@ -3007,7 +3180,7 @@ USAGE
|
|
|
3007
3180
|
$ mw org delete [ORG-ID] [-q] [-f]
|
|
3008
3181
|
|
|
3009
3182
|
ARGUMENTS
|
|
3010
|
-
ORG-ID ID or short ID of
|
|
3183
|
+
ORG-ID ID or short ID of an org; this argument is optional if a default org is set in the context
|
|
3011
3184
|
|
|
3012
3185
|
FLAGS
|
|
3013
3186
|
-f, --force Do not ask for confirmation
|
|
@@ -3032,7 +3205,7 @@ USAGE
|
|
|
3032
3205
|
$ mw org get [ORG-ID] [-o json|yaml | | ]
|
|
3033
3206
|
|
|
3034
3207
|
ARGUMENTS
|
|
3035
|
-
ORG-ID ID or short ID of
|
|
3208
|
+
ORG-ID ID or short ID of an org; this argument is optional if a default org is set in the context
|
|
3036
3209
|
|
|
3037
3210
|
FLAGS
|
|
3038
3211
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -3052,21 +3225,21 @@ USAGE
|
|
|
3052
3225
|
[--expires <value>]
|
|
3053
3226
|
|
|
3054
3227
|
FLAGS
|
|
3055
|
-
-o, --org-id=<value>
|
|
3056
|
-
-q, --quiet
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
3228
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3229
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3230
|
+
--email=<value> (required) The email address of the user to invite.
|
|
3231
|
+
--expires=<value> An interval after which the invitation expires (examples: 30m, 30d, 1y).
|
|
3232
|
+
--message=<value> A message to include in the invitation email.
|
|
3233
|
+
--role=<option> [default: member] The role of the user to invite.
|
|
3234
|
+
<options: owner|member|accountant>
|
|
3062
3235
|
|
|
3063
3236
|
DESCRIPTION
|
|
3064
3237
|
Invite a user to an organization.
|
|
3065
3238
|
|
|
3066
3239
|
FLAG DESCRIPTIONS
|
|
3067
|
-
-o, --org-id=<value> ID or short ID of
|
|
3240
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3068
3241
|
|
|
3069
|
-
May contain a short ID or a full ID of
|
|
3242
|
+
May contain a short ID or a full ID of an org; you can also use the "mw context set --org-id=<VALUE>" command to
|
|
3070
3243
|
persistently set a default org for all commands that accept this flag.
|
|
3071
3244
|
|
|
3072
3245
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
@@ -3081,28 +3254,26 @@ List all invites for an organization.
|
|
|
3081
3254
|
|
|
3082
3255
|
```
|
|
3083
3256
|
USAGE
|
|
3084
|
-
$ mw org invite list [--columns <value> | -x] [--
|
|
3085
|
-
|
|
3257
|
+
$ mw org invite list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-o
|
|
3258
|
+
<value>]
|
|
3086
3259
|
|
|
3087
3260
|
FLAGS
|
|
3088
|
-
-o, --org-id=<value>
|
|
3089
|
-
-
|
|
3090
|
-
|
|
3091
|
-
--
|
|
3092
|
-
|
|
3093
|
-
|
|
3094
|
-
|
|
3095
|
-
|
|
3096
|
-
<options: csv|json|yaml>
|
|
3097
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3261
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3262
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3263
|
+
<options: json|yaml|csv>
|
|
3264
|
+
-x, --extended show extra columns
|
|
3265
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3266
|
+
--csv output is csv format [alias: --output=csv]
|
|
3267
|
+
--no-header hide table header from output
|
|
3268
|
+
--no-truncate do not truncate output to fit screen
|
|
3098
3269
|
|
|
3099
3270
|
DESCRIPTION
|
|
3100
3271
|
List all invites for an organization.
|
|
3101
3272
|
|
|
3102
3273
|
FLAG DESCRIPTIONS
|
|
3103
|
-
-o, --org-id=<value> ID or short ID of
|
|
3274
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3104
3275
|
|
|
3105
|
-
May contain a short ID or a full ID of
|
|
3276
|
+
May contain a short ID or a full ID of an org; you can also use the "mw context set --org-id=<VALUE>" command to
|
|
3106
3277
|
persistently set a default org for all commands that accept this flag.
|
|
3107
3278
|
```
|
|
3108
3279
|
|
|
@@ -3112,19 +3283,16 @@ List all organization invites for the executing user.
|
|
|
3112
3283
|
|
|
3113
3284
|
```
|
|
3114
3285
|
USAGE
|
|
3115
|
-
$ mw org invite list-own [--columns <value> | -x] [--
|
|
3116
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3286
|
+
$ mw org invite list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3117
3287
|
|
|
3118
3288
|
FLAGS
|
|
3119
|
-
-
|
|
3120
|
-
|
|
3121
|
-
--
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
<options: csv|json|yaml>
|
|
3127
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3289
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3290
|
+
<options: json|yaml|csv>
|
|
3291
|
+
-x, --extended show extra columns
|
|
3292
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3293
|
+
--csv output is csv format [alias: --output=csv]
|
|
3294
|
+
--no-header hide table header from output
|
|
3295
|
+
--no-truncate do not truncate output to fit screen
|
|
3128
3296
|
|
|
3129
3297
|
DESCRIPTION
|
|
3130
3298
|
List all organization invites for the executing user.
|
|
@@ -3160,19 +3328,16 @@ Get all organizations the authenticated user has access to.
|
|
|
3160
3328
|
|
|
3161
3329
|
```
|
|
3162
3330
|
USAGE
|
|
3163
|
-
$ mw org list [--columns <value> | -x] [--
|
|
3164
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3331
|
+
$ mw org list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3165
3332
|
|
|
3166
3333
|
FLAGS
|
|
3167
|
-
-
|
|
3168
|
-
|
|
3169
|
-
--
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
<options: csv|json|yaml>
|
|
3175
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3334
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3335
|
+
<options: json|yaml|csv>
|
|
3336
|
+
-x, --extended show extra columns
|
|
3337
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3338
|
+
--csv output is csv format [alias: --output=csv]
|
|
3339
|
+
--no-header hide table header from output
|
|
3340
|
+
--no-truncate do not truncate output to fit screen
|
|
3176
3341
|
|
|
3177
3342
|
DESCRIPTION
|
|
3178
3343
|
Get all organizations the authenticated user has access to.
|
|
@@ -3184,28 +3349,26 @@ List all memberships belonging to an organization.
|
|
|
3184
3349
|
|
|
3185
3350
|
```
|
|
3186
3351
|
USAGE
|
|
3187
|
-
$ mw org membership list [--columns <value> | -x] [--
|
|
3188
|
-
|
|
3352
|
+
$ mw org membership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-o
|
|
3353
|
+
<value>]
|
|
3189
3354
|
|
|
3190
3355
|
FLAGS
|
|
3191
|
-
-o, --org-id=<value>
|
|
3192
|
-
-
|
|
3193
|
-
|
|
3194
|
-
--
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
<options: csv|json|yaml>
|
|
3200
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3356
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3357
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3358
|
+
<options: json|yaml|csv>
|
|
3359
|
+
-x, --extended show extra columns
|
|
3360
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3361
|
+
--csv output is csv format [alias: --output=csv]
|
|
3362
|
+
--no-header hide table header from output
|
|
3363
|
+
--no-truncate do not truncate output to fit screen
|
|
3201
3364
|
|
|
3202
3365
|
DESCRIPTION
|
|
3203
3366
|
List all memberships belonging to an organization.
|
|
3204
3367
|
|
|
3205
3368
|
FLAG DESCRIPTIONS
|
|
3206
|
-
-o, --org-id=<value> ID or short ID of
|
|
3369
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3207
3370
|
|
|
3208
|
-
May contain a short ID or a full ID of
|
|
3371
|
+
May contain a short ID or a full ID of an org; you can also use the "mw context set --org-id=<VALUE>" command to
|
|
3209
3372
|
persistently set a default org for all commands that accept this flag.
|
|
3210
3373
|
```
|
|
3211
3374
|
|
|
@@ -3215,19 +3378,16 @@ List all organization memberships for the executing user.
|
|
|
3215
3378
|
|
|
3216
3379
|
```
|
|
3217
3380
|
USAGE
|
|
3218
|
-
$ mw org membership list-own [--columns <value> | -x] [--
|
|
3219
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3381
|
+
$ mw org membership list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3220
3382
|
|
|
3221
3383
|
FLAGS
|
|
3222
|
-
-
|
|
3223
|
-
|
|
3224
|
-
--
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
<options: csv|json|yaml>
|
|
3230
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3384
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3385
|
+
<options: json|yaml|csv>
|
|
3386
|
+
-x, --extended show extra columns
|
|
3387
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3388
|
+
--csv output is csv format [alias: --output=csv]
|
|
3389
|
+
--no-header hide table header from output
|
|
3390
|
+
--no-truncate do not truncate output to fit screen
|
|
3231
3391
|
|
|
3232
3392
|
DESCRIPTION
|
|
3233
3393
|
List all organization memberships for the executing user.
|
|
@@ -3266,13 +3426,13 @@ USAGE
|
|
|
3266
3426
|
$ mw project backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
|
|
3267
3427
|
|
|
3268
3428
|
FLAGS
|
|
3269
|
-
-p, --project-id=<value>
|
|
3270
|
-
|
|
3271
|
-
-q, --quiet
|
|
3272
|
-
-w, --wait
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
3429
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3430
|
+
context
|
|
3431
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3432
|
+
-w, --wait Wait for the resource to be ready.
|
|
3433
|
+
--description=<value> a description for the backup.
|
|
3434
|
+
--expires=<value> (required) An interval after which the backup expires (examples: 30m, 30d, 1y).
|
|
3435
|
+
--wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
|
|
3276
3436
|
|
|
3277
3437
|
ALIASES
|
|
3278
3438
|
$ mw project backup create
|
|
@@ -3330,14 +3490,14 @@ ARGUMENTS
|
|
|
3330
3490
|
BACKUP-ID the ID of the Backup to download.
|
|
3331
3491
|
|
|
3332
3492
|
FLAGS
|
|
3333
|
-
-q, --quiet
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3340
|
-
|
|
3493
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3494
|
+
--format=<option> [default: tar] the file format to download the backup in.
|
|
3495
|
+
<options: tar|zip>
|
|
3496
|
+
--generate-password generate a random password to encrypt the backup with.
|
|
3497
|
+
--output=<value> the file to write the backup to; if omitted, the filename will be determined by the server.
|
|
3498
|
+
--password=<value> the password to encrypt the backup with.
|
|
3499
|
+
--prompt-password prompt for a password to encrypt the backup with.
|
|
3500
|
+
--resume resume a previously interrupted download.
|
|
3341
3501
|
|
|
3342
3502
|
DESCRIPTION
|
|
3343
3503
|
Download a backup to your local disk
|
|
@@ -3393,21 +3553,19 @@ List Backups for a given Project.
|
|
|
3393
3553
|
|
|
3394
3554
|
```
|
|
3395
3555
|
USAGE
|
|
3396
|
-
$ mw project backup list [--columns <value> | -x] [--
|
|
3397
|
-
|
|
3556
|
+
$ mw project backup list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3557
|
+
<value>]
|
|
3398
3558
|
|
|
3399
3559
|
FLAGS
|
|
3560
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3561
|
+
<options: json|yaml|csv>
|
|
3400
3562
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3401
3563
|
context
|
|
3402
3564
|
-x, --extended show extra columns
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
--no-truncate do not truncate output to fit screen
|
|
3408
|
-
--output=<option> output in a more machine friendly format
|
|
3409
|
-
<options: csv|json|yaml>
|
|
3410
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3565
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3566
|
+
--csv output is csv format [alias: --output=csv]
|
|
3567
|
+
--no-header hide table header from output
|
|
3568
|
+
--no-truncate do not truncate output to fit screen
|
|
3411
3569
|
|
|
3412
3570
|
DESCRIPTION
|
|
3413
3571
|
List Backups for a given Project.
|
|
@@ -3428,21 +3586,19 @@ List backup schedules belonging to a given project.
|
|
|
3428
3586
|
|
|
3429
3587
|
```
|
|
3430
3588
|
USAGE
|
|
3431
|
-
$ mw project backupschedule list [--columns <value> | -x] [--
|
|
3432
|
-
|
|
3589
|
+
$ mw project backupschedule list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3590
|
+
<value>]
|
|
3433
3591
|
|
|
3434
3592
|
FLAGS
|
|
3593
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3594
|
+
<options: json|yaml|csv>
|
|
3435
3595
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3436
3596
|
context
|
|
3437
3597
|
-x, --extended show extra columns
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
--no-truncate do not truncate output to fit screen
|
|
3443
|
-
--output=<option> output in a more machine friendly format
|
|
3444
|
-
<options: csv|json|yaml>
|
|
3445
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3598
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3599
|
+
--csv output is csv format [alias: --output=csv]
|
|
3600
|
+
--no-header hide table header from output
|
|
3601
|
+
--no-truncate do not truncate output to fit screen
|
|
3446
3602
|
|
|
3447
3603
|
DESCRIPTION
|
|
3448
3604
|
List backup schedules belonging to a given project.
|
|
@@ -3466,12 +3622,13 @@ USAGE
|
|
|
3466
3622
|
$ mw project create -d <value> [-s <value>] [-q] [-w] [--wait-timeout <value>] [--update-context]
|
|
3467
3623
|
|
|
3468
3624
|
FLAGS
|
|
3469
|
-
-d, --description=<value>
|
|
3470
|
-
-q, --quiet
|
|
3471
|
-
-s, --server-id=<value>
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3625
|
+
-d, --description=<value> (required) A description for the project.
|
|
3626
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3627
|
+
-s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the
|
|
3628
|
+
context
|
|
3629
|
+
-w, --wait Wait for the resource to be ready.
|
|
3630
|
+
--update-context Update the CLI context to use the newly created project
|
|
3631
|
+
--wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
|
|
3475
3632
|
|
|
3476
3633
|
DESCRIPTION
|
|
3477
3634
|
Create a new project
|
|
@@ -3517,20 +3674,18 @@ List CronjobExecutions belonging to a Cronjob.
|
|
|
3517
3674
|
|
|
3518
3675
|
```
|
|
3519
3676
|
USAGE
|
|
3520
|
-
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--
|
|
3521
|
-
|
|
3677
|
+
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
3678
|
+
json|yaml|csv | | ]
|
|
3522
3679
|
|
|
3523
3680
|
FLAGS
|
|
3524
|
-
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
<options: csv|json|yaml>
|
|
3533
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3681
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3682
|
+
<options: json|yaml|csv>
|
|
3683
|
+
-x, --extended show extra columns
|
|
3684
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3685
|
+
--cronjob-id=<value> (required) ID of the cron job for which to list executions for.
|
|
3686
|
+
--csv output is csv format [alias: --output=csv]
|
|
3687
|
+
--no-header hide table header from output
|
|
3688
|
+
--no-truncate do not truncate output to fit screen
|
|
3534
3689
|
|
|
3535
3690
|
DESCRIPTION
|
|
3536
3691
|
List CronjobExecutions belonging to a Cronjob.
|
|
@@ -3554,7 +3709,7 @@ ARGUMENTS
|
|
|
3554
3709
|
FLAGS
|
|
3555
3710
|
-o, --output=<option> output in a more machine friendly format
|
|
3556
3711
|
<options: json|yaml>
|
|
3557
|
-
|
|
3712
|
+
--no-pager Disable pager for output.
|
|
3558
3713
|
|
|
3559
3714
|
DESCRIPTION
|
|
3560
3715
|
Get the log output of a cronjob execution.
|
|
@@ -3567,52 +3722,28 @@ ALIASES
|
|
|
3567
3722
|
$ mw project cronjob execution logs
|
|
3568
3723
|
```
|
|
3569
3724
|
|
|
3570
|
-
## `mw project cronjob get CRONJOBID`
|
|
3571
|
-
|
|
3572
|
-
Get a cronjob.
|
|
3573
|
-
|
|
3574
|
-
```
|
|
3575
|
-
USAGE
|
|
3576
|
-
$ mw project cronjob get CRONJOBID [-o json|yaml | | ]
|
|
3577
|
-
|
|
3578
|
-
ARGUMENTS
|
|
3579
|
-
CRONJOBID ID of the cronjob to be retrieved.
|
|
3580
|
-
|
|
3581
|
-
FLAGS
|
|
3582
|
-
-o, --output=<option> output in a more machine friendly format
|
|
3583
|
-
<options: json|yaml>
|
|
3584
|
-
|
|
3585
|
-
DESCRIPTION
|
|
3586
|
-
Get a cronjob.
|
|
3587
|
-
|
|
3588
|
-
ALIASES
|
|
3589
|
-
$ mw project cronjob get
|
|
3590
|
-
```
|
|
3591
|
-
|
|
3592
3725
|
## `mw project cronjob list`
|
|
3593
3726
|
|
|
3594
|
-
List
|
|
3727
|
+
List cron jobs belonging to a project.
|
|
3595
3728
|
|
|
3596
3729
|
```
|
|
3597
3730
|
USAGE
|
|
3598
|
-
$ mw project cronjob list [--columns <value> | -x] [--
|
|
3599
|
-
|
|
3731
|
+
$ mw project cronjob list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3732
|
+
<value>]
|
|
3600
3733
|
|
|
3601
3734
|
FLAGS
|
|
3735
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3736
|
+
<options: json|yaml|csv>
|
|
3602
3737
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3603
3738
|
context
|
|
3604
3739
|
-x, --extended show extra columns
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
--no-truncate do not truncate output to fit screen
|
|
3610
|
-
--output=<option> output in a more machine friendly format
|
|
3611
|
-
<options: csv|json|yaml>
|
|
3612
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3740
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3741
|
+
--csv output is csv format [alias: --output=csv]
|
|
3742
|
+
--no-header hide table header from output
|
|
3743
|
+
--no-truncate do not truncate output to fit screen
|
|
3613
3744
|
|
|
3614
3745
|
DESCRIPTION
|
|
3615
|
-
List
|
|
3746
|
+
List cron jobs belonging to a project.
|
|
3616
3747
|
|
|
3617
3748
|
ALIASES
|
|
3618
3749
|
$ mw project cronjob list
|
|
@@ -3651,7 +3782,7 @@ FLAG DESCRIPTIONS
|
|
|
3651
3782
|
|
|
3652
3783
|
## `mw project filesystem usage [PROJECT-ID]`
|
|
3653
3784
|
|
|
3654
|
-
Get a
|
|
3785
|
+
Get a project directory filesystem usage.
|
|
3655
3786
|
|
|
3656
3787
|
```
|
|
3657
3788
|
USAGE
|
|
@@ -3663,10 +3794,10 @@ ARGUMENTS
|
|
|
3663
3794
|
FLAGS
|
|
3664
3795
|
-o, --output=<option> output in a more machine friendly format
|
|
3665
3796
|
<options: json|yaml>
|
|
3666
|
-
|
|
3797
|
+
--human Display human readable sizes.
|
|
3667
3798
|
|
|
3668
3799
|
DESCRIPTION
|
|
3669
|
-
Get a
|
|
3800
|
+
Get a project directory filesystem usage.
|
|
3670
3801
|
```
|
|
3671
3802
|
|
|
3672
3803
|
## `mw project get [PROJECT-ID]`
|
|
@@ -3713,21 +3844,19 @@ List all invites belonging to a project.
|
|
|
3713
3844
|
|
|
3714
3845
|
```
|
|
3715
3846
|
USAGE
|
|
3716
|
-
$ mw project invite list [--columns <value> | -x] [--
|
|
3717
|
-
|
|
3847
|
+
$ mw project invite list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3848
|
+
<value>]
|
|
3718
3849
|
|
|
3719
3850
|
FLAGS
|
|
3851
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3852
|
+
<options: json|yaml|csv>
|
|
3720
3853
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3721
3854
|
context
|
|
3722
3855
|
-x, --extended show extra columns
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
--no-truncate do not truncate output to fit screen
|
|
3728
|
-
--output=<option> output in a more machine friendly format
|
|
3729
|
-
<options: csv|json|yaml>
|
|
3730
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3856
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3857
|
+
--csv output is csv format [alias: --output=csv]
|
|
3858
|
+
--no-header hide table header from output
|
|
3859
|
+
--no-truncate do not truncate output to fit screen
|
|
3731
3860
|
|
|
3732
3861
|
DESCRIPTION
|
|
3733
3862
|
List all invites belonging to a project.
|
|
@@ -3745,19 +3874,16 @@ List all project invites for the executing user.
|
|
|
3745
3874
|
|
|
3746
3875
|
```
|
|
3747
3876
|
USAGE
|
|
3748
|
-
$ mw project invite list-own [--columns <value> | -x] [--
|
|
3749
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3877
|
+
$ mw project invite list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3750
3878
|
|
|
3751
3879
|
FLAGS
|
|
3752
|
-
-
|
|
3753
|
-
|
|
3754
|
-
--
|
|
3755
|
-
|
|
3756
|
-
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
<options: csv|json|yaml>
|
|
3760
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3880
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3881
|
+
<options: json|yaml|csv>
|
|
3882
|
+
-x, --extended show extra columns
|
|
3883
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3884
|
+
--csv output is csv format [alias: --output=csv]
|
|
3885
|
+
--no-header hide table header from output
|
|
3886
|
+
--no-truncate do not truncate output to fit screen
|
|
3761
3887
|
|
|
3762
3888
|
DESCRIPTION
|
|
3763
3889
|
List all project invites for the executing user.
|
|
@@ -3769,19 +3895,16 @@ List all projects that you have access to
|
|
|
3769
3895
|
|
|
3770
3896
|
```
|
|
3771
3897
|
USAGE
|
|
3772
|
-
$ mw project list [--columns <value> | -x] [--
|
|
3773
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3898
|
+
$ mw project list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3774
3899
|
|
|
3775
3900
|
FLAGS
|
|
3776
|
-
-
|
|
3777
|
-
|
|
3778
|
-
--
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
<options: csv|json|yaml>
|
|
3784
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3901
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3902
|
+
<options: json|yaml|csv>
|
|
3903
|
+
-x, --extended show extra columns
|
|
3904
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3905
|
+
--csv output is csv format [alias: --output=csv]
|
|
3906
|
+
--no-header hide table header from output
|
|
3907
|
+
--no-truncate do not truncate output to fit screen
|
|
3785
3908
|
|
|
3786
3909
|
DESCRIPTION
|
|
3787
3910
|
List all projects that you have access to
|
|
@@ -3836,21 +3959,19 @@ List all memberships for a Project.
|
|
|
3836
3959
|
|
|
3837
3960
|
```
|
|
3838
3961
|
USAGE
|
|
3839
|
-
$ mw project membership list [--columns <value> | -x] [--
|
|
3840
|
-
|
|
3962
|
+
$ mw project membership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3963
|
+
<value>]
|
|
3841
3964
|
|
|
3842
3965
|
FLAGS
|
|
3966
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3967
|
+
<options: json|yaml|csv>
|
|
3843
3968
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3844
3969
|
context
|
|
3845
3970
|
-x, --extended show extra columns
|
|
3846
|
-
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
--no-truncate do not truncate output to fit screen
|
|
3851
|
-
--output=<option> output in a more machine friendly format
|
|
3852
|
-
<options: csv|json|yaml>
|
|
3853
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3971
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3972
|
+
--csv output is csv format [alias: --output=csv]
|
|
3973
|
+
--no-header hide table header from output
|
|
3974
|
+
--no-truncate do not truncate output to fit screen
|
|
3854
3975
|
|
|
3855
3976
|
DESCRIPTION
|
|
3856
3977
|
List all memberships for a Project.
|
|
@@ -3868,19 +3989,17 @@ List ProjectMemberships belonging to the executing user.
|
|
|
3868
3989
|
|
|
3869
3990
|
```
|
|
3870
3991
|
USAGE
|
|
3871
|
-
$ mw project membership list-own [--columns <value> | -x] [--
|
|
3872
|
-
|
|
3992
|
+
$ mw project membership list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv |
|
|
3993
|
+
| ]
|
|
3873
3994
|
|
|
3874
3995
|
FLAGS
|
|
3875
|
-
-
|
|
3876
|
-
|
|
3877
|
-
--
|
|
3878
|
-
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
<options: csv|json|yaml>
|
|
3883
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3996
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3997
|
+
<options: json|yaml|csv>
|
|
3998
|
+
-x, --extended show extra columns
|
|
3999
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4000
|
+
--csv output is csv format [alias: --output=csv]
|
|
4001
|
+
--no-header hide table header from output
|
|
4002
|
+
--no-truncate do not truncate output to fit screen
|
|
3884
4003
|
|
|
3885
4004
|
DESCRIPTION
|
|
3886
4005
|
List ProjectMemberships belonging to the executing user.
|
|
@@ -3892,21 +4011,19 @@ List all SFTP users for a project.
|
|
|
3892
4011
|
|
|
3893
4012
|
```
|
|
3894
4013
|
USAGE
|
|
3895
|
-
$ mw project sftp-user list [--columns <value> | -x] [--
|
|
3896
|
-
|
|
4014
|
+
$ mw project sftp-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4015
|
+
<value>]
|
|
3897
4016
|
|
|
3898
4017
|
FLAGS
|
|
4018
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4019
|
+
<options: json|yaml|csv>
|
|
3899
4020
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3900
4021
|
context
|
|
3901
4022
|
-x, --extended show extra columns
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
--no-truncate do not truncate output to fit screen
|
|
3907
|
-
--output=<option> output in a more machine friendly format
|
|
3908
|
-
<options: csv|json|yaml>
|
|
3909
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4023
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4024
|
+
--csv output is csv format [alias: --output=csv]
|
|
4025
|
+
--no-header hide table header from output
|
|
4026
|
+
--no-truncate do not truncate output to fit screen
|
|
3910
4027
|
|
|
3911
4028
|
DESCRIPTION
|
|
3912
4029
|
List all SFTP users for a project.
|
|
@@ -3942,21 +4059,19 @@ List all SSH users for a project.
|
|
|
3942
4059
|
|
|
3943
4060
|
```
|
|
3944
4061
|
USAGE
|
|
3945
|
-
$ mw project ssh-user list [--columns <value> | -x] [--
|
|
3946
|
-
|
|
4062
|
+
$ mw project ssh-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4063
|
+
<value>]
|
|
3947
4064
|
|
|
3948
4065
|
FLAGS
|
|
4066
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4067
|
+
<options: json|yaml|csv>
|
|
3949
4068
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3950
4069
|
context
|
|
3951
4070
|
-x, --extended show extra columns
|
|
3952
|
-
|
|
3953
|
-
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
--no-truncate do not truncate output to fit screen
|
|
3957
|
-
--output=<option> output in a more machine friendly format
|
|
3958
|
-
<options: csv|json|yaml>
|
|
3959
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4071
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4072
|
+
--csv output is csv format [alias: --output=csv]
|
|
4073
|
+
--no-header hide table header from output
|
|
4074
|
+
--no-truncate do not truncate output to fit screen
|
|
3960
4075
|
|
|
3961
4076
|
DESCRIPTION
|
|
3962
4077
|
List all SSH users for a project.
|
|
@@ -4011,19 +4126,16 @@ List servers for an organization or user.
|
|
|
4011
4126
|
|
|
4012
4127
|
```
|
|
4013
4128
|
USAGE
|
|
4014
|
-
$ mw server list [--columns <value> | -x] [--
|
|
4015
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4129
|
+
$ mw server list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4016
4130
|
|
|
4017
4131
|
FLAGS
|
|
4018
|
-
-
|
|
4019
|
-
|
|
4020
|
-
--
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
<options: csv|json|yaml>
|
|
4026
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4132
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4133
|
+
<options: json|yaml|csv>
|
|
4134
|
+
-x, --extended show extra columns
|
|
4135
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4136
|
+
--csv output is csv format [alias: --output=csv]
|
|
4137
|
+
--no-header hide table header from output
|
|
4138
|
+
--no-truncate do not truncate output to fit screen
|
|
4027
4139
|
|
|
4028
4140
|
DESCRIPTION
|
|
4029
4141
|
List servers for an organization or user.
|
|
@@ -4035,21 +4147,19 @@ List all SFTP users for a project.
|
|
|
4035
4147
|
|
|
4036
4148
|
```
|
|
4037
4149
|
USAGE
|
|
4038
|
-
$ mw sftp-user list [--columns <value> | -x] [--
|
|
4039
|
-
|
|
4150
|
+
$ mw sftp-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4151
|
+
<value>]
|
|
4040
4152
|
|
|
4041
4153
|
FLAGS
|
|
4154
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4155
|
+
<options: json|yaml|csv>
|
|
4042
4156
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
4043
4157
|
context
|
|
4044
4158
|
-x, --extended show extra columns
|
|
4045
|
-
|
|
4046
|
-
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
--no-truncate do not truncate output to fit screen
|
|
4050
|
-
--output=<option> output in a more machine friendly format
|
|
4051
|
-
<options: csv|json|yaml>
|
|
4052
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4159
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4160
|
+
--csv output is csv format [alias: --output=csv]
|
|
4161
|
+
--no-header hide table header from output
|
|
4162
|
+
--no-truncate do not truncate output to fit screen
|
|
4053
4163
|
|
|
4054
4164
|
DESCRIPTION
|
|
4055
4165
|
List all SFTP users for a project.
|
|
@@ -4070,21 +4180,19 @@ List all SSH users for a project.
|
|
|
4070
4180
|
|
|
4071
4181
|
```
|
|
4072
4182
|
USAGE
|
|
4073
|
-
$ mw ssh-user list [--columns <value> | -x] [--
|
|
4074
|
-
|
|
4183
|
+
$ mw ssh-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4184
|
+
<value>]
|
|
4075
4185
|
|
|
4076
4186
|
FLAGS
|
|
4187
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4188
|
+
<options: json|yaml|csv>
|
|
4077
4189
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
4078
4190
|
context
|
|
4079
4191
|
-x, --extended show extra columns
|
|
4080
|
-
|
|
4081
|
-
|
|
4082
|
-
|
|
4083
|
-
|
|
4084
|
-
--no-truncate do not truncate output to fit screen
|
|
4085
|
-
--output=<option> output in a more machine friendly format
|
|
4086
|
-
<options: csv|json|yaml>
|
|
4087
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4192
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4193
|
+
--csv output is csv format [alias: --output=csv]
|
|
4194
|
+
--no-header hide table header from output
|
|
4195
|
+
--no-truncate do not truncate output to fit screen
|
|
4088
4196
|
|
|
4089
4197
|
DESCRIPTION
|
|
4090
4198
|
List all SSH users for a project.
|
|
@@ -4111,7 +4219,7 @@ FLAGS
|
|
|
4111
4219
|
-a, --available See available versions.
|
|
4112
4220
|
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
|
|
4113
4221
|
-v, --version=<value> Install a specific version.
|
|
4114
|
-
|
|
4222
|
+
--force Force a re-download of the requested version.
|
|
4115
4223
|
|
|
4116
4224
|
DESCRIPTION
|
|
4117
4225
|
update the mw CLI
|
|
@@ -4134,7 +4242,7 @@ EXAMPLES
|
|
|
4134
4242
|
$ mw update --available
|
|
4135
4243
|
```
|
|
4136
4244
|
|
|
4137
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.1.
|
|
4245
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.1.7/src/commands/update.ts)_
|
|
4138
4246
|
|
|
4139
4247
|
## `mw user api-token create`
|
|
4140
4248
|
|
|
@@ -4145,11 +4253,11 @@ USAGE
|
|
|
4145
4253
|
$ mw user api-token create --description <value> --roles api_read|api_write [-q] [--expires-in <value>]
|
|
4146
4254
|
|
|
4147
4255
|
FLAGS
|
|
4148
|
-
-q, --quiet
|
|
4149
|
-
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
4256
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
4257
|
+
--description=<value> (required) Description of the API token
|
|
4258
|
+
--expires-in=<value> Expiration interval of the API token (example: 30d)
|
|
4259
|
+
--roles=<option>... (required) Roles of the API token
|
|
4260
|
+
<options: api_read|api_write>
|
|
4153
4261
|
|
|
4154
4262
|
DESCRIPTION
|
|
4155
4263
|
Create a new API token
|
|
@@ -4186,19 +4294,16 @@ List all API tokens of the user
|
|
|
4186
4294
|
|
|
4187
4295
|
```
|
|
4188
4296
|
USAGE
|
|
4189
|
-
$ mw user api-token list [--columns <value> | -x] [--
|
|
4190
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4297
|
+
$ mw user api-token list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4191
4298
|
|
|
4192
4299
|
FLAGS
|
|
4193
|
-
-
|
|
4194
|
-
|
|
4195
|
-
--
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
|
|
4199
|
-
|
|
4200
|
-
<options: csv|json|yaml>
|
|
4201
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4300
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4301
|
+
<options: json|yaml|csv>
|
|
4302
|
+
-x, --extended show extra columns
|
|
4303
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4304
|
+
--csv output is csv format [alias: --output=csv]
|
|
4305
|
+
--no-header hide table header from output
|
|
4306
|
+
--no-truncate do not truncate output to fit screen
|
|
4202
4307
|
|
|
4203
4308
|
DESCRIPTION
|
|
4204
4309
|
List all API tokens of the user
|
|
@@ -4274,19 +4379,16 @@ List all active sessions
|
|
|
4274
4379
|
|
|
4275
4380
|
```
|
|
4276
4381
|
USAGE
|
|
4277
|
-
$ mw user session list [--columns <value> | -x] [--
|
|
4278
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4382
|
+
$ mw user session list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4279
4383
|
|
|
4280
4384
|
FLAGS
|
|
4281
|
-
-
|
|
4282
|
-
|
|
4283
|
-
--
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
<options: csv|json|yaml>
|
|
4289
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4385
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4386
|
+
<options: json|yaml|csv>
|
|
4387
|
+
-x, --extended show extra columns
|
|
4388
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4389
|
+
--csv output is csv format [alias: --output=csv]
|
|
4390
|
+
--no-header hide table header from output
|
|
4391
|
+
--no-truncate do not truncate output to fit screen
|
|
4290
4392
|
|
|
4291
4393
|
DESCRIPTION
|
|
4292
4394
|
List all active sessions
|
|
@@ -4301,11 +4403,11 @@ USAGE
|
|
|
4301
4403
|
$ mw user ssh-key create [-q] [--output <value>] [--no-passphrase] [--comment <value>] [--expiresAt <value>]
|
|
4302
4404
|
|
|
4303
4405
|
FLAGS
|
|
4304
|
-
-q, --quiet
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
4406
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
4407
|
+
--comment=<value> A comment for the SSH key.
|
|
4408
|
+
--expiresAt=<value> Duration after which the SSH key should expire (example: '1y').
|
|
4409
|
+
--no-passphrase Use this flag to not set a passphrase for the SSH key.
|
|
4410
|
+
--output=<value> [default: mstudio-cli] A filename in your ~/.ssh directory to write the SSH key to.
|
|
4309
4411
|
|
|
4310
4412
|
DESCRIPTION
|
|
4311
4413
|
Create and import a new SSH key
|
|
@@ -4367,19 +4469,16 @@ Get your stored ssh keys
|
|
|
4367
4469
|
|
|
4368
4470
|
```
|
|
4369
4471
|
USAGE
|
|
4370
|
-
$ mw user ssh-key list [--columns <value> | -x] [--
|
|
4371
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4472
|
+
$ mw user ssh-key list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4372
4473
|
|
|
4373
4474
|
FLAGS
|
|
4374
|
-
-
|
|
4375
|
-
|
|
4376
|
-
--
|
|
4377
|
-
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
|
-
<options: csv|json|yaml>
|
|
4382
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4475
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4476
|
+
<options: json|yaml|csv>
|
|
4477
|
+
-x, --extended show extra columns
|
|
4478
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4479
|
+
--csv output is csv format [alias: --output=csv]
|
|
4480
|
+
--no-header hide table header from output
|
|
4481
|
+
--no-truncate do not truncate output to fit screen
|
|
4383
4482
|
|
|
4384
4483
|
DESCRIPTION
|
|
4385
4484
|
Get your stored ssh keys
|