mw
-- the mittwald command-line tool

⚠️ EXPERIMENTAL -- STABILITY NOTICE
This project is experimental, and we do not offer any stability guarantees
of any kind for the command structure, input flags and arguments and output
formats. We welcome you to give this project a try and we're looking forward
for any feedback on this project in this stage of development. However, please
do not rely on any inputs or outputs of this project to remain stable.
Synposis
mw
is the command-line tool for interacting with the mittwald mStudio v2 API.
Installation and first steps
Have a look at the
documentation for
installation instructions.
Usage
$ npm install -g @mittwald/cli
$ mw COMMAND
running command...
$ mw (--version)
@mittwald/cli/1.0.0 darwin-arm64 node-v18.11.0
$ mw --help [COMMAND]
USAGE
$ mw COMMAND
...
Commands
mw app copy INSTALLATION-ID
USAGE
$ mw app copy INSTALLATION-ID --description <value> [-q]
ARGUMENTS
INSTALLATION-ID ID of the app installation to get
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
--description=<value> (required) set a description for the new app installation
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw app dependency list
get all available dependencies
USAGE
$ mw app dependency list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
get all available dependencies
mw app dependency update INSTALLATION-ID
Update the dependencies of an app
USAGE
$ mw app dependency update INSTALLATION-ID --set <value> [-q] [--update-policy none|inheritedFromApp|patchLevel|all]
ARGUMENTS
INSTALLATION-ID ID of the app installation to get
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
--set=<value>... (required) set a dependency to a specific version
--update-policy=<option> [default: patchLevel] set the update policy for the configured dependencies
<options: none|inheritedFromApp|patchLevel|all>
EXAMPLES
Update Node.js version to newest available from the 18.x branch
$ mw app dependency update $APP_ID --set node=~18
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
--set=<value>... set a dependency to a specific version
The format is <dependency>=<version>, where <dependency> is the name of the dependency (use the "mw app dependency
list" command to get a list of available dependencies) and <version> is a semver constraint.
This flag may be specified multiple times to update multiple dependencies.
mw app dependency versions SYSTEMSOFTWARE
get all available versions of a particular dependency
USAGE
$ mw app dependency versions SYSTEMSOFTWARE [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
ARGUMENTS
SYSTEMSOFTWARE name of the systemsoftware for which to list versions
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
get all available versions of a particular dependency
mw app get INSTALLATION-ID
Get details about an app installation
USAGE
$ mw app get INSTALLATION-ID [-o json|yaml | | ]
ARGUMENTS
INSTALLATION-ID ID of the app installation to get
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get details about an app installation
mw app install wordpress
Creates new WordPress Installation.
USAGE
$ mw app install wordpress --version <value> --host <value> --admin-user <value> --admin-email <value> --admin-pass
<value> --site-title <value> [-p <value>] [-q] [-w]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-q, --quiet suppress process output and only display a machine-readable summary.
-w, --wait Wait for the App to be ready.
--admin-email=<value> (required) First Admin Users E-Mail.
--admin-pass=<value> (required) First Admin Users Password.
--admin-user=<value> (required) First Admin User for the app.
--host=<value> (required) Host under which the App will be available (Needs to be created separately).
--site-title=<value> (required) Site Title of the created appInstallation.
--version=<value> (required) [default: latest] Version of the App to be created - Defaults to latest
DESCRIPTION
Creates new WordPress Installation.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw app list
List installed apps in a project.
USAGE
$ mw app list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List installed apps in a project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw app uninstall INSTALLATION-ID
Uninstall an app
USAGE
$ mw app uninstall INSTALLATION-ID
ARGUMENTS
INSTALLATION-ID ID of the app installation to delete
DESCRIPTION
Uninstall an app
mw app versions [APP]
List supported Apps and Versions
USAGE
$ mw app versions [APP]
ARGUMENTS
APP name of specific app to get versions for
DESCRIPTION
List supported Apps and Versions
mw context get
Print an overview of currently set context parameters
USAGE
$ mw context get -o txt|json
FLAGS
-o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
representation, and 'json' for a machine-readable JSON representation.
<options: txt|json>
DESCRIPTION
Print an overview of currently set context parameters
The context allows you to persistently set values for common parameters, like --project-id or --server-id, so you
don't have to specify them on every command.
mw context set
Set context values for the current project, org or server
USAGE
$ mw context set [--project-id <value>] [--server-id <value>] [--org-id <value>]
FLAGS
--org-id=<value> ID or short ID of an organization
--project-id=<value> ID or short ID of a project
--server-id=<value> ID or short ID of a server
DESCRIPTION
Set context values for the current project, org or server
The context allows you to persistently set values for common parameters, like --project-id or --server-id, so you
don't have to specify them on every command.
mw conversation categories
Get all conversation categories.
USAGE
$ mw conversation categories [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all conversation categories.
mw conversation close ID
Close a conversation
USAGE
$ mw conversation close ID
ARGUMENTS
ID ID of the conversation to show
DESCRIPTION
Close a conversation
mw conversation create
Create a new conversation
USAGE
$ mw conversation create --title <value> [--message <value> | --message-from <value>] [--editor <value>] [--category
<value>]
FLAGS
--category=<value> [default: general] Category of the conversation; use the 'conversation categories' command to
list available categories
--editor=<value> [default: vim] The editor to use when opening the message for editing; will respect your
EDITOR environment variable, and fall back on 'vim' if that is not set.
--message=<value> The body of the message to send; if neither this nor --message-from is given, an editor will
be opened to enter the message.
--message-from=<value> A file from which to read the message to send; may be '-' to read from stdin. If neither this
nor --message is given, an editor will be opened to enter the message.
--title=<value> (required) Title of the conversation
DESCRIPTION
Create a new conversation
mw conversation list
Get all conversation the authenticated user has created or has access to.
USAGE
$ mw conversation list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all conversation the authenticated user has created or has access to.
mw conversation reply ID
Reply to a conversation
USAGE
$ mw conversation reply ID [--message <value> | --message-from <value>] [--editor <value>]
ARGUMENTS
ID ID of the conversation to show
FLAGS
--editor=<value> [default: vim] The editor to use when opening the message for editing; will respect your
EDITOR environment variable, and fall back on 'vim' if that is not set.
--message=<value> The body of the message to send; if neither this nor --message-from is given, an editor will
be opened to enter the message.
--message-from=<value> A file from which to read the message to send; may be '-' to read from stdin. If neither this
nor --message is given, an editor will be opened to enter the message.
DESCRIPTION
Reply to a conversation
mw conversation show ID
Show a conversation and message history
USAGE
$ mw conversation show ID
ARGUMENTS
ID ID of the conversation to show
DESCRIPTION
Show a conversation and message history
mw conversation show2 CONVERSATIONID
USAGE
$ mw conversation show2 CONVERSATIONID -o txt|json [--wait]
FLAGS
-o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
representation, and 'json' for a machine-readable JSON representation.
<options: txt|json>
--wait
mw database mysql charsets
List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
USAGE
$ mw database mysql charsets [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List available MySQL character sets and collations, optionally filtered by a MySQLVersion.
mw database mysql create
Create a new MySQL database
USAGE
$ mw database mysql create -d <value> --version <value> [-p <value>] [-q] [--collation <value>] [--character-set <value>]
[--user-password <value>] [--user-external] [--user-access-level full|readonly]
FLAGS
-d, --description=<value> (required) a description for the database
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-q, --quiet suppress process output and only display a machine-readable summary.
--character-set=<value> [default: utf8mb4] the character set to use
--collation=<value> [default: utf8mb4_unicode_ci] the collation to use
--user-access-level=<option> [default: full] the access level preset for the default user
<options: full|readonly>
--user-external enable external access for default user
--user-password=<value> the password to use for the default user (env: MYSQL_PWD)
--version=<value> (required) the MySQL version to use
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
--version=<value> the MySQL version to use
Use the "database mysql versions" command to list available versions
mw database mysql delete DATABASE-ID
Delete a MySQL database
USAGE
$ mw database mysql delete DATABASE-ID [-q] [-f]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Delete a MySQL database
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw database mysql dump DATABASE-ID
Create a dump of a MySQL database
USAGE
$ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
FLAGS
-o, --output=<value> (required) the output file to write the dump to ("-" for stdout)
-p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
-q, --quiet suppress process output and only display a machine-readable summary.
FLAG DESCRIPTIONS
-o, --output=<value> the output file to write the dump to ("-" for stdout)
The output file to write the dump to. You can specify "-" or "/dev/stdout" to write the dump directly to STDOUT; in
this case, you might want to use the --quiet/-q flag to supress all other output, so that you can pipe the mysqldump
for further processing.
-p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
The password to use for the MySQL user. If not provided, the environment variable MYSQL_PWD will be used. If that is
not set either, the command will interactively ask for the password.
NOTE: This is a security risk, as the password will be visible in the process list of your system, and will be
visible in your Shell history. It is recommended to use the environment variable instead.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw database mysql get DATABASE-ID
Get a MySQLDatabase.
USAGE
$ mw database mysql get DATABASE-ID [-o json|yaml | | ]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a MySQLDatabase.
mw database mysql list
List MySQLDatabases belonging to a Project.
USAGE
$ mw database mysql list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List MySQLDatabases belonging to a Project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw database mysql phpmyadmin DATABASE-ID
Open phpMyAdmin for a MySQL database.
USAGE
$ mw database mysql phpmyadmin DATABASE-ID
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
mw database mysql port-forward DATABASE-ID
Forward the TCP port of a MySQL database to a local port
USAGE
$ mw database mysql port-forward DATABASE-ID [-q] [--port <value>]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
--port=<value> [default: 3306] The local TCP port to forward to
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw database mysql shell DATABASE-ID
Connect to a MySQL database via the MySQL shell
USAGE
$ mw database mysql shell DATABASE-ID [-q] [-p <value>]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
FLAGS
-p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
-q, --quiet suppress process output and only display a machine-readable summary.
FLAG DESCRIPTIONS
-p, --mysql-password=<value> the password to use for the MySQL user (env: MYSQL_PWD)
The password to use for the MySQL user. If not provided, the environment variable MYSQL_PWD will be used. If that is
not set either, the command will interactively ask for the password.
NOTE: This is a security risk, as the password will be visible in the process list of your system, and will be
visible in your Shell history. It is recommended to use the environment variable instead.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw database mysql user get ID
Get a MySQL user.
USAGE
$ mw database mysql user get ID [-o json|yaml | | ]
ARGUMENTS
ID ID of the MySQL user to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a MySQL user.
mw database mysql user list
List MySQL users belonging to a database.
USAGE
$ mw database mysql user list --database-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--database-id=<value> (required) ID of the MySQL database to list users for.
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List MySQL users belonging to a database.
mw database mysql versions
List available MySQL versions.
USAGE
$ mw database mysql versions [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List available MySQL versions.
mw database redis create
Create a new Redis database
USAGE
$ mw database redis create -d <value> --version <value> [-p <value>] [-q] [--persistent] [--max-memory <value>]
[--max-memory-policy
noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-random|volatile-random|volatile-ttl]
FLAGS
-d, --description=<value> (required) a description for the database
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-q, --quiet suppress process output and only display a machine-readable summary.
--max-memory=<value> the maximum memory for the Redis database
--max-memory-policy=<option> the Redis eviction policy
<options: noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-random|vo
latile-random|volatile-ttl>
--[no-]persistent enable persistent storage for the Redis database
--version=<value> (required) the Redis version to use
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
--max-memory=<value> the maximum memory for the Redis database
This specifies the maximum memory; you should provide a number, followed by one of the IEC suffixes, like "Ki", "Mi"
or "Gi"
--max-memory-policy=noeviction|allkeys-lru|allkeys-lfu|volatile-lru|volatile-lfu|allkeys-random|volatile-random|volatile-ttl
the Redis eviction policy
See https://redis.io/docs/reference/eviction/#eviction-policies for details
--version=<value> the Redis version to use
Use the "database redis versions" command to list available versions
mw database redis get ID
Get a Redis database.
USAGE
$ mw database redis get ID [-o json|yaml | | ]
ARGUMENTS
ID ID of the Redis database to retrieve.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a Redis database.
mw database redis list
List Redis databases belonging to a project.
USAGE
$ mw database redis list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List Redis databases belonging to a project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw database redis shell DATABASE-ID
Connect to a Redis database via the redis-cli
USAGE
$ mw database redis shell DATABASE-ID [-q]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw database redis versions
List available Redis versions.
USAGE
$ mw database redis versions [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List available Redis versions.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw domain dnszone get ZONEID
gets a specific zone
USAGE
$ mw domain dnszone get ZONEID [-o json|yaml | | ]
ARGUMENTS
ZONEID id of the zone you want to get
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
gets a specific zone
mw domain dnszone list
gets all dns zones by project id
USAGE
$ mw domain dnszone list --project-id <value> [-o json|yaml | | ]
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
--project-id=<value> (required) project you want to get the zones for
DESCRIPTION
gets all dns zones by project id
mw domain get DOMAINID
Get a Domain.
USAGE
$ mw domain get DOMAINID [-o json|yaml | | ]
ARGUMENTS
DOMAINID undefined
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a Domain.
mw domain get-handle DOMAINNAME
Get a HandleSchema.
USAGE
$ mw domain get-handle DOMAINNAME [-o json|yaml | | ]
ARGUMENTS
DOMAINNAME The whole domain name
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a HandleSchema.
mw domain list
List Domains belonging to a Project.
USAGE
$ mw domain list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List Domains belonging to a Project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw domain ownership get DOMAINOWNERSHIPID
Get a domain ownership.
USAGE
$ mw domain ownership get DOMAINOWNERSHIPID [-o json|yaml | | ]
ARGUMENTS
DOMAINOWNERSHIPID undefined
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a domain ownership.
mw domain ownership list
List all domain ownerships of a project.
USAGE
$ mw domain ownership list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all domain ownerships of a project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw domain tld get TLD
Get a toplevel domain.
USAGE
$ mw domain tld get TLD [-o json|yaml | | ]
ARGUMENTS
TLD undefined
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a toplevel domain.
mw domain tld list
List all supported toplevel domains.
USAGE
$ mw domain tld list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all supported toplevel domains.
mw domain virtualhost create
Create a new ingress
USAGE
$ mw domain virtualhost create --hostname <value> [-q] [-p <value>] [--path-to-dir <value>] [--path-to-app <value>]
[--path-to-url <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-q, --quiet suppress process output and only display a machine-readable summary.
--hostname=<value> (required) the hostname of the ingress
--path-to-app=<value>... add a path mapping to an app
--path-to-dir=<value>... add a path mapping to a directory
--path-to-url=<value>... add a path mapping to an external url
DESCRIPTION
Create a new ingress
EXAMPLES
Create a new ingress, with the root path mapping to your project's root directory
$ mw domain virtualhost create --hostname mw.example --path-to-dir /:/
Create a new ingress, with the root path mapping to an app
$ mw domain virtualhost create --hostname mw.example --path-to-app /:3ecaf1a9-6eb4-4869-b811-8a13c3a2e745
Create a new ingress, with the root path mapping to a URL
$ mw domain virtualhost create --hostname mw.example --path-to-url /:https://redirect.example
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
--path-to-app=<value>... add a path mapping to an app
This flag can be used to map a specific URL path to an app; the value for this flag should be the URL path and the
app ID, separated by a colon, e.g. /:3ecaf1a9-6eb4-4869-b811-8a13c3a2e745. You can specify this flag multiple times
to map multiple paths to different apps, and also combine it with the other --path-to-* flags.
--path-to-dir=<value>... add a path mapping to a directory
This flag can be used to map a specific URL path to a directory in your project's file system; the value for this
flag should be the URL path and the filesystem path, separated by a colon, e.g. /:/ or /:/some/sub/path. You can
specify this flag multiple times to map multiple paths to different directories, and also combine it with the other
--path-to-* flags.
--path-to-url=<value>... add a path mapping to an external url
This flag can be used to map a specific URL path to an external URL; the value for this flag should be the URL path
and the external URL, separated by a colon, e.g. /:https://redirect.example. You can specify this flag multiple
times to map multiple paths to different external URLs, and also combine it with the other --path-to-* flags.
mw domain virtualhost delete VIRTUAL-HOST-ID
Delete a virtual host
USAGE
$ mw domain virtualhost delete VIRTUAL-HOST-ID [-q] [-f]
ARGUMENTS
VIRTUAL-HOST-ID ID of the virtual host to delete
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Delete a virtual host
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw domain virtualhost get INGRESS-ID
Get a virtual host.
USAGE
$ mw domain virtualhost get INGRESS-ID [-o json|yaml | | ]
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a virtual host.
mw domain virtualhost list
List virtualhosts for a project.
USAGE
$ mw domain virtualhost list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>] [-a]
FLAGS
-a, --all List all virtual hosts that you have access to, regardless of project
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List virtualhosts for a project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw help [COMMANDS]
Display help for mw.
USAGE
$ mw help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for mw.
See code: @oclif/plugin-help
mw login reset
Reset your local authentication state
USAGE
$ mw login reset
DESCRIPTION
Reset your local authentication state
mw login status
Checks your current authentication status
USAGE
$ mw login status
DESCRIPTION
Checks your current authentication status
mw login token
Authenticate using an API token
USAGE
$ mw login token [-o]
FLAGS
-o, --overwrite overwrite existing token file
DESCRIPTION
Authenticate using an API token
mw mail address create
Create a new mail address
USAGE
$ mw mail address create -a <value> [-p <value>] [-q] [--catch-all] [--enable-spam-protection] [--quota <value>]
[--password <value>] [--random-password]
FLAGS
-a, --address=<value> (required) mail address
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-q, --quiet suppress process output and only display a machine-readable summary.
--catch-all make this a catch-all mail address
--[no-]enable-spam-protection enable spam protection for this mailbox
--password=<value> mailbox password
--quota=<value> [default: 1024] mailbox quota in mebibytes
--random-password generate a random password
DESCRIPTION
Create a new mail address
When running this command with the --quiet flag, the output will contain the ID of the newly created address.
In addition, when run with --generated-password the output will be the ID of the newly created address, followed by a
tab character and the generated password.
EXAMPLES
Create non-interactively with password
$ read -s PASSWORD && \
mw mail address create --password $PASSWORD --address foo@bar.example
Create non-interactively with random password
$ mw mail address create --random-password --address foo@bar.example
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
--password=<value> mailbox password
This is the password that should be used for the mailbox; if omitted, the command will prompt interactively for a
password.
CAUTION: providing this flag may log your password in your shell history!
--random-password generate a random password
This flag will cause the command to generate a random 32-character password for the mailbox; when running with
--quiet, the address ID and the password will be printed to stdout, separated by a tab character.
mw mail address delete ID
Delete a mail address
USAGE
$ mw mail address delete ID [-q] [-f]
ARGUMENTS
ID Mail address ID
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Delete a mail address
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw mail address get ID
Get a specific mail address
USAGE
$ mw mail address get ID [-o json|yaml | | ]
ARGUMENTS
ID id of the address you want to get
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a specific mail address
mw mail address list
Get all mail addresses for a project ID
USAGE
$ mw mail address list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all mail addresses for a project ID
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw mail deliverybox get ID
Get a specific deliverybox
USAGE
$ mw mail deliverybox get ID [-o json|yaml | | ]
ARGUMENTS
ID ID of the deliverybox you want to retrieve
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a specific deliverybox
mw mail deliverybox list
Get all deliveryboxes by project ID
USAGE
$ mw mail deliverybox list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--project-id=<value> (required) Project ID the deliveryboxes are related to
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all deliveryboxes by project ID
mw org delete [ORG-ID]
Delete an organization
USAGE
$ mw org delete [ORG-ID] [-q] [-f]
ARGUMENTS
ORG-ID ID or short ID of a org; this argument is optional if a default org is set in the context
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Delete an organization
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw org get [ORG-ID]
Get an organization profile.
USAGE
$ mw org get [ORG-ID] [-o json|yaml | | ]
ARGUMENTS
ORG-ID ID or short ID of a org; this argument is optional if a default org is set in the context
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get an organization profile.
mw org invite
Invite a user to an organization.
USAGE
$ mw org invite --email <value> [-o <value>] [-q] [--role owner|member|accountant] [--message <value>]
[--expires <value>]
FLAGS
-o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
-q, --quiet suppress process output and only display a machine-readable summary.
--email=<value> (required) The email address of the user to invite.
--expires=<value> An interval after which the invitation expires (examples: 30m, 30d, 1y).
--message=<value> A message to include in the invitation email.
--role=<option> [default: member] The role of the user to invite.
<options: owner|member|accountant>
DESCRIPTION
Invite a user to an organization.
FLAG DESCRIPTIONS
-o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
May contain a short ID or a full ID of a org; you can also use the "mw context set --org-id=<VALUE>" command to
persistently set a default org for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw org invite list
List all invites for an organization.
USAGE
$ mw org invite list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-o <value>]
FLAGS
-o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all invites for an organization.
FLAG DESCRIPTIONS
-o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
May contain a short ID or a full ID of a org; you can also use the "mw context set --org-id=<VALUE>" command to
persistently set a default org for all commands that accept this flag.
mw org invite list-own
List all organization invites for the executing user.
USAGE
$ mw org invite list-own [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all organization invites for the executing user.
mw org invite revoke INVITE-ID
Revoke an invite to an organization
USAGE
$ mw org invite revoke INVITE-ID [-q]
ARGUMENTS
INVITE-ID The ID of the invite to revoke
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Revoke an invite to an organization
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw org list
Get all organizations the authenticated user has access to.
USAGE
$ mw org list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all organizations the authenticated user has access to.
mw org membership list
List all memberships belonging to an organization.
USAGE
$ mw org membership list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-o <value>]
FLAGS
-o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all memberships belonging to an organization.
FLAG DESCRIPTIONS
-o, --org-id=<value> ID or short ID of a org; this flag is optional if a default org is set in the context
May contain a short ID or a full ID of a org; you can also use the "mw context set --org-id=<VALUE>" command to
persistently set a default org for all commands that accept this flag.
mw org membership list-own
List all organization memberships for the executing user.
USAGE
$ mw org membership list-own [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all organization memberships for the executing user.
mw org membership revoke MEMBERSHIP-ID
Revoke a user's membership to an organization
USAGE
$ mw org membership revoke MEMBERSHIP-ID [-q]
ARGUMENTS
MEMBERSHIP-ID The ID of the membership to revoke
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Revoke a user's membership to an organization
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw project backup get PROJECTBACKUPID
Get a ProjectBackup.
USAGE
$ mw project backup get PROJECTBACKUPID [-o json|yaml | | ]
ARGUMENTS
PROJECTBACKUPID ID of the ProjectBackup to retrieve.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a ProjectBackup.
mw project backup list
List Backups for a given Project.
USAGE
$ mw project backup list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List Backups for a given Project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw project backupschedule get PROJECTBACKUPSCHEDULEID
Get a ProjectBackupSchedule.
USAGE
$ mw project backupschedule get PROJECTBACKUPSCHEDULEID [-o json|yaml | | ]
ARGUMENTS
PROJECTBACKUPSCHEDULEID ID of the ProjectBackupSchedule to retrieve.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a ProjectBackupSchedule.
mw project backupschedule list
List BackupSchedules belonging to a given Project.
USAGE
$ mw project backupschedule list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--project-id=<value> (required) ID of the Project to list BackupSchedules for.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List BackupSchedules belonging to a given Project.
mw project create
Get the details of a project
USAGE
$ mw project create -d <value> [-s <value>] [-q] [-w] [--update-context]
FLAGS
-d, --description=<value> (required) A description for the project.
-q, --quiet suppress process output and only display a machine-readable summary.
-s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the context
-w, --wait Wait for the project to be ready.
--update-context Update the CLI context to use the newly created project
DESCRIPTION
Get the details of a project
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
-s, --server-id=<value> ID or short ID of a server; this flag is optional if a default server is set in the context
May contain a short ID or a full ID of a server; you can also use the "mw context set --server-id=<VALUE>" command
to persistently set a default server for all commands that accept this flag.
mw project cronjob execution get CRONJOB-ID EXECUTION-ID
Get a CronjobExecution.
USAGE
$ mw project cronjob execution get CRONJOB-ID EXECUTION-ID [-o json|yaml | | ]
ARGUMENTS
CRONJOB-ID ID of the cronjob the execution belongs to
EXECUTION-ID ID of the cronjob execution to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a CronjobExecution.
mw project cronjob execution list
List CronjobExecutions belonging to a Cronjob.
USAGE
$ mw project cronjob execution list --cronjob-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--cronjob-id=<value> (required) ID of the Cronjob for which to list CronjobExecutions for.
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List CronjobExecutions belonging to a Cronjob.
mw project cronjob execution logs CRONJOB-ID EXECUTION-ID
Get the log output of a cronjob execution.
USAGE
$ mw project cronjob execution logs CRONJOB-ID EXECUTION-ID [-o json|yaml | | ] [--no-pager]
ARGUMENTS
CRONJOB-ID ID of the cronjob the execution belongs to
EXECUTION-ID ID of the cronjob execution to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
--no-pager Disable pager for output.
DESCRIPTION
Get the log output of a cronjob execution.
This command prints the log output of a cronjob execution. When this command is run in a terminal, the output is piped
through a pager. The pager is determined by your PAGER environment variable, with defaulting to "less". You can
disable this behavior with the --no-pager flag.
mw project cronjob get CRONJOBID
Get a Cronjob.
USAGE
$ mw project cronjob get CRONJOBID [-o json|yaml | | ]
ARGUMENTS
CRONJOBID ID of the Cronjob to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a Cronjob.
mw project cronjob list
List Cronjobs belonging to a Project.
USAGE
$ mw project cronjob list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ] [-p <value>]
FLAGS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List Cronjobs belonging to a Project.
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
mw project delete [PROJECT-ID]
Delete a project
USAGE
$ mw project delete [PROJECT-ID] [-q] [-f]
ARGUMENTS
PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Delete a project
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw project filesystem usage [PROJECT-ID]
Get a Project directory filesystem usage.
USAGE
$ mw project filesystem usage [PROJECT-ID] [-o json|yaml | | ] [--human]
ARGUMENTS
PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
--human Display human readable sizes.
DESCRIPTION
Get a Project directory filesystem usage.
mw project get [PROJECT-ID]
Get a Project.
USAGE
$ mw project get [PROJECT-ID] [-o json|yaml | | ]
ARGUMENTS
PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a Project.
mw project invite get INVITEID
Get a ProjectInvite.
USAGE
$ mw project invite get INVITEID [-o json|yaml | | ]
ARGUMENTS
INVITEID ID of the ProjectInvite to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a ProjectInvite.
mw project invite list
List all invites belonging to a Project.
USAGE
$ mw project invite list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--project-id=<value> (required) ID of the Project to list invites for.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all invites belonging to a Project.
mw project invite list-own
List all ProjectInvites for the executing user.
USAGE
$ mw project invite list-own [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all ProjectInvites for the executing user.
mw project list
List Project's for an Organization or Server.
USAGE
$ mw project list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List Project's for an Organization or Server.
mw project list-react
USAGE
$ mw project list-react -o txt|json [--wait] [--columns <value> | ] [--extended] [--noTruncate]
FLAGS
-o, --output=<option> (required) [default: txt] The output format to use; use 'txt' for a human readable text
representation, and 'json' for a machine-readable JSON representation.
<options: txt|json>
--columns=<value> only show provided columns (comma-seperated)
--extended show extra columns
--noTruncate do not truncate output to fit screen
--wait
mw project membership get MEMBERSHIPID
Get a ProjectMembership
USAGE
$ mw project membership get MEMBERSHIPID [-o json|yaml | | ]
ARGUMENTS
MEMBERSHIPID ID of the ProjectMembership to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a ProjectMembership
mw project membership get-own
Get the executing user's membership in a Project.
USAGE
$ mw project membership get-own --project-id <value> [-o json|yaml | | ]
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
--project-id=<value> (required) ID of the Project to get the membership for.
DESCRIPTION
Get the executing user's membership in a Project.
mw project membership list
List all memberships for a Project.
USAGE
$ mw project membership list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--project-id=<value> (required) ID of the Project to list memberships for.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all memberships for a Project.
mw project membership list-own
List ProjectMemberships belonging to the executing user.
USAGE
$ mw project membership list-own [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List ProjectMemberships belonging to the executing user.
mw project sftp-user list
Get all SFTPUsers for a Project.
USAGE
$ mw project sftp-user list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--project-id=<value> (required) ID of the Project to request SFTPUsers for.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all SFTPUsers for a Project.
mw project ssh [PROJECT-ID]
Connect to a project via SSH
USAGE
$ mw project ssh [PROJECT-ID]
ARGUMENTS
PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
DESCRIPTION
Connect to a project via SSH
mw project ssh-user list
Get all SSHUsers for a Project.
USAGE
$ mw project ssh-user list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--project-id=<value> (required) ID of the Project to retrieve SSHUsers for.
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get all SSHUsers for a Project.
mw project update [PROJECT-ID]
Updates a project
USAGE
$ mw project update [PROJECT-ID]
ARGUMENTS
PROJECT-ID ID or short ID of a project; this argument is optional if a default project is set in the context
DESCRIPTION
Updates a project
mw server get SERVERID
Get a Server.
USAGE
$ mw server get SERVERID [-o json|yaml | | ]
ARGUMENTS
SERVERID ID of the Server to be retrieved.
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a Server.
mw server list
List Servers for an Organization or User.
USAGE
$ mw server list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List Servers for an Organization or User.
mw update [CHANNEL]
update the mw CLI
USAGE
$ mw update [CHANNEL] [-a] [-v <value> | -i] [--force]
FLAGS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the mw CLI
EXAMPLES
Update to the stable channel:
$ mw update stable
Update to a specific version:
$ mw update --version 1.0.0
Interactively select version:
$ mw update --interactive
See available versions:
$ mw update --available
See code: @oclif/plugin-update
mw user api-token create
Create a new API token
USAGE
$ mw user api-token create --description <value> --roles api_read|api_write [-q] [--expires-in <value>]
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
--description=<value> (required) Description of the API token
--expires-in=<value> Expiration interval of the API token (example: 30d)
--roles=<option>... (required) Roles of the API token
<options: api_read|api_write>
DESCRIPTION
Create a new API token
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw user api-token get APITOKENID
Get a specific ApiToken
USAGE
$ mw user api-token get APITOKENID [-o json|yaml | | ]
ARGUMENTS
APITOKENID The uuid of an ApiToken
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a specific ApiToken
mw user api-token list
List all ApiTokens of the user
USAGE
$ mw user api-token list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all ApiTokens of the user
mw user api-token revoke ID
Revoke an API token
USAGE
$ mw user api-token revoke ID [-q] [-f]
ARGUMENTS
ID ID of the API token to revoke
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Revoke an API token
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw user get
Get profile information for a user.
USAGE
$ mw user get [-o json|yaml | | ]
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get profile information for a user.
mw user session get TOKENID
Get a specific Session
USAGE
$ mw user session get TOKENID [-o json|yaml | | ]
ARGUMENTS
TOKENID tokenId to identify the concrete Session
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a specific Session
mw user session list
List all active sessions
USAGE
$ mw user session list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List all active sessions
mw user ssh-key create
Create and import a new SSH key
USAGE
$ mw user ssh-key create [-q] [--output <value>] [--no-passphrase] [--comment <value>] [--expiresAt <value>]
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
--comment=<value> A comment for the SSH key.
--expiresAt=<value> Duration after which the SSH key should expire (example: '1y').
--no-passphrase Use this flag to not set a passphrase for the SSH key.
--output=<value> [default: mstudio-cli] A filename in your ~/.ssh directory to write the SSH key to.
DESCRIPTION
Create and import a new SSH key
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw user ssh-key delete ID
Delete an SSH key
USAGE
$ mw user ssh-key delete ID [-q] [-f]
ARGUMENTS
ID ID of the SSH key to be deleted.
FLAGS
-f, --force Do not ask for confirmation
-q, --quiet suppress process output and only display a machine-readable summary.
DESCRIPTION
Delete an SSH key
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
mw user ssh-key get SSHKEYID
Get a specific stored SshKey
USAGE
$ mw user ssh-key get SSHKEYID [-o json|yaml | | ]
ARGUMENTS
SSHKEYID undefined
FLAGS
-o, --output=<option> output in a more machine friendly format
<options: json|yaml>
DESCRIPTION
Get a specific stored SshKey
mw user ssh-key list
Get your stored ssh keys
USAGE
$ mw user ssh-key list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Get your stored ssh keys