@mittwald/cli 1.0.0-alpha.26 → 1.0.0-alpha.28
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 +1060 -721
- 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 +1 -1
- package/dist/esm/commands/app/copy.js +3 -3
- package/dist/esm/commands/app/create/python.d.ts +12 -0
- package/dist/esm/commands/app/create/python.js +13 -0
- package/dist/esm/commands/app/create/static.d.ts +1 -1
- package/dist/esm/commands/app/create/static.js +1 -1
- package/dist/esm/commands/app/dependency/list.d.ts +1 -1
- package/dist/esm/commands/app/dependency/update.d.ts +1 -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 +1 -1
- package/dist/esm/commands/app/get.js +4 -3
- package/dist/esm/commands/app/install/drupal.d.ts +11 -0
- package/dist/esm/commands/app/install/drupal.js +21 -0
- package/dist/esm/commands/app/install/grav.d.ts +11 -0
- package/dist/esm/commands/app/install/grav.js +22 -0
- package/dist/esm/commands/app/install/nextcloud.d.ts +11 -0
- package/dist/esm/commands/app/install/nextcloud.js +21 -0
- 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 +4 -3
- package/dist/esm/commands/app/ssh.js +18 -9
- package/dist/esm/commands/app/uninstall.d.ts +1 -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/conversation/show.js +1 -2
- package/dist/esm/commands/cronjob/create.d.ts +22 -0
- package/dist/esm/commands/cronjob/create.js +96 -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/user/list.d.ts +1 -2
- package/dist/esm/commands/database/mysql/user/list.js +2 -3
- 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/list.d.ts +1 -2
- package/dist/esm/commands/domain/dnszone/list.js +2 -2
- package/dist/esm/commands/domain/list.d.ts +1 -2
- package/dist/esm/commands/domain/list.js +3 -4
- package/dist/esm/commands/domain/ownership/list.js +3 -7
- package/dist/esm/commands/domain/virtualhost/create.js +4 -4
- package/dist/esm/commands/domain/virtualhost/delete.js +1 -1
- package/dist/esm/commands/domain/virtualhost/get.js +1 -1
- 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/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/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/list.js +2 -2
- 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 +4 -2
- package/dist/esm/lib/app/flags.js +3 -7
- 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 +24 -5
- package/dist/esm/lib/context.js +21 -16
- package/dist/esm/lib/context_flags.d.ts +10 -6
- package/dist/esm/lib/context_flags.js +8 -5
- 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 +34 -0
- package/dist/esm/lib/org/flags.d.ts +1 -9
- package/dist/esm/lib/org/flags.js +1 -1
- package/dist/esm/lib/project/flags.d.ts +1 -9
- package/dist/esm/lib/project/flags.js +1 -1
- package/dist/esm/lib/project/ingress.js +4 -2
- package/dist/esm/lib/server/flags.d.ts +1 -9
- package/dist/esm/lib/server/flags.js +1 -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/CronJob/CronJobDetails.d.ts +8 -0
- package/dist/esm/rendering/react/components/CronJob/CronJobDetails.js +48 -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/package.json +8 -6
package/README.md
CHANGED
|
@@ -62,6 +62,16 @@ Enter your mStudio API token: ****************
|
|
|
62
62
|
token saved to '/Users/mhelmich/.config/mw/token'
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
+
### Setting up shell autocompletion
|
|
66
|
+
|
|
67
|
+
The `mw` CLI offers a lot of commands and flags, and it can be hard to remember all of them. To make your life easier, the CLI offers autocompletion for the Bash and ZSH shells. To enable autocompletion, run the following command:
|
|
68
|
+
|
|
69
|
+
```shell
|
|
70
|
+
$ mw autocomplete
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
After that, follow the instructions printed by that command (those are specific to your shell -- Bash, ZSH and Powershell are supported).
|
|
74
|
+
|
|
65
75
|
## Usage
|
|
66
76
|
|
|
67
77
|
```sh-session
|
|
@@ -79,25 +89,30 @@ USAGE
|
|
|
79
89
|
## Commands
|
|
80
90
|
|
|
81
91
|
<!-- commands -->
|
|
82
|
-
* [`mw app copy INSTALLATION-ID`](#mw-app-copy-installation-id)
|
|
92
|
+
* [`mw app copy [INSTALLATION-ID]`](#mw-app-copy-installation-id)
|
|
83
93
|
* [`mw app create node`](#mw-app-create-node)
|
|
84
94
|
* [`mw app create php`](#mw-app-create-php)
|
|
95
|
+
* [`mw app create python`](#mw-app-create-python)
|
|
85
96
|
* [`mw app create static`](#mw-app-create-static)
|
|
86
97
|
* [`mw app dependency list`](#mw-app-dependency-list)
|
|
87
|
-
* [`mw app dependency update INSTALLATION-ID`](#mw-app-dependency-update-installation-id)
|
|
98
|
+
* [`mw app dependency update [INSTALLATION-ID]`](#mw-app-dependency-update-installation-id)
|
|
88
99
|
* [`mw app dependency versions SYSTEMSOFTWARE`](#mw-app-dependency-versions-systemsoftware)
|
|
89
|
-
* [`mw app get INSTALLATION-ID`](#mw-app-get-installation-id)
|
|
100
|
+
* [`mw app get [INSTALLATION-ID]`](#mw-app-get-installation-id)
|
|
90
101
|
* [`mw app install contao`](#mw-app-install-contao)
|
|
102
|
+
* [`mw app install drupal`](#mw-app-install-drupal)
|
|
103
|
+
* [`mw app install grav`](#mw-app-install-grav)
|
|
91
104
|
* [`mw app install joomla`](#mw-app-install-joomla)
|
|
92
105
|
* [`mw app install matomo`](#mw-app-install-matomo)
|
|
106
|
+
* [`mw app install nextcloud`](#mw-app-install-nextcloud)
|
|
93
107
|
* [`mw app install shopware5`](#mw-app-install-shopware5)
|
|
94
108
|
* [`mw app install shopware6`](#mw-app-install-shopware6)
|
|
95
109
|
* [`mw app install typo3`](#mw-app-install-typo3)
|
|
96
110
|
* [`mw app install wordpress`](#mw-app-install-wordpress)
|
|
97
111
|
* [`mw app list`](#mw-app-list)
|
|
98
|
-
* [`mw app ssh INSTALLATION-ID`](#mw-app-ssh-installation-id)
|
|
99
|
-
* [`mw app uninstall INSTALLATION-ID`](#mw-app-uninstall-installation-id)
|
|
112
|
+
* [`mw app ssh [INSTALLATION-ID]`](#mw-app-ssh-installation-id)
|
|
113
|
+
* [`mw app uninstall [INSTALLATION-ID]`](#mw-app-uninstall-installation-id)
|
|
100
114
|
* [`mw app versions [APP]`](#mw-app-versions-app)
|
|
115
|
+
* [`mw autocomplete [SHELL]`](#mw-autocomplete-shell)
|
|
101
116
|
* [`mw backup create`](#mw-backup-create)
|
|
102
117
|
* [`mw backup delete BACKUP-ID`](#mw-backup-delete-backup-id)
|
|
103
118
|
* [`mw backup download BACKUP-ID`](#mw-backup-download-backup-id)
|
|
@@ -113,10 +128,14 @@ USAGE
|
|
|
113
128
|
* [`mw conversation reply ID`](#mw-conversation-reply-id)
|
|
114
129
|
* [`mw conversation show ID`](#mw-conversation-show-id)
|
|
115
130
|
* [`mw conversation show2 CONVERSATIONID`](#mw-conversation-show2-conversationid)
|
|
131
|
+
* [`mw cronjob create`](#mw-cronjob-create)
|
|
132
|
+
* [`mw cronjob delete CRONJOB-ID`](#mw-cronjob-delete-cronjob-id)
|
|
133
|
+
* [`mw cronjob execute CRONJOB-ID`](#mw-cronjob-execute-cronjob-id)
|
|
134
|
+
* [`mw cronjob execution abort CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-abort-cronjob-id-execution-id)
|
|
116
135
|
* [`mw cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-get-cronjob-id-execution-id)
|
|
117
136
|
* [`mw cronjob execution list`](#mw-cronjob-execution-list)
|
|
118
137
|
* [`mw cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-logs-cronjob-id-execution-id)
|
|
119
|
-
* [`mw cronjob get
|
|
138
|
+
* [`mw cronjob get CRONJOB-ID`](#mw-cronjob-get-cronjob-id)
|
|
120
139
|
* [`mw cronjob list`](#mw-cronjob-list)
|
|
121
140
|
* [`mw database mysql charsets`](#mw-database-mysql-charsets)
|
|
122
141
|
* [`mw database mysql create`](#mw-database-mysql-create)
|
|
@@ -175,7 +194,6 @@ USAGE
|
|
|
175
194
|
* [`mw project cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-get-cronjob-id-execution-id)
|
|
176
195
|
* [`mw project cronjob execution list`](#mw-project-cronjob-execution-list)
|
|
177
196
|
* [`mw project cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-logs-cronjob-id-execution-id)
|
|
178
|
-
* [`mw project cronjob get CRONJOBID`](#mw-project-cronjob-get-cronjobid)
|
|
179
197
|
* [`mw project cronjob list`](#mw-project-cronjob-list)
|
|
180
198
|
* [`mw project delete [PROJECT-ID]`](#mw-project-delete-project-id)
|
|
181
199
|
* [`mw project filesystem usage [PROJECT-ID]`](#mw-project-filesystem-usage-project-id)
|
|
@@ -209,20 +227,21 @@ USAGE
|
|
|
209
227
|
* [`mw user ssh-key get KEY-ID`](#mw-user-ssh-key-get-key-id)
|
|
210
228
|
* [`mw user ssh-key list`](#mw-user-ssh-key-list)
|
|
211
229
|
|
|
212
|
-
## `mw app copy INSTALLATION-ID`
|
|
230
|
+
## `mw app copy [INSTALLATION-ID]`
|
|
213
231
|
|
|
214
232
|
Copy an app within a project
|
|
215
233
|
|
|
216
234
|
```
|
|
217
235
|
USAGE
|
|
218
|
-
$ mw app copy INSTALLATION-ID --description <value> [-q]
|
|
236
|
+
$ mw app copy [INSTALLATION-ID] --description <value> [-q]
|
|
219
237
|
|
|
220
238
|
ARGUMENTS
|
|
221
|
-
INSTALLATION-ID ID of
|
|
239
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
240
|
+
in the context
|
|
222
241
|
|
|
223
242
|
FLAGS
|
|
224
|
-
-q, --quiet
|
|
225
|
-
|
|
243
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
244
|
+
--description=<value> (required) set a description for the new app installation
|
|
226
245
|
|
|
227
246
|
DESCRIPTION
|
|
228
247
|
Copy an app within a project
|
|
@@ -248,7 +267,7 @@ FLAGS
|
|
|
248
267
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
249
268
|
-w, --wait Wait for your custom Node.js to be ready.
|
|
250
269
|
--json
|
|
251
|
-
|
|
270
|
+
--site-title=<value> Site Title for your custom Node.js installation.
|
|
252
271
|
|
|
253
272
|
DESCRIPTION
|
|
254
273
|
Creates new custom Node.js installation.
|
|
@@ -281,14 +300,14 @@ USAGE
|
|
|
281
300
|
$ mw app create php --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
282
301
|
|
|
283
302
|
FLAGS
|
|
284
|
-
-p, --project-id=<value>
|
|
285
|
-
|
|
286
|
-
-q, --quiet
|
|
287
|
-
-w, --wait
|
|
288
|
-
|
|
289
|
-
|
|
303
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
304
|
+
context
|
|
305
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
306
|
+
-w, --wait Wait for your custom PHP to be ready.
|
|
307
|
+
--document-root=<value> (required) [default: /] The document root from which your custom PHP will be served
|
|
308
|
+
(relative to the installation path)
|
|
290
309
|
--json
|
|
291
|
-
|
|
310
|
+
--site-title=<value> Site Title for your custom PHP installation.
|
|
292
311
|
|
|
293
312
|
DESCRIPTION
|
|
294
313
|
Creates new custom PHP installation.
|
|
@@ -319,6 +338,54 @@ FLAG DESCRIPTIONS
|
|
|
319
338
|
installation is finished
|
|
320
339
|
```
|
|
321
340
|
|
|
341
|
+
## `mw app create python`
|
|
342
|
+
|
|
343
|
+
Creates new custom python site installation.
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
USAGE
|
|
347
|
+
$ mw app create python --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
348
|
+
|
|
349
|
+
FLAGS
|
|
350
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
351
|
+
context
|
|
352
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
353
|
+
-w, --wait Wait for your custom python site to be ready.
|
|
354
|
+
--document-root=<value> (required) [default: /] The document root from which your custom python site will be
|
|
355
|
+
served (relative to the installation path)
|
|
356
|
+
--json
|
|
357
|
+
--site-title=<value> Site Title for your custom python site installation.
|
|
358
|
+
|
|
359
|
+
DESCRIPTION
|
|
360
|
+
Creates new custom python site installation.
|
|
361
|
+
|
|
362
|
+
FLAG DESCRIPTIONS
|
|
363
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
364
|
+
|
|
365
|
+
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
|
|
366
|
+
to persistently set a default project for all commands that accept this flag.
|
|
367
|
+
|
|
368
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
369
|
+
|
|
370
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
371
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
372
|
+
|
|
373
|
+
--document-root=<value>
|
|
374
|
+
|
|
375
|
+
The document root from which your custom python site will be served (relative to the installation path)
|
|
376
|
+
|
|
377
|
+
This is the document root from which the files of your application will be served by the web server. This directory
|
|
378
|
+
is specified relative to the installation path.
|
|
379
|
+
|
|
380
|
+
--site-title=<value> Site Title for your custom python site installation.
|
|
381
|
+
|
|
382
|
+
Site Title which will be displayed in the Tab and at the top of the Frontend of your custom python site
|
|
383
|
+
installation.
|
|
384
|
+
It is also the Title shown in the App-Overview in the mStudio.
|
|
385
|
+
If none is given the Software Name and the given Project will be used. The Title can be changed after the
|
|
386
|
+
installation is finished
|
|
387
|
+
```
|
|
388
|
+
|
|
322
389
|
## `mw app create static`
|
|
323
390
|
|
|
324
391
|
Creates new custom static site installation.
|
|
@@ -328,14 +395,14 @@ USAGE
|
|
|
328
395
|
$ mw app create static --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
329
396
|
|
|
330
397
|
FLAGS
|
|
331
|
-
-p, --project-id=<value>
|
|
332
|
-
|
|
333
|
-
-q, --quiet
|
|
334
|
-
-w, --wait
|
|
335
|
-
|
|
336
|
-
|
|
398
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
399
|
+
context
|
|
400
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
401
|
+
-w, --wait Wait for your custom static site to be ready.
|
|
402
|
+
--document-root=<value> (required) [default: /] The document root from which your custom static site will be
|
|
403
|
+
served (relative to the installation path)
|
|
337
404
|
--json
|
|
338
|
-
|
|
405
|
+
--site-title=<value> Site Title for your custom static site installation.
|
|
339
406
|
|
|
340
407
|
DESCRIPTION
|
|
341
408
|
Creates new custom static site installation.
|
|
@@ -373,40 +440,38 @@ Get all available dependencies
|
|
|
373
440
|
|
|
374
441
|
```
|
|
375
442
|
USAGE
|
|
376
|
-
$ mw app dependency list [--columns <value> | -x] [--
|
|
377
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
443
|
+
$ mw app dependency list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
378
444
|
|
|
379
445
|
FLAGS
|
|
380
|
-
-
|
|
381
|
-
|
|
382
|
-
--
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
<options: csv|json|yaml>
|
|
388
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
446
|
+
-o, --output=<option> output in a more machine friendly format
|
|
447
|
+
<options: json|yaml|csv>
|
|
448
|
+
-x, --extended show extra columns
|
|
449
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
450
|
+
--csv output is csv format [alias: --output=csv]
|
|
451
|
+
--no-header hide table header from output
|
|
452
|
+
--no-truncate do not truncate output to fit screen
|
|
389
453
|
|
|
390
454
|
DESCRIPTION
|
|
391
455
|
Get all available dependencies
|
|
392
456
|
```
|
|
393
457
|
|
|
394
|
-
## `mw app dependency update INSTALLATION-ID`
|
|
458
|
+
## `mw app dependency update [INSTALLATION-ID]`
|
|
395
459
|
|
|
396
460
|
Update the dependencies of an app
|
|
397
461
|
|
|
398
462
|
```
|
|
399
463
|
USAGE
|
|
400
|
-
$ mw app dependency update INSTALLATION-ID --set <value> [-q] [--update-policy none|inheritedFromApp|patchLevel|all]
|
|
464
|
+
$ mw app dependency update [INSTALLATION-ID] --set <value> [-q] [--update-policy none|inheritedFromApp|patchLevel|all]
|
|
401
465
|
|
|
402
466
|
ARGUMENTS
|
|
403
|
-
INSTALLATION-ID ID of
|
|
467
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
468
|
+
in the context
|
|
404
469
|
|
|
405
470
|
FLAGS
|
|
406
|
-
-q, --quiet
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
471
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
472
|
+
--set=<value>... (required) set a dependency to a specific version
|
|
473
|
+
--update-policy=<option> [default: patchLevel] set the update policy for the configured dependencies
|
|
474
|
+
<options: none|inheritedFromApp|patchLevel|all>
|
|
410
475
|
|
|
411
476
|
EXAMPLES
|
|
412
477
|
Update Node.js version to newest available from the 18.x branch
|
|
@@ -433,37 +498,36 @@ Get all available versions of a particular dependency
|
|
|
433
498
|
|
|
434
499
|
```
|
|
435
500
|
USAGE
|
|
436
|
-
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--
|
|
437
|
-
|
|
501
|
+
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
502
|
+
json|yaml|csv | | ]
|
|
438
503
|
|
|
439
504
|
ARGUMENTS
|
|
440
505
|
SYSTEMSOFTWARE name of the systemsoftware for which to list versions
|
|
441
506
|
|
|
442
507
|
FLAGS
|
|
443
|
-
-
|
|
444
|
-
|
|
445
|
-
--
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
<options: csv|json|yaml>
|
|
451
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
508
|
+
-o, --output=<option> output in a more machine friendly format
|
|
509
|
+
<options: json|yaml|csv>
|
|
510
|
+
-x, --extended show extra columns
|
|
511
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
512
|
+
--csv output is csv format [alias: --output=csv]
|
|
513
|
+
--no-header hide table header from output
|
|
514
|
+
--no-truncate do not truncate output to fit screen
|
|
452
515
|
|
|
453
516
|
DESCRIPTION
|
|
454
517
|
Get all available versions of a particular dependency
|
|
455
518
|
```
|
|
456
519
|
|
|
457
|
-
## `mw app get INSTALLATION-ID`
|
|
520
|
+
## `mw app get [INSTALLATION-ID]`
|
|
458
521
|
|
|
459
522
|
Get details about an app installation
|
|
460
523
|
|
|
461
524
|
```
|
|
462
525
|
USAGE
|
|
463
|
-
$ mw app get INSTALLATION-ID [-o json|yaml | | ]
|
|
526
|
+
$ mw app get [INSTALLATION-ID] [-o json|yaml | | ]
|
|
464
527
|
|
|
465
528
|
ARGUMENTS
|
|
466
|
-
INSTALLATION-ID ID of
|
|
529
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
530
|
+
in the context
|
|
467
531
|
|
|
468
532
|
FLAGS
|
|
469
533
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -484,19 +548,20 @@ USAGE
|
|
|
484
548
|
[--json]
|
|
485
549
|
|
|
486
550
|
FLAGS
|
|
487
|
-
-p, --project-id=<value>
|
|
488
|
-
|
|
489
|
-
-q, --quiet
|
|
490
|
-
-w, --wait
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
551
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
552
|
+
context
|
|
553
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
554
|
+
-w, --wait Wait for your Contao to be ready.
|
|
555
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
556
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
557
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
558
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
559
|
+
--admin-user=<value> Username for your administrator-user.
|
|
560
|
+
--host=<value> Host to initially configure your Contao installation with; needs to be created
|
|
561
|
+
separately.
|
|
497
562
|
--json
|
|
498
|
-
|
|
499
|
-
|
|
563
|
+
--site-title=<value> Site Title for your Contao installation.
|
|
564
|
+
--version=<value> (required) [default: latest] Version of Contao to be installed.
|
|
500
565
|
|
|
501
566
|
DESCRIPTION
|
|
502
567
|
Creates new Contao installation.
|
|
@@ -563,6 +628,162 @@ FLAG DESCRIPTIONS
|
|
|
563
628
|
If none is given the Contao will be installed in the latest available version.
|
|
564
629
|
```
|
|
565
630
|
|
|
631
|
+
## `mw app install drupal`
|
|
632
|
+
|
|
633
|
+
Creates new Drupal installation.
|
|
634
|
+
|
|
635
|
+
```
|
|
636
|
+
USAGE
|
|
637
|
+
$ mw app install drupal --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
|
|
638
|
+
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
639
|
+
|
|
640
|
+
FLAGS
|
|
641
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
642
|
+
context
|
|
643
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
644
|
+
-w, --wait Wait for your Drupal to be ready.
|
|
645
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
646
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
647
|
+
--admin-user=<value> Username for your administrator-user.
|
|
648
|
+
--host=<value> Host to initially configure your Drupal installation with; needs to be created separately.
|
|
649
|
+
--json
|
|
650
|
+
--site-title=<value> Site Title for your Drupal installation.
|
|
651
|
+
--version=<value> (required) [default: latest] Version of Drupal to be installed.
|
|
652
|
+
|
|
653
|
+
DESCRIPTION
|
|
654
|
+
Creates new Drupal installation.
|
|
655
|
+
|
|
656
|
+
FLAG DESCRIPTIONS
|
|
657
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
658
|
+
|
|
659
|
+
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
|
|
660
|
+
to persistently set a default project for all commands that accept this flag.
|
|
661
|
+
|
|
662
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
663
|
+
|
|
664
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
665
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
666
|
+
|
|
667
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
668
|
+
|
|
669
|
+
E-Mail-Address that will correlate to the first administrator-user which will be created during the Drupal
|
|
670
|
+
installation.
|
|
671
|
+
If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
|
|
672
|
+
installation is finished.
|
|
673
|
+
|
|
674
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
675
|
+
|
|
676
|
+
Password that will correlate to the first administrator-user which will be created during the Drupal installation.
|
|
677
|
+
If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
|
|
678
|
+
installation is finished
|
|
679
|
+
|
|
680
|
+
--admin-user=<value> Username for your administrator-user.
|
|
681
|
+
|
|
682
|
+
Username of the first administrator-user which will be created during the Drupal installation.
|
|
683
|
+
If not given an adequate username will be created from your mStudio Account Data.
|
|
684
|
+
After the installation is finished the Username can be changed and additional administrator-users can be created.
|
|
685
|
+
|
|
686
|
+
--host=<value> Host to initially configure your Drupal installation with; needs to be created separately.
|
|
687
|
+
|
|
688
|
+
Specify a host which will be used during the installation and as an initial host for the Drupal configuration.
|
|
689
|
+
If not given the default host for the given Project will be used.
|
|
690
|
+
This does not change the target of the used Host and can be changed later by configuring the Host and your Drupal
|
|
691
|
+
installation.
|
|
692
|
+
|
|
693
|
+
--site-title=<value> Site Title for your Drupal installation.
|
|
694
|
+
|
|
695
|
+
Site Title which will be displayed in the Tab and at the top of the Frontend of your Drupal installation.
|
|
696
|
+
It is also the Title shown in the App-Overview in the mStudio.
|
|
697
|
+
If none is given the Software Name and the given Project will be used. The Title can be changed after the
|
|
698
|
+
installation is finished
|
|
699
|
+
|
|
700
|
+
--version=<value> Version of Drupal to be installed.
|
|
701
|
+
|
|
702
|
+
Specify the Version in which your Drupal will be installed.
|
|
703
|
+
If none is given the Drupal will be installed in the latest available version.
|
|
704
|
+
```
|
|
705
|
+
|
|
706
|
+
## `mw app install grav`
|
|
707
|
+
|
|
708
|
+
Creates new Grav installation.
|
|
709
|
+
|
|
710
|
+
```
|
|
711
|
+
USAGE
|
|
712
|
+
$ mw app install grav --version <value> [-p <value>] [-q] [--admin-user <value>] [--admin-email <value>]
|
|
713
|
+
[--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>] [-w] [--json]
|
|
714
|
+
|
|
715
|
+
FLAGS
|
|
716
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
717
|
+
context
|
|
718
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
719
|
+
-w, --wait Wait for your Grav to be ready.
|
|
720
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
721
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
722
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
723
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
724
|
+
--admin-user=<value> Username for your administrator-user.
|
|
725
|
+
--json
|
|
726
|
+
--site-title=<value> Site Title for your Grav installation.
|
|
727
|
+
--version=<value> (required) [default: latest] Version of Grav to be installed.
|
|
728
|
+
|
|
729
|
+
DESCRIPTION
|
|
730
|
+
Creates new Grav installation.
|
|
731
|
+
|
|
732
|
+
FLAG DESCRIPTIONS
|
|
733
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
734
|
+
|
|
735
|
+
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
|
|
736
|
+
to persistently set a default project for all commands that accept this flag.
|
|
737
|
+
|
|
738
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
739
|
+
|
|
740
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
741
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
742
|
+
|
|
743
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
744
|
+
|
|
745
|
+
E-Mail-Address that will correlate to the first administrator-user which will be created during the Grav
|
|
746
|
+
installation.
|
|
747
|
+
If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
|
|
748
|
+
installation is finished.
|
|
749
|
+
|
|
750
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
751
|
+
|
|
752
|
+
Firstname that will correlate to the first administrator-user which will be created during the Grav installation.
|
|
753
|
+
If none is given your mStudio Account-Firstname will be used. This Firstname can be changed after the installation
|
|
754
|
+
is finished
|
|
755
|
+
|
|
756
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
757
|
+
|
|
758
|
+
Lastname that will correlate to the first administrator-user which will be created during the Grav installation.
|
|
759
|
+
If none is given your mStudio Account-Firstname will be used. This Lastname can be changed after the installation is
|
|
760
|
+
finished
|
|
761
|
+
|
|
762
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
763
|
+
|
|
764
|
+
Password that will correlate to the first administrator-user which will be created during the Grav installation.
|
|
765
|
+
If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
|
|
766
|
+
installation is finished
|
|
767
|
+
|
|
768
|
+
--admin-user=<value> Username for your administrator-user.
|
|
769
|
+
|
|
770
|
+
Username of the first administrator-user which will be created during the Grav installation.
|
|
771
|
+
If not given an adequate username will be created from your mStudio Account Data.
|
|
772
|
+
After the installation is finished the Username can be changed and additional administrator-users can be created.
|
|
773
|
+
|
|
774
|
+
--site-title=<value> Site Title for your Grav installation.
|
|
775
|
+
|
|
776
|
+
Site Title which will be displayed in the Tab and at the top of the Frontend of your Grav installation.
|
|
777
|
+
It is also the Title shown in the App-Overview in the mStudio.
|
|
778
|
+
If none is given the Software Name and the given Project will be used. The Title can be changed after the
|
|
779
|
+
installation is finished
|
|
780
|
+
|
|
781
|
+
--version=<value> Version of Grav to be installed.
|
|
782
|
+
|
|
783
|
+
Specify the Version in which your Grav will be installed.
|
|
784
|
+
If none is given the Grav will be installed in the latest available version.
|
|
785
|
+
```
|
|
786
|
+
|
|
566
787
|
## `mw app install joomla`
|
|
567
788
|
|
|
568
789
|
Creates new Joomla! installation.
|
|
@@ -574,19 +795,20 @@ USAGE
|
|
|
574
795
|
[--json]
|
|
575
796
|
|
|
576
797
|
FLAGS
|
|
577
|
-
-p, --project-id=<value>
|
|
578
|
-
|
|
579
|
-
-q, --quiet
|
|
580
|
-
-w, --wait
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
798
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
799
|
+
context
|
|
800
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
801
|
+
-w, --wait Wait for your Joomla! to be ready.
|
|
802
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
803
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
804
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
805
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
806
|
+
--admin-user=<value> Username for your administrator-user.
|
|
807
|
+
--host=<value> Host to initially configure your Joomla! installation with; needs to be created
|
|
808
|
+
separately.
|
|
587
809
|
--json
|
|
588
|
-
|
|
589
|
-
|
|
810
|
+
--site-title=<value> Site Title for your Joomla! installation.
|
|
811
|
+
--version=<value> (required) [default: latest] Version of Joomla! to be installed.
|
|
590
812
|
|
|
591
813
|
DESCRIPTION
|
|
592
814
|
Creates new Joomla! installation.
|
|
@@ -663,17 +885,17 @@ USAGE
|
|
|
663
885
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
664
886
|
|
|
665
887
|
FLAGS
|
|
666
|
-
-p, --project-id=<value>
|
|
667
|
-
|
|
668
|
-
-q, --quiet
|
|
669
|
-
-w, --wait
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
888
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
889
|
+
context
|
|
890
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
891
|
+
-w, --wait Wait for your Matomo to be ready.
|
|
892
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
893
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
894
|
+
--admin-user=<value> Username for your administrator-user.
|
|
895
|
+
--host=<value> Host to initially configure your Matomo installation with; needs to be created separately.
|
|
674
896
|
--json
|
|
675
|
-
|
|
676
|
-
|
|
897
|
+
--site-title=<value> Site Title for your Matomo installation.
|
|
898
|
+
--version=<value> (required) [default: latest] Version of Matomo to be installed.
|
|
677
899
|
|
|
678
900
|
DESCRIPTION
|
|
679
901
|
Creates new Matomo installation.
|
|
@@ -728,6 +950,83 @@ FLAG DESCRIPTIONS
|
|
|
728
950
|
If none is given the Matomo will be installed in the latest available version.
|
|
729
951
|
```
|
|
730
952
|
|
|
953
|
+
## `mw app install nextcloud`
|
|
954
|
+
|
|
955
|
+
Creates new Shopware 6 installation.
|
|
956
|
+
|
|
957
|
+
```
|
|
958
|
+
USAGE
|
|
959
|
+
$ mw app install nextcloud --version <value> [-p <value>] [-q] [--host <value>] [--admin-user <value>] [--admin-email
|
|
960
|
+
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
961
|
+
|
|
962
|
+
FLAGS
|
|
963
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
964
|
+
context
|
|
965
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
966
|
+
-w, --wait Wait for your Shopware 6 to be ready.
|
|
967
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
968
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
969
|
+
--admin-user=<value> Username for your administrator-user.
|
|
970
|
+
--host=<value> Host to initially configure your Shopware 6 installation with; needs to be created
|
|
971
|
+
separately.
|
|
972
|
+
--json
|
|
973
|
+
--site-title=<value> Site Title for your Shopware 6 installation.
|
|
974
|
+
--version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
|
|
975
|
+
|
|
976
|
+
DESCRIPTION
|
|
977
|
+
Creates new Shopware 6 installation.
|
|
978
|
+
|
|
979
|
+
FLAG DESCRIPTIONS
|
|
980
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
981
|
+
|
|
982
|
+
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
|
|
983
|
+
to persistently set a default project for all commands that accept this flag.
|
|
984
|
+
|
|
985
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
986
|
+
|
|
987
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
988
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
989
|
+
|
|
990
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
991
|
+
|
|
992
|
+
E-Mail-Address that will correlate to the first administrator-user which will be created during the Shopware 6
|
|
993
|
+
installation.
|
|
994
|
+
If not given your mStudio Account-E-Mail-Address will be used. This E-Mail-Address can be changed after the
|
|
995
|
+
installation is finished.
|
|
996
|
+
|
|
997
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
998
|
+
|
|
999
|
+
Password that will correlate to the first administrator-user which will be created during the Shopware 6
|
|
1000
|
+
installation.
|
|
1001
|
+
If not given a random secure Password will be generated and sent to stdout. This Password can be changed after the
|
|
1002
|
+
installation is finished
|
|
1003
|
+
|
|
1004
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1005
|
+
|
|
1006
|
+
Username of the first administrator-user which will be created during the Shopware 6 installation.
|
|
1007
|
+
If not given an adequate username will be created from your mStudio Account Data.
|
|
1008
|
+
After the installation is finished the Username can be changed and additional administrator-users can be created.
|
|
1009
|
+
|
|
1010
|
+
--host=<value> Host to initially configure your Shopware 6 installation with; needs to be created separately.
|
|
1011
|
+
|
|
1012
|
+
Specify a host which will be used during the installation and as an initial host for the Shopware 6 configuration.
|
|
1013
|
+
If not given the default host for the given Project will be used.
|
|
1014
|
+
This does not change the target of the used Host and can be changed later by configuring the Host and your Shopware
|
|
1015
|
+
6 installation.
|
|
1016
|
+
|
|
1017
|
+
--site-title=<value> Site Title for your Shopware 6 installation.
|
|
1018
|
+
|
|
1019
|
+
Site Title which will be displayed in the Tab and at the top of the Frontend of your Shopware 6 installation.
|
|
1020
|
+
It is also the Title shown in the App-Overview in the mStudio.
|
|
1021
|
+
If none is given the Software Name and the given Project will be used. The Title can be changed after the
|
|
1022
|
+
installation is finished
|
|
1023
|
+
|
|
1024
|
+
--version=<value> Version of Shopware 6 to be installed.
|
|
1025
|
+
|
|
1026
|
+
Specify the Version in which your Shopware 6 will be installed.
|
|
1027
|
+
If none is given the Shopware 6 will be installed in the latest available version.
|
|
1028
|
+
```
|
|
1029
|
+
|
|
731
1030
|
## `mw app install shopware5`
|
|
732
1031
|
|
|
733
1032
|
Creates new Shopware 5 installation.
|
|
@@ -739,23 +1038,23 @@ USAGE
|
|
|
739
1038
|
[--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
|
|
740
1039
|
|
|
741
1040
|
FLAGS
|
|
742
|
-
-p, --project-id=<value>
|
|
743
|
-
|
|
744
|
-
-q, --quiet
|
|
745
|
-
-w, --wait
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
1041
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1042
|
+
context
|
|
1043
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1044
|
+
-w, --wait Wait for your Shopware 5 to be ready.
|
|
1045
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1046
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
1047
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
1048
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1049
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1050
|
+
--host=<value> Host to initially configure your Shopware 5 installation with; needs to be created
|
|
1051
|
+
separately.
|
|
753
1052
|
--json
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
1053
|
+
--shop-currency=<value> Currency your Shopware 5 will be working with.
|
|
1054
|
+
--shop-email=<value> E-Mail-Address your Shopware 5 will be working with.
|
|
1055
|
+
--shop-lang=<value> Language your Shopware 5 will be working with.
|
|
1056
|
+
--site-title=<value> Site Title for your Shopware 5 installation.
|
|
1057
|
+
--version=<value> (required) [default: latest] Version of Shopware 5 to be installed.
|
|
759
1058
|
|
|
760
1059
|
DESCRIPTION
|
|
761
1060
|
Creates new Shopware 5 installation.
|
|
@@ -853,23 +1152,23 @@ USAGE
|
|
|
853
1152
|
[--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
|
|
854
1153
|
|
|
855
1154
|
FLAGS
|
|
856
|
-
-p, --project-id=<value>
|
|
857
|
-
|
|
858
|
-
-q, --quiet
|
|
859
|
-
-w, --wait
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
1155
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1156
|
+
context
|
|
1157
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1158
|
+
-w, --wait Wait for your Shopware 6 to be ready.
|
|
1159
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1160
|
+
--admin-firstname=<value> Firstname of your administrator-user.
|
|
1161
|
+
--admin-lastname=<value> Lastname of your administrator-user.
|
|
1162
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1163
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1164
|
+
--host=<value> Host to initially configure your Shopware 6 installation with; needs to be created
|
|
1165
|
+
separately.
|
|
867
1166
|
--json
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
1167
|
+
--shop-currency=<value> Currency your Shopware 6 will be working with.
|
|
1168
|
+
--shop-email=<value> E-Mail-Address your Shopware 6 will be working with.
|
|
1169
|
+
--shop-lang=<value> Language your Shopware 6 will be working with.
|
|
1170
|
+
--site-title=<value> Site Title for your Shopware 6 installation.
|
|
1171
|
+
--version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
|
|
873
1172
|
|
|
874
1173
|
DESCRIPTION
|
|
875
1174
|
Creates new Shopware 6 installation.
|
|
@@ -966,19 +1265,20 @@ USAGE
|
|
|
966
1265
|
[--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
967
1266
|
|
|
968
1267
|
FLAGS
|
|
969
|
-
-p, --project-id=<value>
|
|
970
|
-
|
|
971
|
-
-q, --quiet
|
|
972
|
-
-w, --wait
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
1268
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1269
|
+
context
|
|
1270
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1271
|
+
-w, --wait Wait for your TYPO3 to be ready.
|
|
1272
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1273
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1274
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1275
|
+
--host=<value> Host to initially configure your TYPO3 installation with; needs to be created separately.
|
|
1276
|
+
--install-mode=<option> (required) [default: composer] The installation variant your TYPO3 will be installed
|
|
1277
|
+
with.
|
|
1278
|
+
<options: composer|symlink>
|
|
979
1279
|
--json
|
|
980
|
-
|
|
981
|
-
|
|
1280
|
+
--site-title=<value> Site Title for your TYPO3 installation.
|
|
1281
|
+
--version=<value> (required) [default: latest] Version of TYPO3 to be installed.
|
|
982
1282
|
|
|
983
1283
|
DESCRIPTION
|
|
984
1284
|
Creates new TYPO3 installation.
|
|
@@ -1051,18 +1351,18 @@ USAGE
|
|
|
1051
1351
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
1052
1352
|
|
|
1053
1353
|
FLAGS
|
|
1054
|
-
-p, --project-id=<value>
|
|
1055
|
-
|
|
1056
|
-
-q, --quiet
|
|
1057
|
-
-w, --wait
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1354
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1355
|
+
context
|
|
1356
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1357
|
+
-w, --wait Wait for your WordPress to be ready.
|
|
1358
|
+
--admin-email=<value> E-Mail-Address of your administrator-user.
|
|
1359
|
+
--admin-pass=<value> Password of your administrator-user.
|
|
1360
|
+
--admin-user=<value> Username for your administrator-user.
|
|
1361
|
+
--host=<value> Host to initially configure your WordPress installation with; needs to be created
|
|
1362
|
+
separately.
|
|
1063
1363
|
--json
|
|
1064
|
-
|
|
1065
|
-
|
|
1364
|
+
--site-title=<value> Site Title for your WordPress installation.
|
|
1365
|
+
--version=<value> (required) [default: latest] Version of WordPress to be installed.
|
|
1066
1366
|
|
|
1067
1367
|
DESCRIPTION
|
|
1068
1368
|
Creates new WordPress installation.
|
|
@@ -1124,21 +1424,19 @@ List installed apps in a project.
|
|
|
1124
1424
|
|
|
1125
1425
|
```
|
|
1126
1426
|
USAGE
|
|
1127
|
-
$ mw app list [--columns <value> | -x] [--
|
|
1128
|
-
|
|
1427
|
+
$ mw app list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1428
|
+
<value>]
|
|
1129
1429
|
|
|
1130
1430
|
FLAGS
|
|
1431
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1432
|
+
<options: json|yaml|csv>
|
|
1131
1433
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1132
1434
|
context
|
|
1133
1435
|
-x, --extended show extra columns
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
--no-truncate do not truncate output to fit screen
|
|
1139
|
-
--output=<option> output in a more machine friendly format
|
|
1140
|
-
<options: csv|json|yaml>
|
|
1141
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1436
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1437
|
+
--csv output is csv format [alias: --output=csv]
|
|
1438
|
+
--no-header hide table header from output
|
|
1439
|
+
--no-truncate do not truncate output to fit screen
|
|
1142
1440
|
|
|
1143
1441
|
DESCRIPTION
|
|
1144
1442
|
List installed apps in a project.
|
|
@@ -1150,34 +1448,37 @@ FLAG DESCRIPTIONS
|
|
|
1150
1448
|
to persistently set a default project for all commands that accept this flag.
|
|
1151
1449
|
```
|
|
1152
1450
|
|
|
1153
|
-
## `mw app ssh INSTALLATION-ID`
|
|
1451
|
+
## `mw app ssh [INSTALLATION-ID]`
|
|
1154
1452
|
|
|
1155
1453
|
Connect to an app via SSH
|
|
1156
1454
|
|
|
1157
1455
|
```
|
|
1158
1456
|
USAGE
|
|
1159
|
-
$ mw app ssh INSTALLATION-ID [--cd]
|
|
1457
|
+
$ mw app ssh [INSTALLATION-ID] [--cd] [--info]
|
|
1160
1458
|
|
|
1161
1459
|
ARGUMENTS
|
|
1162
|
-
INSTALLATION-ID ID of
|
|
1460
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
1461
|
+
in the context
|
|
1163
1462
|
|
|
1164
1463
|
FLAGS
|
|
1165
1464
|
--[no-]cd change to installation path after connecting
|
|
1465
|
+
--info only print connection information, without actually connecting
|
|
1166
1466
|
|
|
1167
1467
|
DESCRIPTION
|
|
1168
1468
|
Connect to an app via SSH
|
|
1169
1469
|
```
|
|
1170
1470
|
|
|
1171
|
-
## `mw app uninstall INSTALLATION-ID`
|
|
1471
|
+
## `mw app uninstall [INSTALLATION-ID]`
|
|
1172
1472
|
|
|
1173
1473
|
Uninstall an app
|
|
1174
1474
|
|
|
1175
1475
|
```
|
|
1176
1476
|
USAGE
|
|
1177
|
-
$ mw app uninstall INSTALLATION-ID [-q] [-f]
|
|
1477
|
+
$ mw app uninstall [INSTALLATION-ID] [-q] [-f]
|
|
1178
1478
|
|
|
1179
1479
|
ARGUMENTS
|
|
1180
|
-
INSTALLATION-ID ID of
|
|
1480
|
+
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
|
|
1481
|
+
in the context
|
|
1181
1482
|
|
|
1182
1483
|
FLAGS
|
|
1183
1484
|
-f, --force Do not ask for confirmation
|
|
@@ -1208,6 +1509,37 @@ DESCRIPTION
|
|
|
1208
1509
|
List supported Apps and Versions
|
|
1209
1510
|
```
|
|
1210
1511
|
|
|
1512
|
+
## `mw autocomplete [SHELL]`
|
|
1513
|
+
|
|
1514
|
+
Display autocomplete installation instructions.
|
|
1515
|
+
|
|
1516
|
+
```
|
|
1517
|
+
USAGE
|
|
1518
|
+
$ mw autocomplete [SHELL] [-r]
|
|
1519
|
+
|
|
1520
|
+
ARGUMENTS
|
|
1521
|
+
SHELL (zsh|bash|powershell) Shell type
|
|
1522
|
+
|
|
1523
|
+
FLAGS
|
|
1524
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
1525
|
+
|
|
1526
|
+
DESCRIPTION
|
|
1527
|
+
Display autocomplete installation instructions.
|
|
1528
|
+
|
|
1529
|
+
EXAMPLES
|
|
1530
|
+
$ mw autocomplete
|
|
1531
|
+
|
|
1532
|
+
$ mw autocomplete bash
|
|
1533
|
+
|
|
1534
|
+
$ mw autocomplete zsh
|
|
1535
|
+
|
|
1536
|
+
$ mw autocomplete powershell
|
|
1537
|
+
|
|
1538
|
+
$ mw autocomplete --refresh-cache
|
|
1539
|
+
```
|
|
1540
|
+
|
|
1541
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.3/src/commands/autocomplete/index.ts)_
|
|
1542
|
+
|
|
1211
1543
|
## `mw backup create`
|
|
1212
1544
|
|
|
1213
1545
|
Create a new backup of a project
|
|
@@ -1217,13 +1549,13 @@ USAGE
|
|
|
1217
1549
|
$ mw backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
|
|
1218
1550
|
|
|
1219
1551
|
FLAGS
|
|
1220
|
-
-p, --project-id=<value>
|
|
1221
|
-
|
|
1222
|
-
-q, --quiet
|
|
1223
|
-
-w, --wait
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1552
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1553
|
+
context
|
|
1554
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1555
|
+
-w, --wait Wait for the resource to be ready.
|
|
1556
|
+
--description=<value> a description for the backup.
|
|
1557
|
+
--expires=<value> (required) An interval after which the backup expires (examples: 30m, 30d, 1y).
|
|
1558
|
+
--wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
|
|
1227
1559
|
|
|
1228
1560
|
ALIASES
|
|
1229
1561
|
$ mw project backup create
|
|
@@ -1281,14 +1613,14 @@ ARGUMENTS
|
|
|
1281
1613
|
BACKUP-ID the ID of the Backup to download.
|
|
1282
1614
|
|
|
1283
1615
|
FLAGS
|
|
1284
|
-
-q, --quiet
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1616
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1617
|
+
--format=<option> [default: tar] the file format to download the backup in.
|
|
1618
|
+
<options: tar|zip>
|
|
1619
|
+
--generate-password generate a random password to encrypt the backup with.
|
|
1620
|
+
--output=<value> the file to write the backup to; if omitted, the filename will be determined by the server.
|
|
1621
|
+
--password=<value> the password to encrypt the backup with.
|
|
1622
|
+
--prompt-password prompt for a password to encrypt the backup with.
|
|
1623
|
+
--resume resume a previously interrupted download.
|
|
1292
1624
|
|
|
1293
1625
|
DESCRIPTION
|
|
1294
1626
|
Download a backup to your local disk
|
|
@@ -1344,21 +1676,19 @@ List Backups for a given Project.
|
|
|
1344
1676
|
|
|
1345
1677
|
```
|
|
1346
1678
|
USAGE
|
|
1347
|
-
$ mw backup list [--columns <value> | -x] [--
|
|
1348
|
-
|
|
1679
|
+
$ mw backup list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1680
|
+
<value>]
|
|
1349
1681
|
|
|
1350
1682
|
FLAGS
|
|
1683
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1684
|
+
<options: json|yaml|csv>
|
|
1351
1685
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1352
1686
|
context
|
|
1353
1687
|
-x, --extended show extra columns
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
--no-truncate do not truncate output to fit screen
|
|
1359
|
-
--output=<option> output in a more machine friendly format
|
|
1360
|
-
<options: csv|json|yaml>
|
|
1361
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1688
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1689
|
+
--csv output is csv format [alias: --output=csv]
|
|
1690
|
+
--no-header hide table header from output
|
|
1691
|
+
--no-truncate do not truncate output to fit screen
|
|
1362
1692
|
|
|
1363
1693
|
DESCRIPTION
|
|
1364
1694
|
List Backups for a given Project.
|
|
@@ -1379,21 +1709,19 @@ List backup schedules belonging to a given project.
|
|
|
1379
1709
|
|
|
1380
1710
|
```
|
|
1381
1711
|
USAGE
|
|
1382
|
-
$ mw backup schedule list [--columns <value> | -x] [--
|
|
1383
|
-
|
|
1712
|
+
$ mw backup schedule list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1713
|
+
<value>]
|
|
1384
1714
|
|
|
1385
1715
|
FLAGS
|
|
1716
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1717
|
+
<options: json|yaml|csv>
|
|
1386
1718
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1387
1719
|
context
|
|
1388
1720
|
-x, --extended show extra columns
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
--no-truncate do not truncate output to fit screen
|
|
1394
|
-
--output=<option> output in a more machine friendly format
|
|
1395
|
-
<options: csv|json|yaml>
|
|
1396
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1721
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1722
|
+
--csv output is csv format [alias: --output=csv]
|
|
1723
|
+
--no-header hide table header from output
|
|
1724
|
+
--no-truncate do not truncate output to fit screen
|
|
1397
1725
|
|
|
1398
1726
|
DESCRIPTION
|
|
1399
1727
|
List backup schedules belonging to a given project.
|
|
@@ -1454,19 +1782,16 @@ Get all conversation categories.
|
|
|
1454
1782
|
|
|
1455
1783
|
```
|
|
1456
1784
|
USAGE
|
|
1457
|
-
$ mw conversation categories [--columns <value> | -x] [--
|
|
1458
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
1785
|
+
$ mw conversation categories [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1459
1786
|
|
|
1460
1787
|
FLAGS
|
|
1461
|
-
-
|
|
1462
|
-
|
|
1463
|
-
--
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
<options: csv|json|yaml>
|
|
1469
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1788
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1789
|
+
<options: json|yaml|csv>
|
|
1790
|
+
-x, --extended show extra columns
|
|
1791
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1792
|
+
--csv output is csv format [alias: --output=csv]
|
|
1793
|
+
--no-header hide table header from output
|
|
1794
|
+
--no-truncate do not truncate output to fit screen
|
|
1470
1795
|
|
|
1471
1796
|
DESCRIPTION
|
|
1472
1797
|
Get all conversation categories.
|
|
@@ -1517,19 +1842,16 @@ Get all conversations the authenticated user has created or has access to.
|
|
|
1517
1842
|
|
|
1518
1843
|
```
|
|
1519
1844
|
USAGE
|
|
1520
|
-
$ mw conversation list [--columns <value> | -x] [--
|
|
1521
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
1845
|
+
$ mw conversation list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1522
1846
|
|
|
1523
1847
|
FLAGS
|
|
1524
|
-
-
|
|
1525
|
-
|
|
1526
|
-
--
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
<options: csv|json|yaml>
|
|
1532
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
1848
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1849
|
+
<options: json|yaml|csv>
|
|
1850
|
+
-x, --extended show extra columns
|
|
1851
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
1852
|
+
--csv output is csv format [alias: --output=csv]
|
|
1853
|
+
--no-header hide table header from output
|
|
1854
|
+
--no-truncate do not truncate output to fit screen
|
|
1533
1855
|
|
|
1534
1856
|
DESCRIPTION
|
|
1535
1857
|
Get all conversations the authenticated user has created or has access to.
|
|
@@ -1586,6 +1908,107 @@ FLAGS
|
|
|
1586
1908
|
--wait
|
|
1587
1909
|
```
|
|
1588
1910
|
|
|
1911
|
+
## `mw cronjob create`
|
|
1912
|
+
|
|
1913
|
+
Create a new cron job
|
|
1914
|
+
|
|
1915
|
+
```
|
|
1916
|
+
USAGE
|
|
1917
|
+
$ mw cronjob create --description <value> --interval <value> [-i <value>] [-q] [--disable] [--email <value>]
|
|
1918
|
+
[--url <value> | --command <value>] [--interpreter <value>]
|
|
1919
|
+
|
|
1920
|
+
FLAGS
|
|
1921
|
+
-i, --installation-id=<value> ID or short ID of an app installation; this flag is optional if a default app
|
|
1922
|
+
installation is set in the context
|
|
1923
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1924
|
+
--command=<value> Command to execute for the cron job; either this or `--url` is required.
|
|
1925
|
+
--description=<value> (required) Description of the cron job
|
|
1926
|
+
--disable Disable the cron job after creation
|
|
1927
|
+
--email=<value> Email address to send cron job output to
|
|
1928
|
+
--interpreter=<value> [default: /bin/sh] Interpreter to use for the cron job
|
|
1929
|
+
--interval=<value> (required) Interval of the cron job, in standard UNIX cron syntax
|
|
1930
|
+
--url=<value> URL to call for the cron job; either this or `--command` is required.
|
|
1931
|
+
|
|
1932
|
+
FLAG DESCRIPTIONS
|
|
1933
|
+
-i, --installation-id=<value>
|
|
1934
|
+
|
|
1935
|
+
ID or short ID of an app installation; this flag is optional if a default app installation is set in the context
|
|
1936
|
+
|
|
1937
|
+
May contain a short ID or a full ID of an app installation; you can also use the "mw context set
|
|
1938
|
+
--installation-id=<VALUE>" command to persistently set a default app installation for all commands that accept this
|
|
1939
|
+
flag.
|
|
1940
|
+
|
|
1941
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1942
|
+
|
|
1943
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
1944
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
1945
|
+
```
|
|
1946
|
+
|
|
1947
|
+
## `mw cronjob delete CRONJOB-ID`
|
|
1948
|
+
|
|
1949
|
+
Delete a cron job
|
|
1950
|
+
|
|
1951
|
+
```
|
|
1952
|
+
USAGE
|
|
1953
|
+
$ mw cronjob delete CRONJOB-ID [-q] [-f]
|
|
1954
|
+
|
|
1955
|
+
ARGUMENTS
|
|
1956
|
+
CRONJOB-ID ID of the cronjob to be deleted.
|
|
1957
|
+
|
|
1958
|
+
FLAGS
|
|
1959
|
+
-f, --force Do not ask for confirmation
|
|
1960
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1961
|
+
|
|
1962
|
+
DESCRIPTION
|
|
1963
|
+
Delete a cron job
|
|
1964
|
+
|
|
1965
|
+
FLAG DESCRIPTIONS
|
|
1966
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1967
|
+
|
|
1968
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
1969
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
1970
|
+
```
|
|
1971
|
+
|
|
1972
|
+
## `mw cronjob execute CRONJOB-ID`
|
|
1973
|
+
|
|
1974
|
+
Manually run a cron job
|
|
1975
|
+
|
|
1976
|
+
```
|
|
1977
|
+
USAGE
|
|
1978
|
+
$ mw cronjob execute CRONJOB-ID [-q]
|
|
1979
|
+
|
|
1980
|
+
FLAGS
|
|
1981
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1982
|
+
|
|
1983
|
+
FLAG DESCRIPTIONS
|
|
1984
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
1985
|
+
|
|
1986
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
1987
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
1988
|
+
```
|
|
1989
|
+
|
|
1990
|
+
## `mw cronjob execution abort CRONJOB-ID EXECUTION-ID`
|
|
1991
|
+
|
|
1992
|
+
Abort a running cron job execution.
|
|
1993
|
+
|
|
1994
|
+
```
|
|
1995
|
+
USAGE
|
|
1996
|
+
$ mw cronjob execution abort CRONJOB-ID EXECUTION-ID [-q]
|
|
1997
|
+
|
|
1998
|
+
ARGUMENTS
|
|
1999
|
+
CRONJOB-ID ID of the cronjob the execution belongs to
|
|
2000
|
+
EXECUTION-ID ID of the cron job execution to abort
|
|
2001
|
+
|
|
2002
|
+
FLAGS
|
|
2003
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2004
|
+
|
|
2005
|
+
FLAG DESCRIPTIONS
|
|
2006
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2007
|
+
|
|
2008
|
+
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2009
|
+
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2010
|
+
```
|
|
2011
|
+
|
|
1589
2012
|
## `mw cronjob execution get CRONJOB-ID EXECUTION-ID`
|
|
1590
2013
|
|
|
1591
2014
|
Get a cron job execution.
|
|
@@ -1615,20 +2038,18 @@ List CronjobExecutions belonging to a Cronjob.
|
|
|
1615
2038
|
|
|
1616
2039
|
```
|
|
1617
2040
|
USAGE
|
|
1618
|
-
$ mw cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--
|
|
1619
|
-
|
|
2041
|
+
$ mw cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
2042
|
+
json|yaml|csv | | ]
|
|
1620
2043
|
|
|
1621
2044
|
FLAGS
|
|
1622
|
-
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
<options: csv|json|yaml>
|
|
1631
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2045
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2046
|
+
<options: json|yaml|csv>
|
|
2047
|
+
-x, --extended show extra columns
|
|
2048
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2049
|
+
--cronjob-id=<value> (required) ID of the cron job for which to list executions for.
|
|
2050
|
+
--csv output is csv format [alias: --output=csv]
|
|
2051
|
+
--no-header hide table header from output
|
|
2052
|
+
--no-truncate do not truncate output to fit screen
|
|
1632
2053
|
|
|
1633
2054
|
DESCRIPTION
|
|
1634
2055
|
List CronjobExecutions belonging to a Cronjob.
|
|
@@ -1652,7 +2073,7 @@ ARGUMENTS
|
|
|
1652
2073
|
FLAGS
|
|
1653
2074
|
-o, --output=<option> output in a more machine friendly format
|
|
1654
2075
|
<options: json|yaml>
|
|
1655
|
-
|
|
2076
|
+
--no-pager Disable pager for output.
|
|
1656
2077
|
|
|
1657
2078
|
DESCRIPTION
|
|
1658
2079
|
Get the log output of a cronjob execution.
|
|
@@ -1665,52 +2086,47 @@ ALIASES
|
|
|
1665
2086
|
$ mw project cronjob execution logs
|
|
1666
2087
|
```
|
|
1667
2088
|
|
|
1668
|
-
## `mw cronjob get
|
|
2089
|
+
## `mw cronjob get CRONJOB-ID`
|
|
1669
2090
|
|
|
1670
|
-
Get a
|
|
2091
|
+
Get details of a cron job
|
|
1671
2092
|
|
|
1672
2093
|
```
|
|
1673
2094
|
USAGE
|
|
1674
|
-
$ mw cronjob get
|
|
2095
|
+
$ mw cronjob get CRONJOB-ID [-o json|yaml | | ]
|
|
1675
2096
|
|
|
1676
2097
|
ARGUMENTS
|
|
1677
|
-
|
|
2098
|
+
CRONJOB-ID ID of the cron job to be retrieved.
|
|
1678
2099
|
|
|
1679
2100
|
FLAGS
|
|
1680
2101
|
-o, --output=<option> output in a more machine friendly format
|
|
1681
2102
|
<options: json|yaml>
|
|
1682
2103
|
|
|
1683
2104
|
DESCRIPTION
|
|
1684
|
-
Get a
|
|
1685
|
-
|
|
1686
|
-
ALIASES
|
|
1687
|
-
$ mw project cronjob get
|
|
2105
|
+
Get details of a cron job
|
|
1688
2106
|
```
|
|
1689
2107
|
|
|
1690
2108
|
## `mw cronjob list`
|
|
1691
2109
|
|
|
1692
|
-
List
|
|
2110
|
+
List cron jobs belonging to a project.
|
|
1693
2111
|
|
|
1694
2112
|
```
|
|
1695
2113
|
USAGE
|
|
1696
|
-
$ mw cronjob list [--columns <value> | -x] [--
|
|
1697
|
-
|
|
2114
|
+
$ mw cronjob list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2115
|
+
<value>]
|
|
1698
2116
|
|
|
1699
2117
|
FLAGS
|
|
2118
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2119
|
+
<options: json|yaml|csv>
|
|
1700
2120
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1701
2121
|
context
|
|
1702
2122
|
-x, --extended show extra columns
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
--no-truncate do not truncate output to fit screen
|
|
1708
|
-
--output=<option> output in a more machine friendly format
|
|
1709
|
-
<options: csv|json|yaml>
|
|
1710
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2123
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2124
|
+
--csv output is csv format [alias: --output=csv]
|
|
2125
|
+
--no-header hide table header from output
|
|
2126
|
+
--no-truncate do not truncate output to fit screen
|
|
1711
2127
|
|
|
1712
2128
|
DESCRIPTION
|
|
1713
|
-
List
|
|
2129
|
+
List cron jobs belonging to a project.
|
|
1714
2130
|
|
|
1715
2131
|
ALIASES
|
|
1716
2132
|
$ mw project cronjob list
|
|
@@ -1728,19 +2144,16 @@ List available MySQL character sets and collations, optionally filtered by a MyS
|
|
|
1728
2144
|
|
|
1729
2145
|
```
|
|
1730
2146
|
USAGE
|
|
1731
|
-
$ mw database mysql charsets [--columns <value> | -x] [--
|
|
1732
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
2147
|
+
$ mw database mysql charsets [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1733
2148
|
|
|
1734
2149
|
FLAGS
|
|
1735
|
-
-
|
|
1736
|
-
|
|
1737
|
-
--
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
<options: csv|json|yaml>
|
|
1743
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2150
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2151
|
+
<options: json|yaml|csv>
|
|
2152
|
+
-x, --extended show extra columns
|
|
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
|
|
1744
2157
|
|
|
1745
2158
|
DESCRIPTION
|
|
1746
2159
|
List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
|
|
@@ -1756,17 +2169,17 @@ USAGE
|
|
|
1756
2169
|
[--user-password <value>] [--user-external] [--user-access-level full|readonly]
|
|
1757
2170
|
|
|
1758
2171
|
FLAGS
|
|
1759
|
-
-d, --description=<value>
|
|
1760
|
-
-p, --project-id=<value>
|
|
1761
|
-
|
|
1762
|
-
-q, --quiet
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
2172
|
+
-d, --description=<value> (required) a description for the database
|
|
2173
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in
|
|
2174
|
+
the context
|
|
2175
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2176
|
+
--character-set=<value> [default: utf8mb4] the character set to use
|
|
2177
|
+
--collation=<value> [default: utf8mb4_unicode_ci] the collation to use
|
|
2178
|
+
--user-access-level=<option> [default: full] the access level preset for the default user
|
|
2179
|
+
<options: full|readonly>
|
|
2180
|
+
--user-external enable external access for default user
|
|
2181
|
+
--user-password=<value> the password to use for the default user (env: MYSQL_PWD)
|
|
2182
|
+
--version=<value> (required) the MySQL version to use
|
|
1770
2183
|
|
|
1771
2184
|
FLAG DESCRIPTIONS
|
|
1772
2185
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
@@ -1871,21 +2284,19 @@ List MySQLDatabases belonging to a Project.
|
|
|
1871
2284
|
|
|
1872
2285
|
```
|
|
1873
2286
|
USAGE
|
|
1874
|
-
$ mw database mysql list [--columns <value> | -x] [--
|
|
1875
|
-
|
|
2287
|
+
$ mw database mysql list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2288
|
+
<value>]
|
|
1876
2289
|
|
|
1877
2290
|
FLAGS
|
|
2291
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2292
|
+
<options: json|yaml|csv>
|
|
1878
2293
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1879
2294
|
context
|
|
1880
2295
|
-x, --extended show extra columns
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
--no-truncate do not truncate output to fit screen
|
|
1886
|
-
--output=<option> output in a more machine friendly format
|
|
1887
|
-
<options: csv|json|yaml>
|
|
1888
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2296
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2297
|
+
--csv output is csv format [alias: --output=csv]
|
|
2298
|
+
--no-header hide table header from output
|
|
2299
|
+
--no-truncate do not truncate output to fit screen
|
|
1889
2300
|
|
|
1890
2301
|
DESCRIPTION
|
|
1891
2302
|
List MySQLDatabases belonging to a Project.
|
|
@@ -1921,8 +2332,8 @@ ARGUMENTS
|
|
|
1921
2332
|
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
|
|
1922
2333
|
|
|
1923
2334
|
FLAGS
|
|
1924
|
-
-q, --quiet
|
|
1925
|
-
|
|
2335
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2336
|
+
--port=<value> [default: 3306] The local TCP port to forward to
|
|
1926
2337
|
|
|
1927
2338
|
FLAG DESCRIPTIONS
|
|
1928
2339
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
@@ -1986,20 +2397,18 @@ List MySQL users belonging to a database.
|
|
|
1986
2397
|
|
|
1987
2398
|
```
|
|
1988
2399
|
USAGE
|
|
1989
|
-
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--
|
|
1990
|
-
|
|
2400
|
+
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
2401
|
+
json|yaml|csv | | ]
|
|
1991
2402
|
|
|
1992
2403
|
FLAGS
|
|
1993
|
-
-
|
|
1994
|
-
|
|
1995
|
-
--
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
<options: csv|json|yaml>
|
|
2002
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2404
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2405
|
+
<options: json|yaml|csv>
|
|
2406
|
+
-x, --extended show extra columns
|
|
2407
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2408
|
+
--csv output is csv format [alias: --output=csv]
|
|
2409
|
+
--database-id=<value> (required) ID of the MySQL database to list users for.
|
|
2410
|
+
--no-header hide table header from output
|
|
2411
|
+
--no-truncate do not truncate output to fit screen
|
|
2003
2412
|
|
|
2004
2413
|
DESCRIPTION
|
|
2005
2414
|
List MySQL users belonging to a database.
|
|
@@ -2011,19 +2420,16 @@ List available MySQL versions.
|
|
|
2011
2420
|
|
|
2012
2421
|
```
|
|
2013
2422
|
USAGE
|
|
2014
|
-
$ mw database mysql versions [--columns <value> | -x] [--
|
|
2015
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
2423
|
+
$ mw database mysql versions [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2016
2424
|
|
|
2017
2425
|
FLAGS
|
|
2018
|
-
-
|
|
2019
|
-
|
|
2020
|
-
--
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
<options: csv|json|yaml>
|
|
2026
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2426
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2427
|
+
<options: json|yaml|csv>
|
|
2428
|
+
-x, --extended show extra columns
|
|
2429
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2430
|
+
--csv output is csv format [alias: --output=csv]
|
|
2431
|
+
--no-header hide table header from output
|
|
2432
|
+
--no-truncate do not truncate output to fit screen
|
|
2027
2433
|
|
|
2028
2434
|
DESCRIPTION
|
|
2029
2435
|
List available MySQL versions.
|
|
@@ -2040,16 +2446,16 @@ USAGE
|
|
|
2040
2446
|
noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-random|volatile-random|volatile-ttl]
|
|
2041
2447
|
|
|
2042
2448
|
FLAGS
|
|
2043
|
-
-d, --description=<value>
|
|
2044
|
-
-p, --project-id=<value>
|
|
2045
|
-
|
|
2046
|
-
-q, --quiet
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2449
|
+
-d, --description=<value> (required) a description for the database
|
|
2450
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in
|
|
2451
|
+
the context
|
|
2452
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2453
|
+
--max-memory=<value> the maximum memory for the Redis database
|
|
2454
|
+
--max-memory-policy=<option> the Redis eviction policy
|
|
2455
|
+
<options: noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-rando
|
|
2456
|
+
m|volatile-random|volatile-ttl>
|
|
2457
|
+
--[no-]persistent enable persistent storage for the Redis database
|
|
2458
|
+
--version=<value> (required) the Redis version to use
|
|
2053
2459
|
|
|
2054
2460
|
FLAG DESCRIPTIONS
|
|
2055
2461
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
@@ -2103,21 +2509,19 @@ List Redis databases belonging to a project.
|
|
|
2103
2509
|
|
|
2104
2510
|
```
|
|
2105
2511
|
USAGE
|
|
2106
|
-
$ mw database redis list [--columns <value> | -x] [--
|
|
2107
|
-
|
|
2512
|
+
$ mw database redis list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2513
|
+
<value>]
|
|
2108
2514
|
|
|
2109
2515
|
FLAGS
|
|
2516
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2517
|
+
<options: json|yaml|csv>
|
|
2110
2518
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2111
2519
|
context
|
|
2112
2520
|
-x, --extended show extra columns
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
--no-truncate do not truncate output to fit screen
|
|
2118
|
-
--output=<option> output in a more machine friendly format
|
|
2119
|
-
<options: csv|json|yaml>
|
|
2120
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2521
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2522
|
+
--csv output is csv format [alias: --output=csv]
|
|
2523
|
+
--no-header hide table header from output
|
|
2524
|
+
--no-truncate do not truncate output to fit screen
|
|
2121
2525
|
|
|
2122
2526
|
DESCRIPTION
|
|
2123
2527
|
List Redis databases belonging to a project.
|
|
@@ -2156,21 +2560,19 @@ List available Redis versions.
|
|
|
2156
2560
|
|
|
2157
2561
|
```
|
|
2158
2562
|
USAGE
|
|
2159
|
-
$ mw database redis versions [--columns <value> | -x] [--
|
|
2160
|
-
|
|
2563
|
+
$ mw database redis versions [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2564
|
+
<value>]
|
|
2161
2565
|
|
|
2162
2566
|
FLAGS
|
|
2567
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2568
|
+
<options: json|yaml|csv>
|
|
2163
2569
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2164
2570
|
context
|
|
2165
2571
|
-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)
|
|
2572
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2573
|
+
--csv output is csv format [alias: --output=csv]
|
|
2574
|
+
--no-header hide table header from output
|
|
2575
|
+
--no-truncate do not truncate output to fit screen
|
|
2174
2576
|
|
|
2175
2577
|
DESCRIPTION
|
|
2176
2578
|
List available Redis versions.
|
|
@@ -2250,21 +2652,19 @@ List Domains belonging to a Project.
|
|
|
2250
2652
|
|
|
2251
2653
|
```
|
|
2252
2654
|
USAGE
|
|
2253
|
-
$ mw domain list [--columns <value> | -x] [--
|
|
2254
|
-
|
|
2655
|
+
$ mw domain list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2656
|
+
<value>]
|
|
2255
2657
|
|
|
2256
2658
|
FLAGS
|
|
2659
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2660
|
+
<options: json|yaml|csv>
|
|
2257
2661
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2258
2662
|
context
|
|
2259
2663
|
-x, --extended show extra columns
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
--no-truncate do not truncate output to fit screen
|
|
2265
|
-
--output=<option> output in a more machine friendly format
|
|
2266
|
-
<options: csv|json|yaml>
|
|
2267
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2664
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2665
|
+
--csv output is csv format [alias: --output=csv]
|
|
2666
|
+
--no-header hide table header from output
|
|
2667
|
+
--no-truncate do not truncate output to fit screen
|
|
2268
2668
|
|
|
2269
2669
|
DESCRIPTION
|
|
2270
2670
|
List Domains belonging to a Project.
|
|
@@ -2301,21 +2701,19 @@ List all domain ownerships of a project.
|
|
|
2301
2701
|
|
|
2302
2702
|
```
|
|
2303
2703
|
USAGE
|
|
2304
|
-
$ mw domain ownership list [--columns <value> | -x] [--
|
|
2305
|
-
|
|
2704
|
+
$ mw domain ownership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2705
|
+
<value>]
|
|
2306
2706
|
|
|
2307
2707
|
FLAGS
|
|
2708
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2709
|
+
<options: json|yaml|csv>
|
|
2308
2710
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2309
2711
|
context
|
|
2310
2712
|
-x, --extended show extra columns
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
--no-truncate do not truncate output to fit screen
|
|
2316
|
-
--output=<option> output in a more machine friendly format
|
|
2317
|
-
<options: csv|json|yaml>
|
|
2318
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2713
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2714
|
+
--csv output is csv format [alias: --output=csv]
|
|
2715
|
+
--no-header hide table header from output
|
|
2716
|
+
--no-truncate do not truncate output to fit screen
|
|
2319
2717
|
|
|
2320
2718
|
DESCRIPTION
|
|
2321
2719
|
List all domain ownerships of a project.
|
|
@@ -2337,13 +2735,13 @@ USAGE
|
|
|
2337
2735
|
[--path-to-url <value>]
|
|
2338
2736
|
|
|
2339
2737
|
FLAGS
|
|
2340
|
-
-p, --project-id=<value>
|
|
2341
|
-
|
|
2342
|
-
-q, --quiet
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2738
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2739
|
+
context
|
|
2740
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2741
|
+
--hostname=<value> (required) the hostname of the ingress
|
|
2742
|
+
--path-to-app=<value>... add a path mapping to an app
|
|
2743
|
+
--path-to-dir=<value>... add a path mapping to a directory
|
|
2744
|
+
--path-to-url=<value>... add a path mapping to an external url
|
|
2347
2745
|
|
|
2348
2746
|
DESCRIPTION
|
|
2349
2747
|
Create a new ingress
|
|
@@ -2439,22 +2837,20 @@ List virtualhosts for a project.
|
|
|
2439
2837
|
|
|
2440
2838
|
```
|
|
2441
2839
|
USAGE
|
|
2442
|
-
$ mw domain virtualhost list [--columns <value> | -x] [--
|
|
2443
|
-
|
|
2840
|
+
$ mw domain virtualhost list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2841
|
+
<value>] [-a]
|
|
2444
2842
|
|
|
2445
2843
|
FLAGS
|
|
2446
2844
|
-a, --all List all virtual hosts that you have access to, regardless of project
|
|
2845
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2846
|
+
<options: json|yaml|csv>
|
|
2447
2847
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2448
2848
|
context
|
|
2449
2849
|
-x, --extended show extra columns
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
--no-truncate do not truncate output to fit screen
|
|
2455
|
-
--output=<option> output in a more machine friendly format
|
|
2456
|
-
<options: csv|json|yaml>
|
|
2457
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2850
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2851
|
+
--csv output is csv format [alias: --output=csv]
|
|
2852
|
+
--no-header hide table header from output
|
|
2853
|
+
--no-truncate do not truncate output to fit screen
|
|
2458
2854
|
|
|
2459
2855
|
DESCRIPTION
|
|
2460
2856
|
List virtualhosts for a project.
|
|
@@ -2484,7 +2880,7 @@ DESCRIPTION
|
|
|
2484
2880
|
Display help for mw.
|
|
2485
2881
|
```
|
|
2486
2882
|
|
|
2487
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.
|
|
2883
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.9/src/commands/help.ts)_
|
|
2488
2884
|
|
|
2489
2885
|
## `mw login reset`
|
|
2490
2886
|
|
|
@@ -2532,22 +2928,33 @@ Create a new mail address
|
|
|
2532
2928
|
```
|
|
2533
2929
|
USAGE
|
|
2534
2930
|
$ mw mail address create -a <value> [-p <value>] [-q] [--catch-all] [--enable-spam-protection] [--quota <value>]
|
|
2535
|
-
[--password <value>] [--random-password]
|
|
2931
|
+
[--password <value>] [--random-password] [--forward-to <value>]
|
|
2536
2932
|
|
|
2537
2933
|
FLAGS
|
|
2538
|
-
-a, --address=<value>
|
|
2539
|
-
-p, --project-id=<value>
|
|
2540
|
-
|
|
2541
|
-
-q, --quiet
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2934
|
+
-a, --address=<value> (required) mail address
|
|
2935
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in
|
|
2936
|
+
the context
|
|
2937
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
2938
|
+
--catch-all make this a catch-all mail address
|
|
2939
|
+
--[no-]enable-spam-protection enable spam protection for this mailbox
|
|
2940
|
+
--forward-to=<value>... forward mail to another address
|
|
2941
|
+
--password=<value> mailbox password
|
|
2942
|
+
--quota=<value> [default: 1024] mailbox quota in mebibytes
|
|
2943
|
+
--random-password generate a random password
|
|
2547
2944
|
|
|
2548
2945
|
DESCRIPTION
|
|
2549
2946
|
Create a new mail address
|
|
2550
2947
|
|
|
2948
|
+
This command can be used to create a new mail address in a project.
|
|
2949
|
+
|
|
2950
|
+
A mail address is either associated with a mailbox, or forwards to another address.
|
|
2951
|
+
|
|
2952
|
+
To create a forwarding address, use the --forward-to flag. This flag can be used multiple times to forward to multiple
|
|
2953
|
+
addresses.
|
|
2954
|
+
|
|
2955
|
+
When no --forward-to flag is given, the command will create a mailbox for the address. In this case, the --catch-all
|
|
2956
|
+
flag can be used to make the mailbox a catch-all mailbox.
|
|
2957
|
+
|
|
2551
2958
|
When running this command with the --quiet flag, the output will contain the ID of the newly created address.
|
|
2552
2959
|
In addition, when run with --generated-password the output will be the ID of the newly created address, followed by a
|
|
2553
2960
|
tab character and the generated password.
|
|
@@ -2562,6 +2969,10 @@ EXAMPLES
|
|
|
2562
2969
|
|
|
2563
2970
|
$ mw mail address create --random-password --address foo@bar.example
|
|
2564
2971
|
|
|
2972
|
+
Create a forwarding address
|
|
2973
|
+
|
|
2974
|
+
$ mw mail address create --address foo@bar.example --forward-to bar@bar.example --forward-to baz@bar.example
|
|
2975
|
+
|
|
2565
2976
|
FLAG DESCRIPTIONS
|
|
2566
2977
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
|
|
2567
2978
|
|
|
@@ -2573,6 +2984,12 @@ FLAG DESCRIPTIONS
|
|
|
2573
2984
|
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2574
2985
|
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2575
2986
|
|
|
2987
|
+
--forward-to=<value>... forward mail to another address
|
|
2988
|
+
|
|
2989
|
+
This flag will cause the mailbox to forward all incoming mail to the given address.
|
|
2990
|
+
|
|
2991
|
+
Note: This flag is exclusive with --catch-all, --enable-spam-protection, --quota, --password and --random-password.
|
|
2992
|
+
|
|
2576
2993
|
--password=<value> mailbox password
|
|
2577
2994
|
|
|
2578
2995
|
This is the password that should be used for the mailbox; if omitted, the command will prompt interactively for a
|
|
@@ -2636,21 +3053,19 @@ Get all mail addresses for a project ID
|
|
|
2636
3053
|
|
|
2637
3054
|
```
|
|
2638
3055
|
USAGE
|
|
2639
|
-
$ mw mail address list [--columns <value> | -x] [--
|
|
2640
|
-
|
|
3056
|
+
$ mw mail address list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3057
|
+
<value>]
|
|
2641
3058
|
|
|
2642
3059
|
FLAGS
|
|
3060
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3061
|
+
<options: json|yaml|csv>
|
|
2643
3062
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2644
3063
|
context
|
|
2645
3064
|
-x, --extended show extra columns
|
|
2646
|
-
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
--no-truncate do not truncate output to fit screen
|
|
2651
|
-
--output=<option> output in a more machine friendly format
|
|
2652
|
-
<options: csv|json|yaml>
|
|
2653
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3065
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3066
|
+
--csv output is csv format [alias: --output=csv]
|
|
3067
|
+
--no-header hide table header from output
|
|
3068
|
+
--no-truncate do not truncate output to fit screen
|
|
2654
3069
|
|
|
2655
3070
|
DESCRIPTION
|
|
2656
3071
|
Get all mail addresses for a project ID
|
|
@@ -2687,21 +3102,19 @@ Get all deliveryboxes by project ID
|
|
|
2687
3102
|
|
|
2688
3103
|
```
|
|
2689
3104
|
USAGE
|
|
2690
|
-
$ mw mail deliverybox list [--columns <value> | -x] [--
|
|
2691
|
-
|
|
3105
|
+
$ mw mail deliverybox list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3106
|
+
<value>]
|
|
2692
3107
|
|
|
2693
3108
|
FLAGS
|
|
3109
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3110
|
+
<options: json|yaml|csv>
|
|
2694
3111
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2695
3112
|
context
|
|
2696
3113
|
-x, --extended show extra columns
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
--no-truncate do not truncate output to fit screen
|
|
2702
|
-
--output=<option> output in a more machine friendly format
|
|
2703
|
-
<options: csv|json|yaml>
|
|
2704
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3114
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3115
|
+
--csv output is csv format [alias: --output=csv]
|
|
3116
|
+
--no-header hide table header from output
|
|
3117
|
+
--no-truncate do not truncate output to fit screen
|
|
2705
3118
|
|
|
2706
3119
|
DESCRIPTION
|
|
2707
3120
|
Get all deliveryboxes by project ID
|
|
@@ -2722,7 +3135,7 @@ USAGE
|
|
|
2722
3135
|
$ mw org delete [ORG-ID] [-q] [-f]
|
|
2723
3136
|
|
|
2724
3137
|
ARGUMENTS
|
|
2725
|
-
ORG-ID ID or short ID of
|
|
3138
|
+
ORG-ID ID or short ID of an org; this argument is optional if a default org is set in the context
|
|
2726
3139
|
|
|
2727
3140
|
FLAGS
|
|
2728
3141
|
-f, --force Do not ask for confirmation
|
|
@@ -2747,7 +3160,7 @@ USAGE
|
|
|
2747
3160
|
$ mw org get [ORG-ID] [-o json|yaml | | ]
|
|
2748
3161
|
|
|
2749
3162
|
ARGUMENTS
|
|
2750
|
-
ORG-ID ID or short ID of
|
|
3163
|
+
ORG-ID ID or short ID of an org; this argument is optional if a default org is set in the context
|
|
2751
3164
|
|
|
2752
3165
|
FLAGS
|
|
2753
3166
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -2767,21 +3180,21 @@ USAGE
|
|
|
2767
3180
|
[--expires <value>]
|
|
2768
3181
|
|
|
2769
3182
|
FLAGS
|
|
2770
|
-
-o, --org-id=<value>
|
|
2771
|
-
-q, --quiet
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2776
|
-
|
|
3183
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3184
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3185
|
+
--email=<value> (required) The email address of the user to invite.
|
|
3186
|
+
--expires=<value> An interval after which the invitation expires (examples: 30m, 30d, 1y).
|
|
3187
|
+
--message=<value> A message to include in the invitation email.
|
|
3188
|
+
--role=<option> [default: member] The role of the user to invite.
|
|
3189
|
+
<options: owner|member|accountant>
|
|
2777
3190
|
|
|
2778
3191
|
DESCRIPTION
|
|
2779
3192
|
Invite a user to an organization.
|
|
2780
3193
|
|
|
2781
3194
|
FLAG DESCRIPTIONS
|
|
2782
|
-
-o, --org-id=<value> ID or short ID of
|
|
3195
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
2783
3196
|
|
|
2784
|
-
May contain a short ID or a full ID of
|
|
3197
|
+
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
|
|
2785
3198
|
persistently set a default org for all commands that accept this flag.
|
|
2786
3199
|
|
|
2787
3200
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
@@ -2796,28 +3209,26 @@ List all invites for an organization.
|
|
|
2796
3209
|
|
|
2797
3210
|
```
|
|
2798
3211
|
USAGE
|
|
2799
|
-
$ mw org invite list [--columns <value> | -x] [--
|
|
2800
|
-
|
|
3212
|
+
$ mw org invite list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-o
|
|
3213
|
+
<value>]
|
|
2801
3214
|
|
|
2802
3215
|
FLAGS
|
|
2803
|
-
-o, --org-id=<value>
|
|
2804
|
-
-
|
|
2805
|
-
|
|
2806
|
-
--
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
<options: csv|json|yaml>
|
|
2812
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3216
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3217
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3218
|
+
<options: json|yaml|csv>
|
|
3219
|
+
-x, --extended show extra columns
|
|
3220
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3221
|
+
--csv output is csv format [alias: --output=csv]
|
|
3222
|
+
--no-header hide table header from output
|
|
3223
|
+
--no-truncate do not truncate output to fit screen
|
|
2813
3224
|
|
|
2814
3225
|
DESCRIPTION
|
|
2815
3226
|
List all invites for an organization.
|
|
2816
3227
|
|
|
2817
3228
|
FLAG DESCRIPTIONS
|
|
2818
|
-
-o, --org-id=<value> ID or short ID of
|
|
3229
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
2819
3230
|
|
|
2820
|
-
May contain a short ID or a full ID of
|
|
3231
|
+
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
|
|
2821
3232
|
persistently set a default org for all commands that accept this flag.
|
|
2822
3233
|
```
|
|
2823
3234
|
|
|
@@ -2827,19 +3238,16 @@ List all organization invites for the executing user.
|
|
|
2827
3238
|
|
|
2828
3239
|
```
|
|
2829
3240
|
USAGE
|
|
2830
|
-
$ mw org invite list-own [--columns <value> | -x] [--
|
|
2831
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3241
|
+
$ mw org invite list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2832
3242
|
|
|
2833
3243
|
FLAGS
|
|
2834
|
-
-
|
|
2835
|
-
|
|
2836
|
-
--
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
<options: csv|json|yaml>
|
|
2842
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3244
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3245
|
+
<options: json|yaml|csv>
|
|
3246
|
+
-x, --extended show extra columns
|
|
3247
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3248
|
+
--csv output is csv format [alias: --output=csv]
|
|
3249
|
+
--no-header hide table header from output
|
|
3250
|
+
--no-truncate do not truncate output to fit screen
|
|
2843
3251
|
|
|
2844
3252
|
DESCRIPTION
|
|
2845
3253
|
List all organization invites for the executing user.
|
|
@@ -2875,19 +3283,16 @@ Get all organizations the authenticated user has access to.
|
|
|
2875
3283
|
|
|
2876
3284
|
```
|
|
2877
3285
|
USAGE
|
|
2878
|
-
$ mw org list [--columns <value> | -x] [--
|
|
2879
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3286
|
+
$ mw org list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2880
3287
|
|
|
2881
3288
|
FLAGS
|
|
2882
|
-
-
|
|
2883
|
-
|
|
2884
|
-
--
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
<options: csv|json|yaml>
|
|
2890
|
-
--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
|
|
2891
3296
|
|
|
2892
3297
|
DESCRIPTION
|
|
2893
3298
|
Get all organizations the authenticated user has access to.
|
|
@@ -2899,28 +3304,26 @@ List all memberships belonging to an organization.
|
|
|
2899
3304
|
|
|
2900
3305
|
```
|
|
2901
3306
|
USAGE
|
|
2902
|
-
$ mw org membership list [--columns <value> | -x] [--
|
|
2903
|
-
|
|
3307
|
+
$ mw org membership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-o
|
|
3308
|
+
<value>]
|
|
2904
3309
|
|
|
2905
3310
|
FLAGS
|
|
2906
|
-
-o, --org-id=<value>
|
|
2907
|
-
-
|
|
2908
|
-
|
|
2909
|
-
--
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
<options: csv|json|yaml>
|
|
2915
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3311
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
3312
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3313
|
+
<options: json|yaml|csv>
|
|
3314
|
+
-x, --extended show extra columns
|
|
3315
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3316
|
+
--csv output is csv format [alias: --output=csv]
|
|
3317
|
+
--no-header hide table header from output
|
|
3318
|
+
--no-truncate do not truncate output to fit screen
|
|
2916
3319
|
|
|
2917
3320
|
DESCRIPTION
|
|
2918
3321
|
List all memberships belonging to an organization.
|
|
2919
3322
|
|
|
2920
3323
|
FLAG DESCRIPTIONS
|
|
2921
|
-
-o, --org-id=<value> ID or short ID of
|
|
3324
|
+
-o, --org-id=<value> ID or short ID of an org; this flag is optional if a default org is set in the context
|
|
2922
3325
|
|
|
2923
|
-
May contain a short ID or a full ID of
|
|
3326
|
+
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
|
|
2924
3327
|
persistently set a default org for all commands that accept this flag.
|
|
2925
3328
|
```
|
|
2926
3329
|
|
|
@@ -2930,19 +3333,16 @@ List all organization memberships for the executing user.
|
|
|
2930
3333
|
|
|
2931
3334
|
```
|
|
2932
3335
|
USAGE
|
|
2933
|
-
$ mw org membership list-own [--columns <value> | -x] [--
|
|
2934
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3336
|
+
$ mw org membership list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2935
3337
|
|
|
2936
3338
|
FLAGS
|
|
2937
|
-
-
|
|
2938
|
-
|
|
2939
|
-
--
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
<options: csv|json|yaml>
|
|
2945
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3339
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3340
|
+
<options: json|yaml|csv>
|
|
3341
|
+
-x, --extended show extra columns
|
|
3342
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3343
|
+
--csv output is csv format [alias: --output=csv]
|
|
3344
|
+
--no-header hide table header from output
|
|
3345
|
+
--no-truncate do not truncate output to fit screen
|
|
2946
3346
|
|
|
2947
3347
|
DESCRIPTION
|
|
2948
3348
|
List all organization memberships for the executing user.
|
|
@@ -2981,13 +3381,13 @@ USAGE
|
|
|
2981
3381
|
$ mw project backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
|
|
2982
3382
|
|
|
2983
3383
|
FLAGS
|
|
2984
|
-
-p, --project-id=<value>
|
|
2985
|
-
|
|
2986
|
-
-q, --quiet
|
|
2987
|
-
-w, --wait
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
|
|
3384
|
+
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3385
|
+
context
|
|
3386
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3387
|
+
-w, --wait Wait for the resource to be ready.
|
|
3388
|
+
--description=<value> a description for the backup.
|
|
3389
|
+
--expires=<value> (required) An interval after which the backup expires (examples: 30m, 30d, 1y).
|
|
3390
|
+
--wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
|
|
2991
3391
|
|
|
2992
3392
|
ALIASES
|
|
2993
3393
|
$ mw project backup create
|
|
@@ -3045,14 +3445,14 @@ ARGUMENTS
|
|
|
3045
3445
|
BACKUP-ID the ID of the Backup to download.
|
|
3046
3446
|
|
|
3047
3447
|
FLAGS
|
|
3048
|
-
-q, --quiet
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3448
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3449
|
+
--format=<option> [default: tar] the file format to download the backup in.
|
|
3450
|
+
<options: tar|zip>
|
|
3451
|
+
--generate-password generate a random password to encrypt the backup with.
|
|
3452
|
+
--output=<value> the file to write the backup to; if omitted, the filename will be determined by the server.
|
|
3453
|
+
--password=<value> the password to encrypt the backup with.
|
|
3454
|
+
--prompt-password prompt for a password to encrypt the backup with.
|
|
3455
|
+
--resume resume a previously interrupted download.
|
|
3056
3456
|
|
|
3057
3457
|
DESCRIPTION
|
|
3058
3458
|
Download a backup to your local disk
|
|
@@ -3108,21 +3508,19 @@ List Backups for a given Project.
|
|
|
3108
3508
|
|
|
3109
3509
|
```
|
|
3110
3510
|
USAGE
|
|
3111
|
-
$ mw project backup list [--columns <value> | -x] [--
|
|
3112
|
-
|
|
3511
|
+
$ mw project backup list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3512
|
+
<value>]
|
|
3113
3513
|
|
|
3114
3514
|
FLAGS
|
|
3515
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3516
|
+
<options: json|yaml|csv>
|
|
3115
3517
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3116
3518
|
context
|
|
3117
3519
|
-x, --extended show extra columns
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
--no-truncate do not truncate output to fit screen
|
|
3123
|
-
--output=<option> output in a more machine friendly format
|
|
3124
|
-
<options: csv|json|yaml>
|
|
3125
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3520
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3521
|
+
--csv output is csv format [alias: --output=csv]
|
|
3522
|
+
--no-header hide table header from output
|
|
3523
|
+
--no-truncate do not truncate output to fit screen
|
|
3126
3524
|
|
|
3127
3525
|
DESCRIPTION
|
|
3128
3526
|
List Backups for a given Project.
|
|
@@ -3143,21 +3541,19 @@ List backup schedules belonging to a given project.
|
|
|
3143
3541
|
|
|
3144
3542
|
```
|
|
3145
3543
|
USAGE
|
|
3146
|
-
$ mw project backupschedule list [--columns <value> | -x] [--
|
|
3147
|
-
|
|
3544
|
+
$ mw project backupschedule list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3545
|
+
<value>]
|
|
3148
3546
|
|
|
3149
3547
|
FLAGS
|
|
3548
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3549
|
+
<options: json|yaml|csv>
|
|
3150
3550
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3151
3551
|
context
|
|
3152
3552
|
-x, --extended show extra columns
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
--no-truncate do not truncate output to fit screen
|
|
3158
|
-
--output=<option> output in a more machine friendly format
|
|
3159
|
-
<options: csv|json|yaml>
|
|
3160
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3553
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3554
|
+
--csv output is csv format [alias: --output=csv]
|
|
3555
|
+
--no-header hide table header from output
|
|
3556
|
+
--no-truncate do not truncate output to fit screen
|
|
3161
3557
|
|
|
3162
3558
|
DESCRIPTION
|
|
3163
3559
|
List backup schedules belonging to a given project.
|
|
@@ -3181,12 +3577,13 @@ USAGE
|
|
|
3181
3577
|
$ mw project create -d <value> [-s <value>] [-q] [-w] [--wait-timeout <value>] [--update-context]
|
|
3182
3578
|
|
|
3183
3579
|
FLAGS
|
|
3184
|
-
-d, --description=<value>
|
|
3185
|
-
-q, --quiet
|
|
3186
|
-
-s, --server-id=<value>
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3580
|
+
-d, --description=<value> (required) A description for the project.
|
|
3581
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
3582
|
+
-s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the
|
|
3583
|
+
context
|
|
3584
|
+
-w, --wait Wait for the resource to be ready.
|
|
3585
|
+
--update-context Update the CLI context to use the newly created project
|
|
3586
|
+
--wait-timeout=<value> [default: 600] The number of seconds to wait for the resource to be ready.
|
|
3190
3587
|
|
|
3191
3588
|
DESCRIPTION
|
|
3192
3589
|
Create a new project
|
|
@@ -3232,20 +3629,18 @@ List CronjobExecutions belonging to a Cronjob.
|
|
|
3232
3629
|
|
|
3233
3630
|
```
|
|
3234
3631
|
USAGE
|
|
3235
|
-
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--
|
|
3236
|
-
|
|
3632
|
+
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
3633
|
+
json|yaml|csv | | ]
|
|
3237
3634
|
|
|
3238
3635
|
FLAGS
|
|
3239
|
-
-
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
|
-
|
|
3244
|
-
|
|
3245
|
-
|
|
3246
|
-
|
|
3247
|
-
<options: csv|json|yaml>
|
|
3248
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3636
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3637
|
+
<options: json|yaml|csv>
|
|
3638
|
+
-x, --extended show extra columns
|
|
3639
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3640
|
+
--cronjob-id=<value> (required) ID of the cron job for which to list executions for.
|
|
3641
|
+
--csv output is csv format [alias: --output=csv]
|
|
3642
|
+
--no-header hide table header from output
|
|
3643
|
+
--no-truncate do not truncate output to fit screen
|
|
3249
3644
|
|
|
3250
3645
|
DESCRIPTION
|
|
3251
3646
|
List CronjobExecutions belonging to a Cronjob.
|
|
@@ -3269,7 +3664,7 @@ ARGUMENTS
|
|
|
3269
3664
|
FLAGS
|
|
3270
3665
|
-o, --output=<option> output in a more machine friendly format
|
|
3271
3666
|
<options: json|yaml>
|
|
3272
|
-
|
|
3667
|
+
--no-pager Disable pager for output.
|
|
3273
3668
|
|
|
3274
3669
|
DESCRIPTION
|
|
3275
3670
|
Get the log output of a cronjob execution.
|
|
@@ -3282,52 +3677,28 @@ ALIASES
|
|
|
3282
3677
|
$ mw project cronjob execution logs
|
|
3283
3678
|
```
|
|
3284
3679
|
|
|
3285
|
-
## `mw project cronjob get CRONJOBID`
|
|
3286
|
-
|
|
3287
|
-
Get a cronjob.
|
|
3288
|
-
|
|
3289
|
-
```
|
|
3290
|
-
USAGE
|
|
3291
|
-
$ mw project cronjob get CRONJOBID [-o json|yaml | | ]
|
|
3292
|
-
|
|
3293
|
-
ARGUMENTS
|
|
3294
|
-
CRONJOBID ID of the cronjob to be retrieved.
|
|
3295
|
-
|
|
3296
|
-
FLAGS
|
|
3297
|
-
-o, --output=<option> output in a more machine friendly format
|
|
3298
|
-
<options: json|yaml>
|
|
3299
|
-
|
|
3300
|
-
DESCRIPTION
|
|
3301
|
-
Get a cronjob.
|
|
3302
|
-
|
|
3303
|
-
ALIASES
|
|
3304
|
-
$ mw project cronjob get
|
|
3305
|
-
```
|
|
3306
|
-
|
|
3307
3680
|
## `mw project cronjob list`
|
|
3308
3681
|
|
|
3309
|
-
List
|
|
3682
|
+
List cron jobs belonging to a project.
|
|
3310
3683
|
|
|
3311
3684
|
```
|
|
3312
3685
|
USAGE
|
|
3313
|
-
$ mw project cronjob list [--columns <value> | -x] [--
|
|
3314
|
-
|
|
3686
|
+
$ mw project cronjob list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3687
|
+
<value>]
|
|
3315
3688
|
|
|
3316
3689
|
FLAGS
|
|
3690
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3691
|
+
<options: json|yaml|csv>
|
|
3317
3692
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3318
3693
|
context
|
|
3319
3694
|
-x, --extended show extra columns
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3324
|
-
--no-truncate do not truncate output to fit screen
|
|
3325
|
-
--output=<option> output in a more machine friendly format
|
|
3326
|
-
<options: csv|json|yaml>
|
|
3327
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3695
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3696
|
+
--csv output is csv format [alias: --output=csv]
|
|
3697
|
+
--no-header hide table header from output
|
|
3698
|
+
--no-truncate do not truncate output to fit screen
|
|
3328
3699
|
|
|
3329
3700
|
DESCRIPTION
|
|
3330
|
-
List
|
|
3701
|
+
List cron jobs belonging to a project.
|
|
3331
3702
|
|
|
3332
3703
|
ALIASES
|
|
3333
3704
|
$ mw project cronjob list
|
|
@@ -3366,7 +3737,7 @@ FLAG DESCRIPTIONS
|
|
|
3366
3737
|
|
|
3367
3738
|
## `mw project filesystem usage [PROJECT-ID]`
|
|
3368
3739
|
|
|
3369
|
-
Get a
|
|
3740
|
+
Get a project directory filesystem usage.
|
|
3370
3741
|
|
|
3371
3742
|
```
|
|
3372
3743
|
USAGE
|
|
@@ -3378,10 +3749,10 @@ ARGUMENTS
|
|
|
3378
3749
|
FLAGS
|
|
3379
3750
|
-o, --output=<option> output in a more machine friendly format
|
|
3380
3751
|
<options: json|yaml>
|
|
3381
|
-
|
|
3752
|
+
--human Display human readable sizes.
|
|
3382
3753
|
|
|
3383
3754
|
DESCRIPTION
|
|
3384
|
-
Get a
|
|
3755
|
+
Get a project directory filesystem usage.
|
|
3385
3756
|
```
|
|
3386
3757
|
|
|
3387
3758
|
## `mw project get [PROJECT-ID]`
|
|
@@ -3428,21 +3799,19 @@ List all invites belonging to a project.
|
|
|
3428
3799
|
|
|
3429
3800
|
```
|
|
3430
3801
|
USAGE
|
|
3431
|
-
$ mw project invite list [--columns <value> | -x] [--
|
|
3432
|
-
|
|
3802
|
+
$ mw project invite list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3803
|
+
<value>]
|
|
3433
3804
|
|
|
3434
3805
|
FLAGS
|
|
3806
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3807
|
+
<options: json|yaml|csv>
|
|
3435
3808
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3436
3809
|
context
|
|
3437
3810
|
-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)
|
|
3811
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3812
|
+
--csv output is csv format [alias: --output=csv]
|
|
3813
|
+
--no-header hide table header from output
|
|
3814
|
+
--no-truncate do not truncate output to fit screen
|
|
3446
3815
|
|
|
3447
3816
|
DESCRIPTION
|
|
3448
3817
|
List all invites belonging to a project.
|
|
@@ -3460,19 +3829,16 @@ List all project invites for the executing user.
|
|
|
3460
3829
|
|
|
3461
3830
|
```
|
|
3462
3831
|
USAGE
|
|
3463
|
-
$ mw project invite list-own [--columns <value> | -x] [--
|
|
3464
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3832
|
+
$ mw project invite list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3465
3833
|
|
|
3466
3834
|
FLAGS
|
|
3467
|
-
-
|
|
3468
|
-
|
|
3469
|
-
--
|
|
3470
|
-
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
<options: csv|json|yaml>
|
|
3475
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3835
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3836
|
+
<options: json|yaml|csv>
|
|
3837
|
+
-x, --extended show extra columns
|
|
3838
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3839
|
+
--csv output is csv format [alias: --output=csv]
|
|
3840
|
+
--no-header hide table header from output
|
|
3841
|
+
--no-truncate do not truncate output to fit screen
|
|
3476
3842
|
|
|
3477
3843
|
DESCRIPTION
|
|
3478
3844
|
List all project invites for the executing user.
|
|
@@ -3484,19 +3850,16 @@ List all projects that you have access to
|
|
|
3484
3850
|
|
|
3485
3851
|
```
|
|
3486
3852
|
USAGE
|
|
3487
|
-
$ mw project list [--columns <value> | -x] [--
|
|
3488
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3853
|
+
$ mw project list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3489
3854
|
|
|
3490
3855
|
FLAGS
|
|
3491
|
-
-
|
|
3492
|
-
|
|
3493
|
-
--
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
<options: csv|json|yaml>
|
|
3499
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3856
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3857
|
+
<options: json|yaml|csv>
|
|
3858
|
+
-x, --extended show extra columns
|
|
3859
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3860
|
+
--csv output is csv format [alias: --output=csv]
|
|
3861
|
+
--no-header hide table header from output
|
|
3862
|
+
--no-truncate do not truncate output to fit screen
|
|
3500
3863
|
|
|
3501
3864
|
DESCRIPTION
|
|
3502
3865
|
List all projects that you have access to
|
|
@@ -3551,21 +3914,19 @@ List all memberships for a Project.
|
|
|
3551
3914
|
|
|
3552
3915
|
```
|
|
3553
3916
|
USAGE
|
|
3554
|
-
$ mw project membership list [--columns <value> | -x] [--
|
|
3555
|
-
|
|
3917
|
+
$ mw project membership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3918
|
+
<value>]
|
|
3556
3919
|
|
|
3557
3920
|
FLAGS
|
|
3921
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3922
|
+
<options: json|yaml|csv>
|
|
3558
3923
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3559
3924
|
context
|
|
3560
3925
|
-x, --extended show extra columns
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
--no-truncate do not truncate output to fit screen
|
|
3566
|
-
--output=<option> output in a more machine friendly format
|
|
3567
|
-
<options: csv|json|yaml>
|
|
3568
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3926
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3927
|
+
--csv output is csv format [alias: --output=csv]
|
|
3928
|
+
--no-header hide table header from output
|
|
3929
|
+
--no-truncate do not truncate output to fit screen
|
|
3569
3930
|
|
|
3570
3931
|
DESCRIPTION
|
|
3571
3932
|
List all memberships for a Project.
|
|
@@ -3583,19 +3944,17 @@ List ProjectMemberships belonging to the executing user.
|
|
|
3583
3944
|
|
|
3584
3945
|
```
|
|
3585
3946
|
USAGE
|
|
3586
|
-
$ mw project membership list-own [--columns <value> | -x] [--
|
|
3587
|
-
|
|
3947
|
+
$ mw project membership list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv |
|
|
3948
|
+
| ]
|
|
3588
3949
|
|
|
3589
3950
|
FLAGS
|
|
3590
|
-
-
|
|
3591
|
-
|
|
3592
|
-
--
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
<options: csv|json|yaml>
|
|
3598
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3951
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3952
|
+
<options: json|yaml|csv>
|
|
3953
|
+
-x, --extended show extra columns
|
|
3954
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3955
|
+
--csv output is csv format [alias: --output=csv]
|
|
3956
|
+
--no-header hide table header from output
|
|
3957
|
+
--no-truncate do not truncate output to fit screen
|
|
3599
3958
|
|
|
3600
3959
|
DESCRIPTION
|
|
3601
3960
|
List ProjectMemberships belonging to the executing user.
|
|
@@ -3607,21 +3966,19 @@ List all SFTP users for a project.
|
|
|
3607
3966
|
|
|
3608
3967
|
```
|
|
3609
3968
|
USAGE
|
|
3610
|
-
$ mw project sftp-user list [--columns <value> | -x] [--
|
|
3611
|
-
|
|
3969
|
+
$ mw project sftp-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3970
|
+
<value>]
|
|
3612
3971
|
|
|
3613
3972
|
FLAGS
|
|
3973
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3974
|
+
<options: json|yaml|csv>
|
|
3614
3975
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3615
3976
|
context
|
|
3616
3977
|
-x, --extended show extra columns
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
--no-truncate do not truncate output to fit screen
|
|
3622
|
-
--output=<option> output in a more machine friendly format
|
|
3623
|
-
<options: csv|json|yaml>
|
|
3624
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
3978
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
3979
|
+
--csv output is csv format [alias: --output=csv]
|
|
3980
|
+
--no-header hide table header from output
|
|
3981
|
+
--no-truncate do not truncate output to fit screen
|
|
3625
3982
|
|
|
3626
3983
|
DESCRIPTION
|
|
3627
3984
|
List all SFTP users for a project.
|
|
@@ -3657,21 +4014,19 @@ List all SSH users for a project.
|
|
|
3657
4014
|
|
|
3658
4015
|
```
|
|
3659
4016
|
USAGE
|
|
3660
|
-
$ mw project ssh-user list [--columns <value> | -x] [--
|
|
3661
|
-
|
|
4017
|
+
$ mw project ssh-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4018
|
+
<value>]
|
|
3662
4019
|
|
|
3663
4020
|
FLAGS
|
|
4021
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4022
|
+
<options: json|yaml|csv>
|
|
3664
4023
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3665
4024
|
context
|
|
3666
4025
|
-x, --extended show extra columns
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
--no-truncate do not truncate output to fit screen
|
|
3672
|
-
--output=<option> output in a more machine friendly format
|
|
3673
|
-
<options: csv|json|yaml>
|
|
3674
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4026
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4027
|
+
--csv output is csv format [alias: --output=csv]
|
|
4028
|
+
--no-header hide table header from output
|
|
4029
|
+
--no-truncate do not truncate output to fit screen
|
|
3675
4030
|
|
|
3676
4031
|
DESCRIPTION
|
|
3677
4032
|
List all SSH users for a project.
|
|
@@ -3726,19 +4081,16 @@ List servers for an organization or user.
|
|
|
3726
4081
|
|
|
3727
4082
|
```
|
|
3728
4083
|
USAGE
|
|
3729
|
-
$ mw server list [--columns <value> | -x] [--
|
|
3730
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4084
|
+
$ mw server list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3731
4085
|
|
|
3732
4086
|
FLAGS
|
|
3733
|
-
-
|
|
3734
|
-
|
|
3735
|
-
--
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
<options: csv|json|yaml>
|
|
3741
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4087
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4088
|
+
<options: json|yaml|csv>
|
|
4089
|
+
-x, --extended show extra columns
|
|
4090
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4091
|
+
--csv output is csv format [alias: --output=csv]
|
|
4092
|
+
--no-header hide table header from output
|
|
4093
|
+
--no-truncate do not truncate output to fit screen
|
|
3742
4094
|
|
|
3743
4095
|
DESCRIPTION
|
|
3744
4096
|
List servers for an organization or user.
|
|
@@ -3750,21 +4102,19 @@ List all SFTP users for a project.
|
|
|
3750
4102
|
|
|
3751
4103
|
```
|
|
3752
4104
|
USAGE
|
|
3753
|
-
$ mw sftp-user list [--columns <value> | -x] [--
|
|
3754
|
-
|
|
4105
|
+
$ mw sftp-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4106
|
+
<value>]
|
|
3755
4107
|
|
|
3756
4108
|
FLAGS
|
|
4109
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4110
|
+
<options: json|yaml|csv>
|
|
3757
4111
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3758
4112
|
context
|
|
3759
4113
|
-x, --extended show extra columns
|
|
3760
|
-
|
|
3761
|
-
|
|
3762
|
-
|
|
3763
|
-
|
|
3764
|
-
--no-truncate do not truncate output to fit screen
|
|
3765
|
-
--output=<option> output in a more machine friendly format
|
|
3766
|
-
<options: csv|json|yaml>
|
|
3767
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4114
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4115
|
+
--csv output is csv format [alias: --output=csv]
|
|
4116
|
+
--no-header hide table header from output
|
|
4117
|
+
--no-truncate do not truncate output to fit screen
|
|
3768
4118
|
|
|
3769
4119
|
DESCRIPTION
|
|
3770
4120
|
List all SFTP users for a project.
|
|
@@ -3785,21 +4135,19 @@ List all SSH users for a project.
|
|
|
3785
4135
|
|
|
3786
4136
|
```
|
|
3787
4137
|
USAGE
|
|
3788
|
-
$ mw ssh-user list [--columns <value> | -x] [--
|
|
3789
|
-
|
|
4138
|
+
$ mw ssh-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4139
|
+
<value>]
|
|
3790
4140
|
|
|
3791
4141
|
FLAGS
|
|
4142
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4143
|
+
<options: json|yaml|csv>
|
|
3792
4144
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3793
4145
|
context
|
|
3794
4146
|
-x, --extended show extra columns
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
--no-truncate do not truncate output to fit screen
|
|
3800
|
-
--output=<option> output in a more machine friendly format
|
|
3801
|
-
<options: csv|json|yaml>
|
|
3802
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4147
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4148
|
+
--csv output is csv format [alias: --output=csv]
|
|
4149
|
+
--no-header hide table header from output
|
|
4150
|
+
--no-truncate do not truncate output to fit screen
|
|
3803
4151
|
|
|
3804
4152
|
DESCRIPTION
|
|
3805
4153
|
List all SSH users for a project.
|
|
@@ -3826,7 +4174,7 @@ FLAGS
|
|
|
3826
4174
|
-a, --available See available versions.
|
|
3827
4175
|
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
|
|
3828
4176
|
-v, --version=<value> Install a specific version.
|
|
3829
|
-
|
|
4177
|
+
--force Force a re-download of the requested version.
|
|
3830
4178
|
|
|
3831
4179
|
DESCRIPTION
|
|
3832
4180
|
update the mw CLI
|
|
@@ -3849,7 +4197,7 @@ EXAMPLES
|
|
|
3849
4197
|
$ mw update --available
|
|
3850
4198
|
```
|
|
3851
4199
|
|
|
3852
|
-
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.1.
|
|
4200
|
+
_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.1.7/src/commands/update.ts)_
|
|
3853
4201
|
|
|
3854
4202
|
## `mw user api-token create`
|
|
3855
4203
|
|
|
@@ -3860,11 +4208,11 @@ USAGE
|
|
|
3860
4208
|
$ mw user api-token create --description <value> --roles api_read|api_write [-q] [--expires-in <value>]
|
|
3861
4209
|
|
|
3862
4210
|
FLAGS
|
|
3863
|
-
-q, --quiet
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
|
|
4211
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
4212
|
+
--description=<value> (required) Description of the API token
|
|
4213
|
+
--expires-in=<value> Expiration interval of the API token (example: 30d)
|
|
4214
|
+
--roles=<option>... (required) Roles of the API token
|
|
4215
|
+
<options: api_read|api_write>
|
|
3868
4216
|
|
|
3869
4217
|
DESCRIPTION
|
|
3870
4218
|
Create a new API token
|
|
@@ -3901,19 +4249,16 @@ List all API tokens of the user
|
|
|
3901
4249
|
|
|
3902
4250
|
```
|
|
3903
4251
|
USAGE
|
|
3904
|
-
$ mw user api-token list [--columns <value> | -x] [--
|
|
3905
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4252
|
+
$ mw user api-token list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3906
4253
|
|
|
3907
4254
|
FLAGS
|
|
3908
|
-
-
|
|
3909
|
-
|
|
3910
|
-
--
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
|
|
3915
|
-
<options: csv|json|yaml>
|
|
3916
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4255
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4256
|
+
<options: json|yaml|csv>
|
|
4257
|
+
-x, --extended show extra columns
|
|
4258
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4259
|
+
--csv output is csv format [alias: --output=csv]
|
|
4260
|
+
--no-header hide table header from output
|
|
4261
|
+
--no-truncate do not truncate output to fit screen
|
|
3917
4262
|
|
|
3918
4263
|
DESCRIPTION
|
|
3919
4264
|
List all API tokens of the user
|
|
@@ -3989,19 +4334,16 @@ List all active sessions
|
|
|
3989
4334
|
|
|
3990
4335
|
```
|
|
3991
4336
|
USAGE
|
|
3992
|
-
$ mw user session list [--columns <value> | -x] [--
|
|
3993
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4337
|
+
$ mw user session list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3994
4338
|
|
|
3995
4339
|
FLAGS
|
|
3996
|
-
-
|
|
3997
|
-
|
|
3998
|
-
--
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
|
-
<options: csv|json|yaml>
|
|
4004
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4340
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4341
|
+
<options: json|yaml|csv>
|
|
4342
|
+
-x, --extended show extra columns
|
|
4343
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4344
|
+
--csv output is csv format [alias: --output=csv]
|
|
4345
|
+
--no-header hide table header from output
|
|
4346
|
+
--no-truncate do not truncate output to fit screen
|
|
4005
4347
|
|
|
4006
4348
|
DESCRIPTION
|
|
4007
4349
|
List all active sessions
|
|
@@ -4016,11 +4358,11 @@ USAGE
|
|
|
4016
4358
|
$ mw user ssh-key create [-q] [--output <value>] [--no-passphrase] [--comment <value>] [--expiresAt <value>]
|
|
4017
4359
|
|
|
4018
4360
|
FLAGS
|
|
4019
|
-
-q, --quiet
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4361
|
+
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
4362
|
+
--comment=<value> A comment for the SSH key.
|
|
4363
|
+
--expiresAt=<value> Duration after which the SSH key should expire (example: '1y').
|
|
4364
|
+
--no-passphrase Use this flag to not set a passphrase for the SSH key.
|
|
4365
|
+
--output=<value> [default: mstudio-cli] A filename in your ~/.ssh directory to write the SSH key to.
|
|
4024
4366
|
|
|
4025
4367
|
DESCRIPTION
|
|
4026
4368
|
Create and import a new SSH key
|
|
@@ -4082,19 +4424,16 @@ Get your stored ssh keys
|
|
|
4082
4424
|
|
|
4083
4425
|
```
|
|
4084
4426
|
USAGE
|
|
4085
|
-
$ mw user ssh-key list [--columns <value> | -x] [--
|
|
4086
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4427
|
+
$ mw user ssh-key list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4087
4428
|
|
|
4088
4429
|
FLAGS
|
|
4089
|
-
-
|
|
4090
|
-
|
|
4091
|
-
--
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
|
|
4095
|
-
|
|
4096
|
-
<options: csv|json|yaml>
|
|
4097
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4430
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4431
|
+
<options: json|yaml|csv>
|
|
4432
|
+
-x, --extended show extra columns
|
|
4433
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
4434
|
+
--csv output is csv format [alias: --output=csv]
|
|
4435
|
+
--no-header hide table header from output
|
|
4436
|
+
--no-truncate do not truncate output to fit screen
|
|
4098
4437
|
|
|
4099
4438
|
DESCRIPTION
|
|
4100
4439
|
Get your stored ssh keys
|