@mittwald/cli 1.0.0-alpha.27 → 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 +814 -760
- 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/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/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,15 +89,15 @@ 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)
|
|
85
95
|
* [`mw app create python`](#mw-app-create-python)
|
|
86
96
|
* [`mw app create static`](#mw-app-create-static)
|
|
87
97
|
* [`mw app dependency list`](#mw-app-dependency-list)
|
|
88
|
-
* [`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)
|
|
89
99
|
* [`mw app dependency versions SYSTEMSOFTWARE`](#mw-app-dependency-versions-systemsoftware)
|
|
90
|
-
* [`mw app get INSTALLATION-ID`](#mw-app-get-installation-id)
|
|
100
|
+
* [`mw app get [INSTALLATION-ID]`](#mw-app-get-installation-id)
|
|
91
101
|
* [`mw app install contao`](#mw-app-install-contao)
|
|
92
102
|
* [`mw app install drupal`](#mw-app-install-drupal)
|
|
93
103
|
* [`mw app install grav`](#mw-app-install-grav)
|
|
@@ -99,9 +109,10 @@ USAGE
|
|
|
99
109
|
* [`mw app install typo3`](#mw-app-install-typo3)
|
|
100
110
|
* [`mw app install wordpress`](#mw-app-install-wordpress)
|
|
101
111
|
* [`mw app list`](#mw-app-list)
|
|
102
|
-
* [`mw app ssh INSTALLATION-ID`](#mw-app-ssh-installation-id)
|
|
103
|
-
* [`mw app uninstall INSTALLATION-ID`](#mw-app-uninstall-installation-id)
|
|
112
|
+
* [`mw app ssh [INSTALLATION-ID]`](#mw-app-ssh-installation-id)
|
|
113
|
+
* [`mw app uninstall [INSTALLATION-ID]`](#mw-app-uninstall-installation-id)
|
|
104
114
|
* [`mw app versions [APP]`](#mw-app-versions-app)
|
|
115
|
+
* [`mw autocomplete [SHELL]`](#mw-autocomplete-shell)
|
|
105
116
|
* [`mw backup create`](#mw-backup-create)
|
|
106
117
|
* [`mw backup delete BACKUP-ID`](#mw-backup-delete-backup-id)
|
|
107
118
|
* [`mw backup download BACKUP-ID`](#mw-backup-download-backup-id)
|
|
@@ -117,10 +128,14 @@ USAGE
|
|
|
117
128
|
* [`mw conversation reply ID`](#mw-conversation-reply-id)
|
|
118
129
|
* [`mw conversation show ID`](#mw-conversation-show-id)
|
|
119
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)
|
|
120
135
|
* [`mw cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-get-cronjob-id-execution-id)
|
|
121
136
|
* [`mw cronjob execution list`](#mw-cronjob-execution-list)
|
|
122
137
|
* [`mw cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-cronjob-execution-logs-cronjob-id-execution-id)
|
|
123
|
-
* [`mw cronjob get
|
|
138
|
+
* [`mw cronjob get CRONJOB-ID`](#mw-cronjob-get-cronjob-id)
|
|
124
139
|
* [`mw cronjob list`](#mw-cronjob-list)
|
|
125
140
|
* [`mw database mysql charsets`](#mw-database-mysql-charsets)
|
|
126
141
|
* [`mw database mysql create`](#mw-database-mysql-create)
|
|
@@ -179,7 +194,6 @@ USAGE
|
|
|
179
194
|
* [`mw project cronjob execution get CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-get-cronjob-id-execution-id)
|
|
180
195
|
* [`mw project cronjob execution list`](#mw-project-cronjob-execution-list)
|
|
181
196
|
* [`mw project cronjob execution logs CRONJOB-ID EXECUTION-ID`](#mw-project-cronjob-execution-logs-cronjob-id-execution-id)
|
|
182
|
-
* [`mw project cronjob get CRONJOBID`](#mw-project-cronjob-get-cronjobid)
|
|
183
197
|
* [`mw project cronjob list`](#mw-project-cronjob-list)
|
|
184
198
|
* [`mw project delete [PROJECT-ID]`](#mw-project-delete-project-id)
|
|
185
199
|
* [`mw project filesystem usage [PROJECT-ID]`](#mw-project-filesystem-usage-project-id)
|
|
@@ -213,20 +227,21 @@ USAGE
|
|
|
213
227
|
* [`mw user ssh-key get KEY-ID`](#mw-user-ssh-key-get-key-id)
|
|
214
228
|
* [`mw user ssh-key list`](#mw-user-ssh-key-list)
|
|
215
229
|
|
|
216
|
-
## `mw app copy INSTALLATION-ID`
|
|
230
|
+
## `mw app copy [INSTALLATION-ID]`
|
|
217
231
|
|
|
218
232
|
Copy an app within a project
|
|
219
233
|
|
|
220
234
|
```
|
|
221
235
|
USAGE
|
|
222
|
-
$ mw app copy INSTALLATION-ID --description <value> [-q]
|
|
236
|
+
$ mw app copy [INSTALLATION-ID] --description <value> [-q]
|
|
223
237
|
|
|
224
238
|
ARGUMENTS
|
|
225
|
-
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
|
|
226
241
|
|
|
227
242
|
FLAGS
|
|
228
|
-
-q, --quiet
|
|
229
|
-
|
|
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
|
|
230
245
|
|
|
231
246
|
DESCRIPTION
|
|
232
247
|
Copy an app within a project
|
|
@@ -252,7 +267,7 @@ FLAGS
|
|
|
252
267
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
253
268
|
-w, --wait Wait for your custom Node.js to be ready.
|
|
254
269
|
--json
|
|
255
|
-
|
|
270
|
+
--site-title=<value> Site Title for your custom Node.js installation.
|
|
256
271
|
|
|
257
272
|
DESCRIPTION
|
|
258
273
|
Creates new custom Node.js installation.
|
|
@@ -285,14 +300,14 @@ USAGE
|
|
|
285
300
|
$ mw app create php --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
286
301
|
|
|
287
302
|
FLAGS
|
|
288
|
-
-p, --project-id=<value>
|
|
289
|
-
|
|
290
|
-
-q, --quiet
|
|
291
|
-
-w, --wait
|
|
292
|
-
|
|
293
|
-
|
|
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)
|
|
294
309
|
--json
|
|
295
|
-
|
|
310
|
+
--site-title=<value> Site Title for your custom PHP installation.
|
|
296
311
|
|
|
297
312
|
DESCRIPTION
|
|
298
313
|
Creates new custom PHP installation.
|
|
@@ -332,14 +347,14 @@ USAGE
|
|
|
332
347
|
$ mw app create python --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
333
348
|
|
|
334
349
|
FLAGS
|
|
335
|
-
-p, --project-id=<value>
|
|
336
|
-
|
|
337
|
-
-q, --quiet
|
|
338
|
-
-w, --wait
|
|
339
|
-
|
|
340
|
-
|
|
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)
|
|
341
356
|
--json
|
|
342
|
-
|
|
357
|
+
--site-title=<value> Site Title for your custom python site installation.
|
|
343
358
|
|
|
344
359
|
DESCRIPTION
|
|
345
360
|
Creates new custom python site installation.
|
|
@@ -380,14 +395,14 @@ USAGE
|
|
|
380
395
|
$ mw app create static --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
|
|
381
396
|
|
|
382
397
|
FLAGS
|
|
383
|
-
-p, --project-id=<value>
|
|
384
|
-
|
|
385
|
-
-q, --quiet
|
|
386
|
-
-w, --wait
|
|
387
|
-
|
|
388
|
-
|
|
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)
|
|
389
404
|
--json
|
|
390
|
-
|
|
405
|
+
--site-title=<value> Site Title for your custom static site installation.
|
|
391
406
|
|
|
392
407
|
DESCRIPTION
|
|
393
408
|
Creates new custom static site installation.
|
|
@@ -425,40 +440,38 @@ Get all available dependencies
|
|
|
425
440
|
|
|
426
441
|
```
|
|
427
442
|
USAGE
|
|
428
|
-
$ mw app dependency list [--columns <value> | -x] [--
|
|
429
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
443
|
+
$ mw app dependency list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
430
444
|
|
|
431
445
|
FLAGS
|
|
432
|
-
-
|
|
433
|
-
|
|
434
|
-
--
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
<options: csv|json|yaml>
|
|
440
|
-
--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
|
|
441
453
|
|
|
442
454
|
DESCRIPTION
|
|
443
455
|
Get all available dependencies
|
|
444
456
|
```
|
|
445
457
|
|
|
446
|
-
## `mw app dependency update INSTALLATION-ID`
|
|
458
|
+
## `mw app dependency update [INSTALLATION-ID]`
|
|
447
459
|
|
|
448
460
|
Update the dependencies of an app
|
|
449
461
|
|
|
450
462
|
```
|
|
451
463
|
USAGE
|
|
452
|
-
$ 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]
|
|
453
465
|
|
|
454
466
|
ARGUMENTS
|
|
455
|
-
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
|
|
456
469
|
|
|
457
470
|
FLAGS
|
|
458
|
-
-q, --quiet
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
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>
|
|
462
475
|
|
|
463
476
|
EXAMPLES
|
|
464
477
|
Update Node.js version to newest available from the 18.x branch
|
|
@@ -485,37 +498,36 @@ Get all available versions of a particular dependency
|
|
|
485
498
|
|
|
486
499
|
```
|
|
487
500
|
USAGE
|
|
488
|
-
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--
|
|
489
|
-
|
|
501
|
+
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
502
|
+
json|yaml|csv | | ]
|
|
490
503
|
|
|
491
504
|
ARGUMENTS
|
|
492
505
|
SYSTEMSOFTWARE name of the systemsoftware for which to list versions
|
|
493
506
|
|
|
494
507
|
FLAGS
|
|
495
|
-
-
|
|
496
|
-
|
|
497
|
-
--
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
<options: csv|json|yaml>
|
|
503
|
-
--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
|
|
504
515
|
|
|
505
516
|
DESCRIPTION
|
|
506
517
|
Get all available versions of a particular dependency
|
|
507
518
|
```
|
|
508
519
|
|
|
509
|
-
## `mw app get INSTALLATION-ID`
|
|
520
|
+
## `mw app get [INSTALLATION-ID]`
|
|
510
521
|
|
|
511
522
|
Get details about an app installation
|
|
512
523
|
|
|
513
524
|
```
|
|
514
525
|
USAGE
|
|
515
|
-
$ mw app get INSTALLATION-ID [-o json|yaml | | ]
|
|
526
|
+
$ mw app get [INSTALLATION-ID] [-o json|yaml | | ]
|
|
516
527
|
|
|
517
528
|
ARGUMENTS
|
|
518
|
-
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
|
|
519
531
|
|
|
520
532
|
FLAGS
|
|
521
533
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -536,19 +548,20 @@ USAGE
|
|
|
536
548
|
[--json]
|
|
537
549
|
|
|
538
550
|
FLAGS
|
|
539
|
-
-p, --project-id=<value>
|
|
540
|
-
|
|
541
|
-
-q, --quiet
|
|
542
|
-
-w, --wait
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
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.
|
|
549
562
|
--json
|
|
550
|
-
|
|
551
|
-
|
|
563
|
+
--site-title=<value> Site Title for your Contao installation.
|
|
564
|
+
--version=<value> (required) [default: latest] Version of Contao to be installed.
|
|
552
565
|
|
|
553
566
|
DESCRIPTION
|
|
554
567
|
Creates new Contao installation.
|
|
@@ -625,17 +638,17 @@ USAGE
|
|
|
625
638
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
626
639
|
|
|
627
640
|
FLAGS
|
|
628
|
-
-p, --project-id=<value>
|
|
629
|
-
|
|
630
|
-
-q, --quiet
|
|
631
|
-
-w, --wait
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
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.
|
|
636
649
|
--json
|
|
637
|
-
|
|
638
|
-
|
|
650
|
+
--site-title=<value> Site Title for your Drupal installation.
|
|
651
|
+
--version=<value> (required) [default: latest] Version of Drupal to be installed.
|
|
639
652
|
|
|
640
653
|
DESCRIPTION
|
|
641
654
|
Creates new Drupal installation.
|
|
@@ -700,18 +713,18 @@ USAGE
|
|
|
700
713
|
[--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title <value>] [-w] [--json]
|
|
701
714
|
|
|
702
715
|
FLAGS
|
|
703
|
-
-p, --project-id=<value>
|
|
704
|
-
|
|
705
|
-
-q, --quiet
|
|
706
|
-
-w, --wait
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
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.
|
|
712
725
|
--json
|
|
713
|
-
|
|
714
|
-
|
|
726
|
+
--site-title=<value> Site Title for your Grav installation.
|
|
727
|
+
--version=<value> (required) [default: latest] Version of Grav to be installed.
|
|
715
728
|
|
|
716
729
|
DESCRIPTION
|
|
717
730
|
Creates new Grav installation.
|
|
@@ -782,19 +795,20 @@ USAGE
|
|
|
782
795
|
[--json]
|
|
783
796
|
|
|
784
797
|
FLAGS
|
|
785
|
-
-p, --project-id=<value>
|
|
786
|
-
|
|
787
|
-
-q, --quiet
|
|
788
|
-
-w, --wait
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
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.
|
|
795
809
|
--json
|
|
796
|
-
|
|
797
|
-
|
|
810
|
+
--site-title=<value> Site Title for your Joomla! installation.
|
|
811
|
+
--version=<value> (required) [default: latest] Version of Joomla! to be installed.
|
|
798
812
|
|
|
799
813
|
DESCRIPTION
|
|
800
814
|
Creates new Joomla! installation.
|
|
@@ -871,17 +885,17 @@ USAGE
|
|
|
871
885
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
872
886
|
|
|
873
887
|
FLAGS
|
|
874
|
-
-p, --project-id=<value>
|
|
875
|
-
|
|
876
|
-
-q, --quiet
|
|
877
|
-
-w, --wait
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
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.
|
|
882
896
|
--json
|
|
883
|
-
|
|
884
|
-
|
|
897
|
+
--site-title=<value> Site Title for your Matomo installation.
|
|
898
|
+
--version=<value> (required) [default: latest] Version of Matomo to be installed.
|
|
885
899
|
|
|
886
900
|
DESCRIPTION
|
|
887
901
|
Creates new Matomo installation.
|
|
@@ -946,18 +960,18 @@ USAGE
|
|
|
946
960
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
947
961
|
|
|
948
962
|
FLAGS
|
|
949
|
-
-p, --project-id=<value>
|
|
950
|
-
|
|
951
|
-
-q, --quiet
|
|
952
|
-
-w, --wait
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
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.
|
|
958
972
|
--json
|
|
959
|
-
|
|
960
|
-
|
|
973
|
+
--site-title=<value> Site Title for your Shopware 6 installation.
|
|
974
|
+
--version=<value> (required) [default: latest] Version of Shopware 6 to be installed.
|
|
961
975
|
|
|
962
976
|
DESCRIPTION
|
|
963
977
|
Creates new Shopware 6 installation.
|
|
@@ -1024,23 +1038,23 @@ USAGE
|
|
|
1024
1038
|
[--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
|
|
1025
1039
|
|
|
1026
1040
|
FLAGS
|
|
1027
|
-
-p, --project-id=<value>
|
|
1028
|
-
|
|
1029
|
-
-q, --quiet
|
|
1030
|
-
-w, --wait
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
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.
|
|
1038
1052
|
--json
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
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.
|
|
1044
1058
|
|
|
1045
1059
|
DESCRIPTION
|
|
1046
1060
|
Creates new Shopware 5 installation.
|
|
@@ -1138,23 +1152,23 @@ USAGE
|
|
|
1138
1152
|
[--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--json]
|
|
1139
1153
|
|
|
1140
1154
|
FLAGS
|
|
1141
|
-
-p, --project-id=<value>
|
|
1142
|
-
|
|
1143
|
-
-q, --quiet
|
|
1144
|
-
-w, --wait
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
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.
|
|
1152
1166
|
--json
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
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.
|
|
1158
1172
|
|
|
1159
1173
|
DESCRIPTION
|
|
1160
1174
|
Creates new Shopware 6 installation.
|
|
@@ -1251,19 +1265,20 @@ USAGE
|
|
|
1251
1265
|
[--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
1252
1266
|
|
|
1253
1267
|
FLAGS
|
|
1254
|
-
-p, --project-id=<value>
|
|
1255
|
-
|
|
1256
|
-
-q, --quiet
|
|
1257
|
-
-w, --wait
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
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>
|
|
1264
1279
|
--json
|
|
1265
|
-
|
|
1266
|
-
|
|
1280
|
+
--site-title=<value> Site Title for your TYPO3 installation.
|
|
1281
|
+
--version=<value> (required) [default: latest] Version of TYPO3 to be installed.
|
|
1267
1282
|
|
|
1268
1283
|
DESCRIPTION
|
|
1269
1284
|
Creates new TYPO3 installation.
|
|
@@ -1336,18 +1351,18 @@ USAGE
|
|
|
1336
1351
|
<value>] [--admin-pass <value>] [--site-title <value>] [-w] [--json]
|
|
1337
1352
|
|
|
1338
1353
|
FLAGS
|
|
1339
|
-
-p, --project-id=<value>
|
|
1340
|
-
|
|
1341
|
-
-q, --quiet
|
|
1342
|
-
-w, --wait
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
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.
|
|
1348
1363
|
--json
|
|
1349
|
-
|
|
1350
|
-
|
|
1364
|
+
--site-title=<value> Site Title for your WordPress installation.
|
|
1365
|
+
--version=<value> (required) [default: latest] Version of WordPress to be installed.
|
|
1351
1366
|
|
|
1352
1367
|
DESCRIPTION
|
|
1353
1368
|
Creates new WordPress installation.
|
|
@@ -1409,21 +1424,19 @@ List installed apps in a project.
|
|
|
1409
1424
|
|
|
1410
1425
|
```
|
|
1411
1426
|
USAGE
|
|
1412
|
-
$ mw app list [--columns <value> | -x] [--
|
|
1413
|
-
|
|
1427
|
+
$ mw app list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1428
|
+
<value>]
|
|
1414
1429
|
|
|
1415
1430
|
FLAGS
|
|
1431
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1432
|
+
<options: json|yaml|csv>
|
|
1416
1433
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1417
1434
|
context
|
|
1418
1435
|
-x, --extended show extra columns
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
--no-truncate do not truncate output to fit screen
|
|
1424
|
-
--output=<option> output in a more machine friendly format
|
|
1425
|
-
<options: csv|json|yaml>
|
|
1426
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
1427
1440
|
|
|
1428
1441
|
DESCRIPTION
|
|
1429
1442
|
List installed apps in a project.
|
|
@@ -1435,34 +1448,37 @@ FLAG DESCRIPTIONS
|
|
|
1435
1448
|
to persistently set a default project for all commands that accept this flag.
|
|
1436
1449
|
```
|
|
1437
1450
|
|
|
1438
|
-
## `mw app ssh INSTALLATION-ID`
|
|
1451
|
+
## `mw app ssh [INSTALLATION-ID]`
|
|
1439
1452
|
|
|
1440
1453
|
Connect to an app via SSH
|
|
1441
1454
|
|
|
1442
1455
|
```
|
|
1443
1456
|
USAGE
|
|
1444
|
-
$ mw app ssh INSTALLATION-ID [--cd]
|
|
1457
|
+
$ mw app ssh [INSTALLATION-ID] [--cd] [--info]
|
|
1445
1458
|
|
|
1446
1459
|
ARGUMENTS
|
|
1447
|
-
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
|
|
1448
1462
|
|
|
1449
1463
|
FLAGS
|
|
1450
1464
|
--[no-]cd change to installation path after connecting
|
|
1465
|
+
--info only print connection information, without actually connecting
|
|
1451
1466
|
|
|
1452
1467
|
DESCRIPTION
|
|
1453
1468
|
Connect to an app via SSH
|
|
1454
1469
|
```
|
|
1455
1470
|
|
|
1456
|
-
## `mw app uninstall INSTALLATION-ID`
|
|
1471
|
+
## `mw app uninstall [INSTALLATION-ID]`
|
|
1457
1472
|
|
|
1458
1473
|
Uninstall an app
|
|
1459
1474
|
|
|
1460
1475
|
```
|
|
1461
1476
|
USAGE
|
|
1462
|
-
$ mw app uninstall INSTALLATION-ID [-q] [-f]
|
|
1477
|
+
$ mw app uninstall [INSTALLATION-ID] [-q] [-f]
|
|
1463
1478
|
|
|
1464
1479
|
ARGUMENTS
|
|
1465
|
-
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
|
|
1466
1482
|
|
|
1467
1483
|
FLAGS
|
|
1468
1484
|
-f, --force Do not ask for confirmation
|
|
@@ -1493,6 +1509,37 @@ DESCRIPTION
|
|
|
1493
1509
|
List supported Apps and Versions
|
|
1494
1510
|
```
|
|
1495
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
|
+
|
|
1496
1543
|
## `mw backup create`
|
|
1497
1544
|
|
|
1498
1545
|
Create a new backup of a project
|
|
@@ -1502,13 +1549,13 @@ USAGE
|
|
|
1502
1549
|
$ mw backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
|
|
1503
1550
|
|
|
1504
1551
|
FLAGS
|
|
1505
|
-
-p, --project-id=<value>
|
|
1506
|
-
|
|
1507
|
-
-q, --quiet
|
|
1508
|
-
-w, --wait
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
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.
|
|
1512
1559
|
|
|
1513
1560
|
ALIASES
|
|
1514
1561
|
$ mw project backup create
|
|
@@ -1566,14 +1613,14 @@ ARGUMENTS
|
|
|
1566
1613
|
BACKUP-ID the ID of the Backup to download.
|
|
1567
1614
|
|
|
1568
1615
|
FLAGS
|
|
1569
|
-
-q, --quiet
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
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.
|
|
1577
1624
|
|
|
1578
1625
|
DESCRIPTION
|
|
1579
1626
|
Download a backup to your local disk
|
|
@@ -1629,21 +1676,19 @@ List Backups for a given Project.
|
|
|
1629
1676
|
|
|
1630
1677
|
```
|
|
1631
1678
|
USAGE
|
|
1632
|
-
$ mw backup list [--columns <value> | -x] [--
|
|
1633
|
-
|
|
1679
|
+
$ mw backup list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1680
|
+
<value>]
|
|
1634
1681
|
|
|
1635
1682
|
FLAGS
|
|
1683
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1684
|
+
<options: json|yaml|csv>
|
|
1636
1685
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1637
1686
|
context
|
|
1638
1687
|
-x, --extended show extra columns
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
--no-truncate do not truncate output to fit screen
|
|
1644
|
-
--output=<option> output in a more machine friendly format
|
|
1645
|
-
<options: csv|json|yaml>
|
|
1646
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
1647
1692
|
|
|
1648
1693
|
DESCRIPTION
|
|
1649
1694
|
List Backups for a given Project.
|
|
@@ -1664,21 +1709,19 @@ List backup schedules belonging to a given project.
|
|
|
1664
1709
|
|
|
1665
1710
|
```
|
|
1666
1711
|
USAGE
|
|
1667
|
-
$ mw backup schedule list [--columns <value> | -x] [--
|
|
1668
|
-
|
|
1712
|
+
$ mw backup schedule list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
1713
|
+
<value>]
|
|
1669
1714
|
|
|
1670
1715
|
FLAGS
|
|
1716
|
+
-o, --output=<option> output in a more machine friendly format
|
|
1717
|
+
<options: json|yaml|csv>
|
|
1671
1718
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1672
1719
|
context
|
|
1673
1720
|
-x, --extended show extra columns
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
--no-truncate do not truncate output to fit screen
|
|
1679
|
-
--output=<option> output in a more machine friendly format
|
|
1680
|
-
<options: csv|json|yaml>
|
|
1681
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
1682
1725
|
|
|
1683
1726
|
DESCRIPTION
|
|
1684
1727
|
List backup schedules belonging to a given project.
|
|
@@ -1739,19 +1782,16 @@ Get all conversation categories.
|
|
|
1739
1782
|
|
|
1740
1783
|
```
|
|
1741
1784
|
USAGE
|
|
1742
|
-
$ mw conversation categories [--columns <value> | -x] [--
|
|
1743
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
1785
|
+
$ mw conversation categories [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1744
1786
|
|
|
1745
1787
|
FLAGS
|
|
1746
|
-
-
|
|
1747
|
-
|
|
1748
|
-
--
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
<options: csv|json|yaml>
|
|
1754
|
-
--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
|
|
1755
1795
|
|
|
1756
1796
|
DESCRIPTION
|
|
1757
1797
|
Get all conversation categories.
|
|
@@ -1802,19 +1842,16 @@ Get all conversations the authenticated user has created or has access to.
|
|
|
1802
1842
|
|
|
1803
1843
|
```
|
|
1804
1844
|
USAGE
|
|
1805
|
-
$ mw conversation list [--columns <value> | -x] [--
|
|
1806
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
1845
|
+
$ mw conversation list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
1807
1846
|
|
|
1808
1847
|
FLAGS
|
|
1809
|
-
-
|
|
1810
|
-
|
|
1811
|
-
--
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
<options: csv|json|yaml>
|
|
1817
|
-
--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
|
|
1818
1855
|
|
|
1819
1856
|
DESCRIPTION
|
|
1820
1857
|
Get all conversations the authenticated user has created or has access to.
|
|
@@ -1871,6 +1908,107 @@ FLAGS
|
|
|
1871
1908
|
--wait
|
|
1872
1909
|
```
|
|
1873
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
|
+
|
|
1874
2012
|
## `mw cronjob execution get CRONJOB-ID EXECUTION-ID`
|
|
1875
2013
|
|
|
1876
2014
|
Get a cron job execution.
|
|
@@ -1900,20 +2038,18 @@ List CronjobExecutions belonging to a Cronjob.
|
|
|
1900
2038
|
|
|
1901
2039
|
```
|
|
1902
2040
|
USAGE
|
|
1903
|
-
$ mw cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--
|
|
1904
|
-
|
|
2041
|
+
$ mw cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
2042
|
+
json|yaml|csv | | ]
|
|
1905
2043
|
|
|
1906
2044
|
FLAGS
|
|
1907
|
-
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
<options: csv|json|yaml>
|
|
1916
|
-
--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
|
|
1917
2053
|
|
|
1918
2054
|
DESCRIPTION
|
|
1919
2055
|
List CronjobExecutions belonging to a Cronjob.
|
|
@@ -1937,7 +2073,7 @@ ARGUMENTS
|
|
|
1937
2073
|
FLAGS
|
|
1938
2074
|
-o, --output=<option> output in a more machine friendly format
|
|
1939
2075
|
<options: json|yaml>
|
|
1940
|
-
|
|
2076
|
+
--no-pager Disable pager for output.
|
|
1941
2077
|
|
|
1942
2078
|
DESCRIPTION
|
|
1943
2079
|
Get the log output of a cronjob execution.
|
|
@@ -1950,52 +2086,47 @@ ALIASES
|
|
|
1950
2086
|
$ mw project cronjob execution logs
|
|
1951
2087
|
```
|
|
1952
2088
|
|
|
1953
|
-
## `mw cronjob get
|
|
2089
|
+
## `mw cronjob get CRONJOB-ID`
|
|
1954
2090
|
|
|
1955
|
-
Get a
|
|
2091
|
+
Get details of a cron job
|
|
1956
2092
|
|
|
1957
2093
|
```
|
|
1958
2094
|
USAGE
|
|
1959
|
-
$ mw cronjob get
|
|
2095
|
+
$ mw cronjob get CRONJOB-ID [-o json|yaml | | ]
|
|
1960
2096
|
|
|
1961
2097
|
ARGUMENTS
|
|
1962
|
-
|
|
2098
|
+
CRONJOB-ID ID of the cron job to be retrieved.
|
|
1963
2099
|
|
|
1964
2100
|
FLAGS
|
|
1965
2101
|
-o, --output=<option> output in a more machine friendly format
|
|
1966
2102
|
<options: json|yaml>
|
|
1967
2103
|
|
|
1968
2104
|
DESCRIPTION
|
|
1969
|
-
Get a
|
|
1970
|
-
|
|
1971
|
-
ALIASES
|
|
1972
|
-
$ mw project cronjob get
|
|
2105
|
+
Get details of a cron job
|
|
1973
2106
|
```
|
|
1974
2107
|
|
|
1975
2108
|
## `mw cronjob list`
|
|
1976
2109
|
|
|
1977
|
-
List
|
|
2110
|
+
List cron jobs belonging to a project.
|
|
1978
2111
|
|
|
1979
2112
|
```
|
|
1980
2113
|
USAGE
|
|
1981
|
-
$ mw cronjob list [--columns <value> | -x] [--
|
|
1982
|
-
|
|
2114
|
+
$ mw cronjob list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2115
|
+
<value>]
|
|
1983
2116
|
|
|
1984
2117
|
FLAGS
|
|
2118
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2119
|
+
<options: json|yaml|csv>
|
|
1985
2120
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
1986
2121
|
context
|
|
1987
2122
|
-x, --extended show extra columns
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
--no-truncate do not truncate output to fit screen
|
|
1993
|
-
--output=<option> output in a more machine friendly format
|
|
1994
|
-
<options: csv|json|yaml>
|
|
1995
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
1996
2127
|
|
|
1997
2128
|
DESCRIPTION
|
|
1998
|
-
List
|
|
2129
|
+
List cron jobs belonging to a project.
|
|
1999
2130
|
|
|
2000
2131
|
ALIASES
|
|
2001
2132
|
$ mw project cronjob list
|
|
@@ -2013,19 +2144,16 @@ List available MySQL character sets and collations, optionally filtered by a MyS
|
|
|
2013
2144
|
|
|
2014
2145
|
```
|
|
2015
2146
|
USAGE
|
|
2016
|
-
$ mw database mysql charsets [--columns <value> | -x] [--
|
|
2017
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
2147
|
+
$ mw database mysql charsets [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2018
2148
|
|
|
2019
2149
|
FLAGS
|
|
2020
|
-
-
|
|
2021
|
-
|
|
2022
|
-
--
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
<options: csv|json|yaml>
|
|
2028
|
-
--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
|
|
2029
2157
|
|
|
2030
2158
|
DESCRIPTION
|
|
2031
2159
|
List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
|
|
@@ -2041,17 +2169,17 @@ USAGE
|
|
|
2041
2169
|
[--user-password <value>] [--user-external] [--user-access-level full|readonly]
|
|
2042
2170
|
|
|
2043
2171
|
FLAGS
|
|
2044
|
-
-d, --description=<value>
|
|
2045
|
-
-p, --project-id=<value>
|
|
2046
|
-
|
|
2047
|
-
-q, --quiet
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
|
|
2054
|
-
|
|
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
|
|
2055
2183
|
|
|
2056
2184
|
FLAG DESCRIPTIONS
|
|
2057
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
|
|
@@ -2156,21 +2284,19 @@ List MySQLDatabases belonging to a Project.
|
|
|
2156
2284
|
|
|
2157
2285
|
```
|
|
2158
2286
|
USAGE
|
|
2159
|
-
$ mw database mysql list [--columns <value> | -x] [--
|
|
2160
|
-
|
|
2287
|
+
$ mw database mysql list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2288
|
+
<value>]
|
|
2161
2289
|
|
|
2162
2290
|
FLAGS
|
|
2291
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2292
|
+
<options: json|yaml|csv>
|
|
2163
2293
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2164
2294
|
context
|
|
2165
2295
|
-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)
|
|
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
|
|
2174
2300
|
|
|
2175
2301
|
DESCRIPTION
|
|
2176
2302
|
List MySQLDatabases belonging to a Project.
|
|
@@ -2206,8 +2332,8 @@ ARGUMENTS
|
|
|
2206
2332
|
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
|
|
2207
2333
|
|
|
2208
2334
|
FLAGS
|
|
2209
|
-
-q, --quiet
|
|
2210
|
-
|
|
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
|
|
2211
2337
|
|
|
2212
2338
|
FLAG DESCRIPTIONS
|
|
2213
2339
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
@@ -2271,20 +2397,18 @@ List MySQL users belonging to a database.
|
|
|
2271
2397
|
|
|
2272
2398
|
```
|
|
2273
2399
|
USAGE
|
|
2274
|
-
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--
|
|
2275
|
-
|
|
2400
|
+
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
2401
|
+
json|yaml|csv | | ]
|
|
2276
2402
|
|
|
2277
2403
|
FLAGS
|
|
2278
|
-
-
|
|
2279
|
-
|
|
2280
|
-
--
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
<options: csv|json|yaml>
|
|
2287
|
-
--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
|
|
2288
2412
|
|
|
2289
2413
|
DESCRIPTION
|
|
2290
2414
|
List MySQL users belonging to a database.
|
|
@@ -2296,19 +2420,16 @@ List available MySQL versions.
|
|
|
2296
2420
|
|
|
2297
2421
|
```
|
|
2298
2422
|
USAGE
|
|
2299
|
-
$ mw database mysql versions [--columns <value> | -x] [--
|
|
2300
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
2423
|
+
$ mw database mysql versions [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
2301
2424
|
|
|
2302
2425
|
FLAGS
|
|
2303
|
-
-
|
|
2304
|
-
|
|
2305
|
-
--
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
<options: csv|json|yaml>
|
|
2311
|
-
--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
|
|
2312
2433
|
|
|
2313
2434
|
DESCRIPTION
|
|
2314
2435
|
List available MySQL versions.
|
|
@@ -2325,16 +2446,16 @@ USAGE
|
|
|
2325
2446
|
noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-random|volatile-random|volatile-ttl]
|
|
2326
2447
|
|
|
2327
2448
|
FLAGS
|
|
2328
|
-
-d, --description=<value>
|
|
2329
|
-
-p, --project-id=<value>
|
|
2330
|
-
|
|
2331
|
-
-q, --quiet
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
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
|
|
2338
2459
|
|
|
2339
2460
|
FLAG DESCRIPTIONS
|
|
2340
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
|
|
@@ -2388,21 +2509,19 @@ List Redis databases belonging to a project.
|
|
|
2388
2509
|
|
|
2389
2510
|
```
|
|
2390
2511
|
USAGE
|
|
2391
|
-
$ mw database redis list [--columns <value> | -x] [--
|
|
2392
|
-
|
|
2512
|
+
$ mw database redis list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2513
|
+
<value>]
|
|
2393
2514
|
|
|
2394
2515
|
FLAGS
|
|
2516
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2517
|
+
<options: json|yaml|csv>
|
|
2395
2518
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2396
2519
|
context
|
|
2397
2520
|
-x, --extended show extra columns
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
--no-truncate do not truncate output to fit screen
|
|
2403
|
-
--output=<option> output in a more machine friendly format
|
|
2404
|
-
<options: csv|json|yaml>
|
|
2405
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2406
2525
|
|
|
2407
2526
|
DESCRIPTION
|
|
2408
2527
|
List Redis databases belonging to a project.
|
|
@@ -2441,21 +2560,19 @@ List available Redis versions.
|
|
|
2441
2560
|
|
|
2442
2561
|
```
|
|
2443
2562
|
USAGE
|
|
2444
|
-
$ mw database redis versions [--columns <value> | -x] [--
|
|
2445
|
-
|
|
2563
|
+
$ mw database redis versions [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2564
|
+
<value>]
|
|
2446
2565
|
|
|
2447
2566
|
FLAGS
|
|
2567
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2568
|
+
<options: json|yaml|csv>
|
|
2448
2569
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2449
2570
|
context
|
|
2450
2571
|
-x, --extended show extra columns
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
--no-truncate do not truncate output to fit screen
|
|
2456
|
-
--output=<option> output in a more machine friendly format
|
|
2457
|
-
<options: csv|json|yaml>
|
|
2458
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2459
2576
|
|
|
2460
2577
|
DESCRIPTION
|
|
2461
2578
|
List available Redis versions.
|
|
@@ -2535,21 +2652,19 @@ List Domains belonging to a Project.
|
|
|
2535
2652
|
|
|
2536
2653
|
```
|
|
2537
2654
|
USAGE
|
|
2538
|
-
$ mw domain list [--columns <value> | -x] [--
|
|
2539
|
-
|
|
2655
|
+
$ mw domain list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2656
|
+
<value>]
|
|
2540
2657
|
|
|
2541
2658
|
FLAGS
|
|
2659
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2660
|
+
<options: json|yaml|csv>
|
|
2542
2661
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2543
2662
|
context
|
|
2544
2663
|
-x, --extended show extra columns
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
--no-truncate do not truncate output to fit screen
|
|
2550
|
-
--output=<option> output in a more machine friendly format
|
|
2551
|
-
<options: csv|json|yaml>
|
|
2552
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2553
2668
|
|
|
2554
2669
|
DESCRIPTION
|
|
2555
2670
|
List Domains belonging to a Project.
|
|
@@ -2586,21 +2701,19 @@ List all domain ownerships of a project.
|
|
|
2586
2701
|
|
|
2587
2702
|
```
|
|
2588
2703
|
USAGE
|
|
2589
|
-
$ mw domain ownership list [--columns <value> | -x] [--
|
|
2590
|
-
|
|
2704
|
+
$ mw domain ownership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2705
|
+
<value>]
|
|
2591
2706
|
|
|
2592
2707
|
FLAGS
|
|
2708
|
+
-o, --output=<option> output in a more machine friendly format
|
|
2709
|
+
<options: json|yaml|csv>
|
|
2593
2710
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2594
2711
|
context
|
|
2595
2712
|
-x, --extended show extra columns
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
--no-truncate do not truncate output to fit screen
|
|
2601
|
-
--output=<option> output in a more machine friendly format
|
|
2602
|
-
<options: csv|json|yaml>
|
|
2603
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2604
2717
|
|
|
2605
2718
|
DESCRIPTION
|
|
2606
2719
|
List all domain ownerships of a project.
|
|
@@ -2622,13 +2735,13 @@ USAGE
|
|
|
2622
2735
|
[--path-to-url <value>]
|
|
2623
2736
|
|
|
2624
2737
|
FLAGS
|
|
2625
|
-
-p, --project-id=<value>
|
|
2626
|
-
|
|
2627
|
-
-q, --quiet
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
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
|
|
2632
2745
|
|
|
2633
2746
|
DESCRIPTION
|
|
2634
2747
|
Create a new ingress
|
|
@@ -2724,22 +2837,20 @@ List virtualhosts for a project.
|
|
|
2724
2837
|
|
|
2725
2838
|
```
|
|
2726
2839
|
USAGE
|
|
2727
|
-
$ mw domain virtualhost list [--columns <value> | -x] [--
|
|
2728
|
-
|
|
2840
|
+
$ mw domain virtualhost list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
2841
|
+
<value>] [-a]
|
|
2729
2842
|
|
|
2730
2843
|
FLAGS
|
|
2731
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>
|
|
2732
2847
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2733
2848
|
context
|
|
2734
2849
|
-x, --extended show extra columns
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
--no-truncate do not truncate output to fit screen
|
|
2740
|
-
--output=<option> output in a more machine friendly format
|
|
2741
|
-
<options: csv|json|yaml>
|
|
2742
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2743
2854
|
|
|
2744
2855
|
DESCRIPTION
|
|
2745
2856
|
List virtualhosts for a project.
|
|
@@ -2769,7 +2880,7 @@ DESCRIPTION
|
|
|
2769
2880
|
Display help for mw.
|
|
2770
2881
|
```
|
|
2771
2882
|
|
|
2772
|
-
_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)_
|
|
2773
2884
|
|
|
2774
2885
|
## `mw login reset`
|
|
2775
2886
|
|
|
@@ -2817,22 +2928,33 @@ Create a new mail address
|
|
|
2817
2928
|
```
|
|
2818
2929
|
USAGE
|
|
2819
2930
|
$ mw mail address create -a <value> [-p <value>] [-q] [--catch-all] [--enable-spam-protection] [--quota <value>]
|
|
2820
|
-
[--password <value>] [--random-password]
|
|
2931
|
+
[--password <value>] [--random-password] [--forward-to <value>]
|
|
2821
2932
|
|
|
2822
2933
|
FLAGS
|
|
2823
|
-
-a, --address=<value>
|
|
2824
|
-
-p, --project-id=<value>
|
|
2825
|
-
|
|
2826
|
-
-q, --quiet
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
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
|
|
2832
2944
|
|
|
2833
2945
|
DESCRIPTION
|
|
2834
2946
|
Create a new mail address
|
|
2835
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
|
+
|
|
2836
2958
|
When running this command with the --quiet flag, the output will contain the ID of the newly created address.
|
|
2837
2959
|
In addition, when run with --generated-password the output will be the ID of the newly created address, followed by a
|
|
2838
2960
|
tab character and the generated password.
|
|
@@ -2847,6 +2969,10 @@ EXAMPLES
|
|
|
2847
2969
|
|
|
2848
2970
|
$ mw mail address create --random-password --address foo@bar.example
|
|
2849
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
|
+
|
|
2850
2976
|
FLAG DESCRIPTIONS
|
|
2851
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
|
|
2852
2978
|
|
|
@@ -2858,6 +2984,12 @@ FLAG DESCRIPTIONS
|
|
|
2858
2984
|
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
|
|
2859
2985
|
scripts), you can use this flag to easily get the IDs of created resources for further processing.
|
|
2860
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
|
+
|
|
2861
2993
|
--password=<value> mailbox password
|
|
2862
2994
|
|
|
2863
2995
|
This is the password that should be used for the mailbox; if omitted, the command will prompt interactively for a
|
|
@@ -2921,21 +3053,19 @@ Get all mail addresses for a project ID
|
|
|
2921
3053
|
|
|
2922
3054
|
```
|
|
2923
3055
|
USAGE
|
|
2924
|
-
$ mw mail address list [--columns <value> | -x] [--
|
|
2925
|
-
|
|
3056
|
+
$ mw mail address list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3057
|
+
<value>]
|
|
2926
3058
|
|
|
2927
3059
|
FLAGS
|
|
3060
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3061
|
+
<options: json|yaml|csv>
|
|
2928
3062
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2929
3063
|
context
|
|
2930
3064
|
-x, --extended show extra columns
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
--no-truncate do not truncate output to fit screen
|
|
2936
|
-
--output=<option> output in a more machine friendly format
|
|
2937
|
-
<options: csv|json|yaml>
|
|
2938
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2939
3069
|
|
|
2940
3070
|
DESCRIPTION
|
|
2941
3071
|
Get all mail addresses for a project ID
|
|
@@ -2972,21 +3102,19 @@ Get all deliveryboxes by project ID
|
|
|
2972
3102
|
|
|
2973
3103
|
```
|
|
2974
3104
|
USAGE
|
|
2975
|
-
$ mw mail deliverybox list [--columns <value> | -x] [--
|
|
2976
|
-
|
|
3105
|
+
$ mw mail deliverybox list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3106
|
+
<value>]
|
|
2977
3107
|
|
|
2978
3108
|
FLAGS
|
|
3109
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3110
|
+
<options: json|yaml|csv>
|
|
2979
3111
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
2980
3112
|
context
|
|
2981
3113
|
-x, --extended show extra columns
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
--no-truncate do not truncate output to fit screen
|
|
2987
|
-
--output=<option> output in a more machine friendly format
|
|
2988
|
-
<options: csv|json|yaml>
|
|
2989
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
2990
3118
|
|
|
2991
3119
|
DESCRIPTION
|
|
2992
3120
|
Get all deliveryboxes by project ID
|
|
@@ -3007,7 +3135,7 @@ USAGE
|
|
|
3007
3135
|
$ mw org delete [ORG-ID] [-q] [-f]
|
|
3008
3136
|
|
|
3009
3137
|
ARGUMENTS
|
|
3010
|
-
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
|
|
3011
3139
|
|
|
3012
3140
|
FLAGS
|
|
3013
3141
|
-f, --force Do not ask for confirmation
|
|
@@ -3032,7 +3160,7 @@ USAGE
|
|
|
3032
3160
|
$ mw org get [ORG-ID] [-o json|yaml | | ]
|
|
3033
3161
|
|
|
3034
3162
|
ARGUMENTS
|
|
3035
|
-
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
|
|
3036
3164
|
|
|
3037
3165
|
FLAGS
|
|
3038
3166
|
-o, --output=<option> output in a more machine friendly format
|
|
@@ -3052,21 +3180,21 @@ USAGE
|
|
|
3052
3180
|
[--expires <value>]
|
|
3053
3181
|
|
|
3054
3182
|
FLAGS
|
|
3055
|
-
-o, --org-id=<value>
|
|
3056
|
-
-q, --quiet
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
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>
|
|
3062
3190
|
|
|
3063
3191
|
DESCRIPTION
|
|
3064
3192
|
Invite a user to an organization.
|
|
3065
3193
|
|
|
3066
3194
|
FLAG DESCRIPTIONS
|
|
3067
|
-
-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
|
|
3068
3196
|
|
|
3069
|
-
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
|
|
3070
3198
|
persistently set a default org for all commands that accept this flag.
|
|
3071
3199
|
|
|
3072
3200
|
-q, --quiet suppress process output and only display a machine-readable summary.
|
|
@@ -3081,28 +3209,26 @@ List all invites for an organization.
|
|
|
3081
3209
|
|
|
3082
3210
|
```
|
|
3083
3211
|
USAGE
|
|
3084
|
-
$ mw org invite list [--columns <value> | -x] [--
|
|
3085
|
-
|
|
3212
|
+
$ mw org invite list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-o
|
|
3213
|
+
<value>]
|
|
3086
3214
|
|
|
3087
3215
|
FLAGS
|
|
3088
|
-
-o, --org-id=<value>
|
|
3089
|
-
-
|
|
3090
|
-
|
|
3091
|
-
--
|
|
3092
|
-
|
|
3093
|
-
|
|
3094
|
-
|
|
3095
|
-
|
|
3096
|
-
<options: csv|json|yaml>
|
|
3097
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3098
3224
|
|
|
3099
3225
|
DESCRIPTION
|
|
3100
3226
|
List all invites for an organization.
|
|
3101
3227
|
|
|
3102
3228
|
FLAG DESCRIPTIONS
|
|
3103
|
-
-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
|
|
3104
3230
|
|
|
3105
|
-
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
|
|
3106
3232
|
persistently set a default org for all commands that accept this flag.
|
|
3107
3233
|
```
|
|
3108
3234
|
|
|
@@ -3112,19 +3238,16 @@ List all organization invites for the executing user.
|
|
|
3112
3238
|
|
|
3113
3239
|
```
|
|
3114
3240
|
USAGE
|
|
3115
|
-
$ mw org invite list-own [--columns <value> | -x] [--
|
|
3116
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3241
|
+
$ mw org invite list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3117
3242
|
|
|
3118
3243
|
FLAGS
|
|
3119
|
-
-
|
|
3120
|
-
|
|
3121
|
-
--
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
<options: csv|json|yaml>
|
|
3127
|
-
--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
|
|
3128
3251
|
|
|
3129
3252
|
DESCRIPTION
|
|
3130
3253
|
List all organization invites for the executing user.
|
|
@@ -3160,19 +3283,16 @@ Get all organizations the authenticated user has access to.
|
|
|
3160
3283
|
|
|
3161
3284
|
```
|
|
3162
3285
|
USAGE
|
|
3163
|
-
$ mw org list [--columns <value> | -x] [--
|
|
3164
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3286
|
+
$ mw org list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3165
3287
|
|
|
3166
3288
|
FLAGS
|
|
3167
|
-
-
|
|
3168
|
-
|
|
3169
|
-
--
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
<options: csv|json|yaml>
|
|
3175
|
-
--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
|
|
3176
3296
|
|
|
3177
3297
|
DESCRIPTION
|
|
3178
3298
|
Get all organizations the authenticated user has access to.
|
|
@@ -3184,28 +3304,26 @@ List all memberships belonging to an organization.
|
|
|
3184
3304
|
|
|
3185
3305
|
```
|
|
3186
3306
|
USAGE
|
|
3187
|
-
$ mw org membership list [--columns <value> | -x] [--
|
|
3188
|
-
|
|
3307
|
+
$ mw org membership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-o
|
|
3308
|
+
<value>]
|
|
3189
3309
|
|
|
3190
3310
|
FLAGS
|
|
3191
|
-
-o, --org-id=<value>
|
|
3192
|
-
-
|
|
3193
|
-
|
|
3194
|
-
--
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
<options: csv|json|yaml>
|
|
3200
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3201
3319
|
|
|
3202
3320
|
DESCRIPTION
|
|
3203
3321
|
List all memberships belonging to an organization.
|
|
3204
3322
|
|
|
3205
3323
|
FLAG DESCRIPTIONS
|
|
3206
|
-
-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
|
|
3207
3325
|
|
|
3208
|
-
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
|
|
3209
3327
|
persistently set a default org for all commands that accept this flag.
|
|
3210
3328
|
```
|
|
3211
3329
|
|
|
@@ -3215,19 +3333,16 @@ List all organization memberships for the executing user.
|
|
|
3215
3333
|
|
|
3216
3334
|
```
|
|
3217
3335
|
USAGE
|
|
3218
|
-
$ mw org membership list-own [--columns <value> | -x] [--
|
|
3219
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3336
|
+
$ mw org membership list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3220
3337
|
|
|
3221
3338
|
FLAGS
|
|
3222
|
-
-
|
|
3223
|
-
|
|
3224
|
-
--
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
<options: csv|json|yaml>
|
|
3230
|
-
--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
|
|
3231
3346
|
|
|
3232
3347
|
DESCRIPTION
|
|
3233
3348
|
List all organization memberships for the executing user.
|
|
@@ -3266,13 +3381,13 @@ USAGE
|
|
|
3266
3381
|
$ mw project backup create --expires <value> [-q] [-p <value>] [--description <value>] [-w] [--wait-timeout <value>]
|
|
3267
3382
|
|
|
3268
3383
|
FLAGS
|
|
3269
|
-
-p, --project-id=<value>
|
|
3270
|
-
|
|
3271
|
-
-q, --quiet
|
|
3272
|
-
-w, --wait
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
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.
|
|
3276
3391
|
|
|
3277
3392
|
ALIASES
|
|
3278
3393
|
$ mw project backup create
|
|
@@ -3330,14 +3445,14 @@ ARGUMENTS
|
|
|
3330
3445
|
BACKUP-ID the ID of the Backup to download.
|
|
3331
3446
|
|
|
3332
3447
|
FLAGS
|
|
3333
|
-
-q, --quiet
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3340
|
-
|
|
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.
|
|
3341
3456
|
|
|
3342
3457
|
DESCRIPTION
|
|
3343
3458
|
Download a backup to your local disk
|
|
@@ -3393,21 +3508,19 @@ List Backups for a given Project.
|
|
|
3393
3508
|
|
|
3394
3509
|
```
|
|
3395
3510
|
USAGE
|
|
3396
|
-
$ mw project backup list [--columns <value> | -x] [--
|
|
3397
|
-
|
|
3511
|
+
$ mw project backup list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3512
|
+
<value>]
|
|
3398
3513
|
|
|
3399
3514
|
FLAGS
|
|
3515
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3516
|
+
<options: json|yaml|csv>
|
|
3400
3517
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3401
3518
|
context
|
|
3402
3519
|
-x, --extended show extra columns
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
--no-truncate do not truncate output to fit screen
|
|
3408
|
-
--output=<option> output in a more machine friendly format
|
|
3409
|
-
<options: csv|json|yaml>
|
|
3410
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3411
3524
|
|
|
3412
3525
|
DESCRIPTION
|
|
3413
3526
|
List Backups for a given Project.
|
|
@@ -3428,21 +3541,19 @@ List backup schedules belonging to a given project.
|
|
|
3428
3541
|
|
|
3429
3542
|
```
|
|
3430
3543
|
USAGE
|
|
3431
|
-
$ mw project backupschedule list [--columns <value> | -x] [--
|
|
3432
|
-
|
|
3544
|
+
$ mw project backupschedule list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3545
|
+
<value>]
|
|
3433
3546
|
|
|
3434
3547
|
FLAGS
|
|
3548
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3549
|
+
<options: json|yaml|csv>
|
|
3435
3550
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3436
3551
|
context
|
|
3437
3552
|
-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)
|
|
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
|
|
3446
3557
|
|
|
3447
3558
|
DESCRIPTION
|
|
3448
3559
|
List backup schedules belonging to a given project.
|
|
@@ -3466,12 +3577,13 @@ USAGE
|
|
|
3466
3577
|
$ mw project create -d <value> [-s <value>] [-q] [-w] [--wait-timeout <value>] [--update-context]
|
|
3467
3578
|
|
|
3468
3579
|
FLAGS
|
|
3469
|
-
-d, --description=<value>
|
|
3470
|
-
-q, --quiet
|
|
3471
|
-
-s, --server-id=<value>
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
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.
|
|
3475
3587
|
|
|
3476
3588
|
DESCRIPTION
|
|
3477
3589
|
Create a new project
|
|
@@ -3517,20 +3629,18 @@ List CronjobExecutions belonging to a Cronjob.
|
|
|
3517
3629
|
|
|
3518
3630
|
```
|
|
3519
3631
|
USAGE
|
|
3520
|
-
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--
|
|
3521
|
-
|
|
3632
|
+
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o
|
|
3633
|
+
json|yaml|csv | | ]
|
|
3522
3634
|
|
|
3523
3635
|
FLAGS
|
|
3524
|
-
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
<options: csv|json|yaml>
|
|
3533
|
-
--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
|
|
3534
3644
|
|
|
3535
3645
|
DESCRIPTION
|
|
3536
3646
|
List CronjobExecutions belonging to a Cronjob.
|
|
@@ -3554,7 +3664,7 @@ ARGUMENTS
|
|
|
3554
3664
|
FLAGS
|
|
3555
3665
|
-o, --output=<option> output in a more machine friendly format
|
|
3556
3666
|
<options: json|yaml>
|
|
3557
|
-
|
|
3667
|
+
--no-pager Disable pager for output.
|
|
3558
3668
|
|
|
3559
3669
|
DESCRIPTION
|
|
3560
3670
|
Get the log output of a cronjob execution.
|
|
@@ -3567,52 +3677,28 @@ ALIASES
|
|
|
3567
3677
|
$ mw project cronjob execution logs
|
|
3568
3678
|
```
|
|
3569
3679
|
|
|
3570
|
-
## `mw project cronjob get CRONJOBID`
|
|
3571
|
-
|
|
3572
|
-
Get a cronjob.
|
|
3573
|
-
|
|
3574
|
-
```
|
|
3575
|
-
USAGE
|
|
3576
|
-
$ mw project cronjob get CRONJOBID [-o json|yaml | | ]
|
|
3577
|
-
|
|
3578
|
-
ARGUMENTS
|
|
3579
|
-
CRONJOBID ID of the cronjob to be retrieved.
|
|
3580
|
-
|
|
3581
|
-
FLAGS
|
|
3582
|
-
-o, --output=<option> output in a more machine friendly format
|
|
3583
|
-
<options: json|yaml>
|
|
3584
|
-
|
|
3585
|
-
DESCRIPTION
|
|
3586
|
-
Get a cronjob.
|
|
3587
|
-
|
|
3588
|
-
ALIASES
|
|
3589
|
-
$ mw project cronjob get
|
|
3590
|
-
```
|
|
3591
|
-
|
|
3592
3680
|
## `mw project cronjob list`
|
|
3593
3681
|
|
|
3594
|
-
List
|
|
3682
|
+
List cron jobs belonging to a project.
|
|
3595
3683
|
|
|
3596
3684
|
```
|
|
3597
3685
|
USAGE
|
|
3598
|
-
$ mw project cronjob list [--columns <value> | -x] [--
|
|
3599
|
-
|
|
3686
|
+
$ mw project cronjob list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3687
|
+
<value>]
|
|
3600
3688
|
|
|
3601
3689
|
FLAGS
|
|
3690
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3691
|
+
<options: json|yaml|csv>
|
|
3602
3692
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3603
3693
|
context
|
|
3604
3694
|
-x, --extended show extra columns
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
--no-truncate do not truncate output to fit screen
|
|
3610
|
-
--output=<option> output in a more machine friendly format
|
|
3611
|
-
<options: csv|json|yaml>
|
|
3612
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3613
3699
|
|
|
3614
3700
|
DESCRIPTION
|
|
3615
|
-
List
|
|
3701
|
+
List cron jobs belonging to a project.
|
|
3616
3702
|
|
|
3617
3703
|
ALIASES
|
|
3618
3704
|
$ mw project cronjob list
|
|
@@ -3651,7 +3737,7 @@ FLAG DESCRIPTIONS
|
|
|
3651
3737
|
|
|
3652
3738
|
## `mw project filesystem usage [PROJECT-ID]`
|
|
3653
3739
|
|
|
3654
|
-
Get a
|
|
3740
|
+
Get a project directory filesystem usage.
|
|
3655
3741
|
|
|
3656
3742
|
```
|
|
3657
3743
|
USAGE
|
|
@@ -3663,10 +3749,10 @@ ARGUMENTS
|
|
|
3663
3749
|
FLAGS
|
|
3664
3750
|
-o, --output=<option> output in a more machine friendly format
|
|
3665
3751
|
<options: json|yaml>
|
|
3666
|
-
|
|
3752
|
+
--human Display human readable sizes.
|
|
3667
3753
|
|
|
3668
3754
|
DESCRIPTION
|
|
3669
|
-
Get a
|
|
3755
|
+
Get a project directory filesystem usage.
|
|
3670
3756
|
```
|
|
3671
3757
|
|
|
3672
3758
|
## `mw project get [PROJECT-ID]`
|
|
@@ -3713,21 +3799,19 @@ List all invites belonging to a project.
|
|
|
3713
3799
|
|
|
3714
3800
|
```
|
|
3715
3801
|
USAGE
|
|
3716
|
-
$ mw project invite list [--columns <value> | -x] [--
|
|
3717
|
-
|
|
3802
|
+
$ mw project invite list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3803
|
+
<value>]
|
|
3718
3804
|
|
|
3719
3805
|
FLAGS
|
|
3806
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3807
|
+
<options: json|yaml|csv>
|
|
3720
3808
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3721
3809
|
context
|
|
3722
3810
|
-x, --extended show extra columns
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
--no-truncate do not truncate output to fit screen
|
|
3728
|
-
--output=<option> output in a more machine friendly format
|
|
3729
|
-
<options: csv|json|yaml>
|
|
3730
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3731
3815
|
|
|
3732
3816
|
DESCRIPTION
|
|
3733
3817
|
List all invites belonging to a project.
|
|
@@ -3745,19 +3829,16 @@ List all project invites for the executing user.
|
|
|
3745
3829
|
|
|
3746
3830
|
```
|
|
3747
3831
|
USAGE
|
|
3748
|
-
$ mw project invite list-own [--columns <value> | -x] [--
|
|
3749
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3832
|
+
$ mw project invite list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3750
3833
|
|
|
3751
3834
|
FLAGS
|
|
3752
|
-
-
|
|
3753
|
-
|
|
3754
|
-
--
|
|
3755
|
-
|
|
3756
|
-
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
<options: csv|json|yaml>
|
|
3760
|
-
--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
|
|
3761
3842
|
|
|
3762
3843
|
DESCRIPTION
|
|
3763
3844
|
List all project invites for the executing user.
|
|
@@ -3769,19 +3850,16 @@ List all projects that you have access to
|
|
|
3769
3850
|
|
|
3770
3851
|
```
|
|
3771
3852
|
USAGE
|
|
3772
|
-
$ mw project list [--columns <value> | -x] [--
|
|
3773
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
3853
|
+
$ mw project list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
3774
3854
|
|
|
3775
3855
|
FLAGS
|
|
3776
|
-
-
|
|
3777
|
-
|
|
3778
|
-
--
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
<options: csv|json|yaml>
|
|
3784
|
-
--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
|
|
3785
3863
|
|
|
3786
3864
|
DESCRIPTION
|
|
3787
3865
|
List all projects that you have access to
|
|
@@ -3836,21 +3914,19 @@ List all memberships for a Project.
|
|
|
3836
3914
|
|
|
3837
3915
|
```
|
|
3838
3916
|
USAGE
|
|
3839
|
-
$ mw project membership list [--columns <value> | -x] [--
|
|
3840
|
-
|
|
3917
|
+
$ mw project membership list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3918
|
+
<value>]
|
|
3841
3919
|
|
|
3842
3920
|
FLAGS
|
|
3921
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3922
|
+
<options: json|yaml|csv>
|
|
3843
3923
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3844
3924
|
context
|
|
3845
3925
|
-x, --extended show extra columns
|
|
3846
|
-
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
--no-truncate do not truncate output to fit screen
|
|
3851
|
-
--output=<option> output in a more machine friendly format
|
|
3852
|
-
<options: csv|json|yaml>
|
|
3853
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3854
3930
|
|
|
3855
3931
|
DESCRIPTION
|
|
3856
3932
|
List all memberships for a Project.
|
|
@@ -3868,19 +3944,17 @@ List ProjectMemberships belonging to the executing user.
|
|
|
3868
3944
|
|
|
3869
3945
|
```
|
|
3870
3946
|
USAGE
|
|
3871
|
-
$ mw project membership list-own [--columns <value> | -x] [--
|
|
3872
|
-
|
|
3947
|
+
$ mw project membership list-own [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv |
|
|
3948
|
+
| ]
|
|
3873
3949
|
|
|
3874
3950
|
FLAGS
|
|
3875
|
-
-
|
|
3876
|
-
|
|
3877
|
-
--
|
|
3878
|
-
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
<options: csv|json|yaml>
|
|
3883
|
-
--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
|
|
3884
3958
|
|
|
3885
3959
|
DESCRIPTION
|
|
3886
3960
|
List ProjectMemberships belonging to the executing user.
|
|
@@ -3892,21 +3966,19 @@ List all SFTP users for a project.
|
|
|
3892
3966
|
|
|
3893
3967
|
```
|
|
3894
3968
|
USAGE
|
|
3895
|
-
$ mw project sftp-user list [--columns <value> | -x] [--
|
|
3896
|
-
|
|
3969
|
+
$ mw project sftp-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
3970
|
+
<value>]
|
|
3897
3971
|
|
|
3898
3972
|
FLAGS
|
|
3973
|
+
-o, --output=<option> output in a more machine friendly format
|
|
3974
|
+
<options: json|yaml|csv>
|
|
3899
3975
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3900
3976
|
context
|
|
3901
3977
|
-x, --extended show extra columns
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
--no-truncate do not truncate output to fit screen
|
|
3907
|
-
--output=<option> output in a more machine friendly format
|
|
3908
|
-
<options: csv|json|yaml>
|
|
3909
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3910
3982
|
|
|
3911
3983
|
DESCRIPTION
|
|
3912
3984
|
List all SFTP users for a project.
|
|
@@ -3942,21 +4014,19 @@ List all SSH users for a project.
|
|
|
3942
4014
|
|
|
3943
4015
|
```
|
|
3944
4016
|
USAGE
|
|
3945
|
-
$ mw project ssh-user list [--columns <value> | -x] [--
|
|
3946
|
-
|
|
4017
|
+
$ mw project ssh-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4018
|
+
<value>]
|
|
3947
4019
|
|
|
3948
4020
|
FLAGS
|
|
4021
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4022
|
+
<options: json|yaml|csv>
|
|
3949
4023
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
3950
4024
|
context
|
|
3951
4025
|
-x, --extended show extra columns
|
|
3952
|
-
|
|
3953
|
-
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
--no-truncate do not truncate output to fit screen
|
|
3957
|
-
--output=<option> output in a more machine friendly format
|
|
3958
|
-
<options: csv|json|yaml>
|
|
3959
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
3960
4030
|
|
|
3961
4031
|
DESCRIPTION
|
|
3962
4032
|
List all SSH users for a project.
|
|
@@ -4011,19 +4081,16 @@ List servers for an organization or user.
|
|
|
4011
4081
|
|
|
4012
4082
|
```
|
|
4013
4083
|
USAGE
|
|
4014
|
-
$ mw server list [--columns <value> | -x] [--
|
|
4015
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4084
|
+
$ mw server list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4016
4085
|
|
|
4017
4086
|
FLAGS
|
|
4018
|
-
-
|
|
4019
|
-
|
|
4020
|
-
--
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
<options: csv|json|yaml>
|
|
4026
|
-
--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
|
|
4027
4094
|
|
|
4028
4095
|
DESCRIPTION
|
|
4029
4096
|
List servers for an organization or user.
|
|
@@ -4035,21 +4102,19 @@ List all SFTP users for a project.
|
|
|
4035
4102
|
|
|
4036
4103
|
```
|
|
4037
4104
|
USAGE
|
|
4038
|
-
$ mw sftp-user list [--columns <value> | -x] [--
|
|
4039
|
-
|
|
4105
|
+
$ mw sftp-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4106
|
+
<value>]
|
|
4040
4107
|
|
|
4041
4108
|
FLAGS
|
|
4109
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4110
|
+
<options: json|yaml|csv>
|
|
4042
4111
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
4043
4112
|
context
|
|
4044
4113
|
-x, --extended show extra columns
|
|
4045
|
-
|
|
4046
|
-
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
--no-truncate do not truncate output to fit screen
|
|
4050
|
-
--output=<option> output in a more machine friendly format
|
|
4051
|
-
<options: csv|json|yaml>
|
|
4052
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
4053
4118
|
|
|
4054
4119
|
DESCRIPTION
|
|
4055
4120
|
List all SFTP users for a project.
|
|
@@ -4070,21 +4135,19 @@ List all SSH users for a project.
|
|
|
4070
4135
|
|
|
4071
4136
|
```
|
|
4072
4137
|
USAGE
|
|
4073
|
-
$ mw ssh-user list [--columns <value> | -x] [--
|
|
4074
|
-
|
|
4138
|
+
$ mw ssh-user list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ] [-p
|
|
4139
|
+
<value>]
|
|
4075
4140
|
|
|
4076
4141
|
FLAGS
|
|
4142
|
+
-o, --output=<option> output in a more machine friendly format
|
|
4143
|
+
<options: json|yaml|csv>
|
|
4077
4144
|
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
|
|
4078
4145
|
context
|
|
4079
4146
|
-x, --extended show extra columns
|
|
4080
|
-
|
|
4081
|
-
|
|
4082
|
-
|
|
4083
|
-
|
|
4084
|
-
--no-truncate do not truncate output to fit screen
|
|
4085
|
-
--output=<option> output in a more machine friendly format
|
|
4086
|
-
<options: csv|json|yaml>
|
|
4087
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
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
|
|
4088
4151
|
|
|
4089
4152
|
DESCRIPTION
|
|
4090
4153
|
List all SSH users for a project.
|
|
@@ -4111,7 +4174,7 @@ FLAGS
|
|
|
4111
4174
|
-a, --available See available versions.
|
|
4112
4175
|
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
|
|
4113
4176
|
-v, --version=<value> Install a specific version.
|
|
4114
|
-
|
|
4177
|
+
--force Force a re-download of the requested version.
|
|
4115
4178
|
|
|
4116
4179
|
DESCRIPTION
|
|
4117
4180
|
update the mw CLI
|
|
@@ -4134,7 +4197,7 @@ EXAMPLES
|
|
|
4134
4197
|
$ mw update --available
|
|
4135
4198
|
```
|
|
4136
4199
|
|
|
4137
|
-
_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)_
|
|
4138
4201
|
|
|
4139
4202
|
## `mw user api-token create`
|
|
4140
4203
|
|
|
@@ -4145,11 +4208,11 @@ USAGE
|
|
|
4145
4208
|
$ mw user api-token create --description <value> --roles api_read|api_write [-q] [--expires-in <value>]
|
|
4146
4209
|
|
|
4147
4210
|
FLAGS
|
|
4148
|
-
-q, --quiet
|
|
4149
|
-
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
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>
|
|
4153
4216
|
|
|
4154
4217
|
DESCRIPTION
|
|
4155
4218
|
Create a new API token
|
|
@@ -4186,19 +4249,16 @@ List all API tokens of the user
|
|
|
4186
4249
|
|
|
4187
4250
|
```
|
|
4188
4251
|
USAGE
|
|
4189
|
-
$ mw user api-token list [--columns <value> | -x] [--
|
|
4190
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4252
|
+
$ mw user api-token list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4191
4253
|
|
|
4192
4254
|
FLAGS
|
|
4193
|
-
-
|
|
4194
|
-
|
|
4195
|
-
--
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
|
|
4199
|
-
|
|
4200
|
-
<options: csv|json|yaml>
|
|
4201
|
-
--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
|
|
4202
4262
|
|
|
4203
4263
|
DESCRIPTION
|
|
4204
4264
|
List all API tokens of the user
|
|
@@ -4274,19 +4334,16 @@ List all active sessions
|
|
|
4274
4334
|
|
|
4275
4335
|
```
|
|
4276
4336
|
USAGE
|
|
4277
|
-
$ mw user session list [--columns <value> | -x] [--
|
|
4278
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4337
|
+
$ mw user session list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4279
4338
|
|
|
4280
4339
|
FLAGS
|
|
4281
|
-
-
|
|
4282
|
-
|
|
4283
|
-
--
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
<options: csv|json|yaml>
|
|
4289
|
-
--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
|
|
4290
4347
|
|
|
4291
4348
|
DESCRIPTION
|
|
4292
4349
|
List all active sessions
|
|
@@ -4301,11 +4358,11 @@ USAGE
|
|
|
4301
4358
|
$ mw user ssh-key create [-q] [--output <value>] [--no-passphrase] [--comment <value>] [--expiresAt <value>]
|
|
4302
4359
|
|
|
4303
4360
|
FLAGS
|
|
4304
|
-
-q, --quiet
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
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.
|
|
4309
4366
|
|
|
4310
4367
|
DESCRIPTION
|
|
4311
4368
|
Create and import a new SSH key
|
|
@@ -4367,19 +4424,16 @@ Get your stored ssh keys
|
|
|
4367
4424
|
|
|
4368
4425
|
```
|
|
4369
4426
|
USAGE
|
|
4370
|
-
$ mw user ssh-key list [--columns <value> | -x] [--
|
|
4371
|
-
csv|json|yaml | | ] [--sort <value>]
|
|
4427
|
+
$ mw user ssh-key list [--columns <value> | -x] [--no-header | [--csv | --no-truncate]] [-o json|yaml|csv | | ]
|
|
4372
4428
|
|
|
4373
4429
|
FLAGS
|
|
4374
|
-
-
|
|
4375
|
-
|
|
4376
|
-
--
|
|
4377
|
-
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
|
-
<options: csv|json|yaml>
|
|
4382
|
-
--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
|
|
4383
4437
|
|
|
4384
4438
|
DESCRIPTION
|
|
4385
4439
|
Get your stored ssh keys
|