Manage apps, and app installations in your projects
mw app copy [INSTALLATION-ID]mw app create nodemw app create phpmw app create php-workermw app create pythonmw app create staticmw app dependency listmw app dependency update [INSTALLATION-ID]mw app dependency versions SYSTEMSOFTWAREmw app download [INSTALLATION-ID]mw app exec COMMANDmw app get [INSTALLATION-ID]mw app install contaomw app install joomlamw app install matomomw app install nextcloudmw app install shopware5mw app install shopware6mw app install typo3mw app install wordpressmw app listmw app list-upgrade-candidates [INSTALLATION-ID]mw app open [INSTALLATION-ID]mw app ssh [INSTALLATION-ID]mw app uninstall [INSTALLATION-ID]mw app update [INSTALLATION-ID]mw app upgrade [INSTALLATION-ID]mw app upload [INSTALLATION-ID]mw app version-info APP VERSIONmw app versions [APP]
Copy an app within a project
USAGE
$ mw app copy [INSTALLATION-ID] --description <value> [--token <value>] [-q] [--install-path <value>]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary
--description=<value> (required) set a description for the new app installation
--install-path=<value> set the installation path for the new app installation; if omitted, this will default to
an autogenerated directory name
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Copy an app within 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.
Creates new custom Node.js installation.
USAGE
$ mw app create node [--token <value>] [-p <value>] [-q] [--site-title <value>] [--entrypoint <value>] [-w]
[--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--entrypoint=<value> [default: yarn start] the command that should be used to start your custom Node.js
application.
--install-path=<value> the installation path of your custom Node.js application
--site-title=<value> site title for your custom Node.js installation.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new custom Node.js 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.
--entrypoint=<value> the command that should be used to start your custom Node.js application.
This is the command that should be used to start your application; the app is required to run in the foreground, and
to listen on the port specified by the PORT environment variable.
--install-path=<value> the installation path of your custom Node.js application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your custom Node.js installation.
The site title for this custom Node.js installation. It is also the title shown in the app overview in the mStudio
and the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
Creates new custom PHP installation.
USAGE
$ mw app create php --document-root <value> [--token <value>] [-p <value>] [-q] [--site-title <value>] [-w]
[--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--document-root=<value> (required) [default: /] the document root from which your custom PHP will be served
(relative to the installation path)
--install-path=<value> the installation path of your custom PHP application
--site-title=<value> site title for your custom PHP installation.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new custom PHP 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.
--document-root=<value>
the document root from which your custom PHP will be served (relative to the installation path)
This is the document root from which the files of your application will be served by the web server. This directory
is specified relative to the installation path.
--install-path=<value> the installation path of your custom PHP application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your custom PHP installation.
The site title for this custom PHP installation. It is also the title shown in the app overview in the mStudio and
the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
Creates new PHP worker installation.
USAGE
$ mw app create php-worker [--token <value>] [-p <value>] [-q] [--entrypoint <value>] [--site-title <value>] [-w]
[--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--entrypoint=<value> the command that should be used to start your PHP worker application.
--install-path=<value> the installation path of your PHP worker application
--site-title=<value> site title for your PHP worker installation.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new PHP worker 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.
--entrypoint=<value> the command that should be used to start your PHP worker application.
This is the command that should be used to start your application; the app is required to run in the foreground, and
to listen on the port specified by the PORT environment variable.
--install-path=<value> the installation path of your PHP worker application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your PHP worker installation.
The site title for this PHP worker installation. It is also the title shown in the app overview in the mStudio and
the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
Creates new custom python site installation.
USAGE
$ mw app create python [--token <value>] [-p <value>] [-q] [--site-title <value>] [--entrypoint <value>] [-w]
[--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--entrypoint=<value> the command that should be used to start your custom python site application.
--install-path=<value> the installation path of your custom python site application
--site-title=<value> site title for your custom python site installation.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new custom python site 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.
--entrypoint=<value> the command that should be used to start your custom python site application.
This is the command that should be used to start your application; the app is required to run in the foreground, and
to listen on the port specified by the PORT environment variable.
--install-path=<value> the installation path of your custom python site application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your custom python site installation.
The site title for this custom python site installation. It is also the title shown in the app overview in the
mStudio and the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
Creates new custom static site installation.
USAGE
$ mw app create static --document-root <value> [--token <value>] [-p <value>] [-q] [--site-title <value>] [-w]
[--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--document-root=<value> (required) [default: /] the document root from which your custom static site will be
served (relative to the installation path)
--install-path=<value> the installation path of your custom static site application
--site-title=<value> site title for your custom static site installation.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new custom static site 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.
--document-root=<value>
the document root from which your custom static site will be served (relative to the installation path)
This is the document root from which the files of your application will be served by the web server. This directory
is specified relative to the installation path.
--install-path=<value> the installation path of your custom static site application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your custom static site installation.
The site title for this custom static site installation. It is also the title shown in the app overview in the
mStudio and the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
Get all available dependencies
USAGE
$ mw app dependency list -o txt|json|yaml|csv|tsv [--token <value>] [-x] [--no-header] [--no-truncate]
[--no-relative-dates] [--csv-separator ,|;]
FLAGS
-o, --output=<option> (required) [default: txt] output in a more machine friendly format
<options: txt|json|yaml|csv|tsv>
-x, --extended show extended information
--csv-separator=<option> [default: ,] separator for CSV output (only relevant for CSV output)
<options: ,|;>
--no-header hide table header
--no-relative-dates show dates in absolute format, not relative (only relevant for txt output)
--no-truncate do not truncate output (only relevant for txt output)
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Get all available dependencies
Update the dependencies of an app
USAGE
$ mw app dependency update [INSTALLATION-ID] --set <value>... [--token <value>] [-q] [--update-policy
none|inheritedFromApp|patchLevel|all]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
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>
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
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.
Get all available versions of a particular dependency
USAGE
$ mw app dependency versions SYSTEMSOFTWARE -o txt|json|yaml|csv|tsv [--token <value>] [-x] [--no-header] [--no-truncate]
[--no-relative-dates] [--csv-separator ,|;]
ARGUMENTS
SYSTEMSOFTWARE name of the systemsoftware for which to list versions
FLAGS
-o, --output=<option> (required) [default: txt] output in a more machine friendly format
<options: txt|json|yaml|csv|tsv>
-x, --extended show extended information
--csv-separator=<option> [default: ,] separator for CSV output (only relevant for CSV output)
<options: ,|;>
--no-header hide table header
--no-relative-dates show dates in absolute format, not relative (only relevant for txt output)
--no-truncate do not truncate output (only relevant for txt output)
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Get all available versions of a particular dependency
Download the filesystem of an app within a project to your local machine
USAGE
$ mw app download [INSTALLATION-ID] --target <value> [--token <value>] [-q] [--ssh-user <value>]
[--ssh-identity-file <value>] [--exclude <value>...] [--dry-run] [--delete] [--remote-sub-directory <value>]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary
--delete delete local files that are not present on the server
--dry-run do not actually download the app installation
--exclude=<value>... [default: ] exclude files matching the given pattern
--remote-sub-directory=<value> specify a sub-directory within the app installation to download
--target=<value> (required) target directory to download the app installation to
SSH CONNECTION FLAGS
--ssh-identity-file=<value> [env: MITTWALD_SSH_IDENTITY_FILE] the SSH identity file (private key) to use for public
key authentication.
--ssh-user=<value> [env: MITTWALD_SSH_USER] override the SSH user to connect with; if omitted, your own user
will be used
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Download the filesystem of an app within a project to your local machine
This command downloads the filesystem of an app installation to your local machine via rsync.
For this, rsync needs to be installed on your system.
This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
under the hood, and will respect your SSH configuration in ~/.ssh/config.
An exception to this is the 'User' configuration, which will be overridden by this command to either your
authenticated mStudio user or the user specified with the --ssh-user flag.
See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
This command will also look for a file named .mw-rsync-filter in the current directory and use it as a filter file for
rsync. Have a look at https://manpages.ubuntu.com/manpages/noble/en/man1/rsync.1.html#filter%20rules for more
information on how to write filter rules.
EXAMPLES
Download entire app to current working directory
$ mw app download --target .
Download only shared dir from a deployer-managed app
$ mw app download --remote-sub-directory=shared --target .
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.
--remote-sub-directory=<value> specify a sub-directory within the app installation to download
This is particularly useful when you only want to download a specific sub-directory of the app installation, for
example when you are using a deployment tool that manages the app installation directory itself, and you only want
to download exempt files, like environment specific configuration files or user data. For example, if you want to
download from "/html/my-app-XXXXX/config", set "--remote-sub-directory=config".
--ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
authenticate the connection to the server.
You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
Execute a command in an app installation via SSH non-interactively.
USAGE
$ mw app exec COMMAND [--token <value>] [--ssh-user <value>] [--ssh-identity-file <value>] [-i <value>] [-w
<value>] [-e <value>...] [-q]
ARGUMENTS
COMMAND Command to execute in the app installation
FLAGS
-e, --env=<value>... environment variables to set for the command (format: KEY=VALUE)
-i, --installation-id=<value> ID or short ID of an app installation; this flag is optional if a default app
installation is set in the context
-q, --quiet disable informational output, only show command results
-w, --workdir=<value> working directory where the command will be executed
SSH CONNECTION FLAGS
--ssh-identity-file=<value> [env: MITTWALD_SSH_IDENTITY_FILE] the SSH identity file (private key) to use for public
key authentication.
--ssh-user=<value> [env: MITTWALD_SSH_USER] override the SSH user to connect with; if omitted, your own user
will be used
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Execute a command in an app installation via SSH non-interactively.
This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
under the hood, and will respect your SSH configuration in ~/.ssh/config.
An exception to this is the 'User' configuration, which will be overridden by this command to either your
authenticated mStudio user or the user specified with the --ssh-user flag.
See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
FLAG DESCRIPTIONS
-i, --installation-id=<value>
ID or short ID of an app installation; this flag is optional if a default app installation is set in the context
May contain a short ID or a full ID of an app installation; you can also use the "mw context set
--installation-id=<VALUE>" command to persistently set a default app installation for all commands that accept this
flag.
--ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
authenticate the connection to the server.
You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
Get details about an app installation
USAGE
$ mw app get [INSTALLATION-ID] [--token <value>] [-o txt|json]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-o, --output=<option> [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>
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Get details about an app installation
Creates new Contao installation.
USAGE
$ mw app install contao --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-firstname
<value>] [--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--admin-lastname <value>]
[--site-title <value>] [-w] [--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-firstname=<value> first name of your administrator user.
--admin-lastname=<value> Lastname of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your Contao installation with; needs to be created
separately.
--install-path=<value> the installation path of your Contao application
--site-title=<value> site title for your Contao installation.
--version=<value> (required) [default: latest] version of Contao to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new Contao 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the Contao installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-firstname=<value> first name of your administrator user.
The first name that will be used for the first administrator user that is created during the Contao installation.
If unspecified, the first name of your mStudio user will be used. This value can be changed after the installation
is finished.
--admin-lastname=<value> Lastname of your administrator user.
The last name that will be used for the first administrator user that is created during the Contao installation.
If unspecified, the last name of your mStudio user will be used. This value can be changed after the installation is
finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the Contao installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the Contao installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your Contao installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the Contao configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your Contao
installation.
--install-path=<value> the installation path of your Contao application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your Contao installation.
The site title for this Contao installation. It is also the title shown in the app overview in the mStudio and the
CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of Contao to be installed.
Specify the version in which your Contao will be installed.
If unspecified, the Contao will be installed in the latest available version.
Creates new Joomla! installation.
USAGE
$ mw app install joomla --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-user <value>]
[--admin-email <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title
<value>] [-w] [--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-firstname=<value> first name of your administrator user.
--admin-lastname=<value> Lastname of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your Joomla! installation with; needs to be created
separately.
--install-path=<value> the installation path of your Joomla! application
--site-title=<value> site title for your Joomla! installation.
--version=<value> (required) [default: latest] version of Joomla! to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new Joomla! 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the Joomla! installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-firstname=<value> first name of your administrator user.
The first name that will be used for the first administrator user that is created during the Joomla! installation.
If unspecified, the first name of your mStudio user will be used. This value can be changed after the installation
is finished.
--admin-lastname=<value> Lastname of your administrator user.
The last name that will be used for the first administrator user that is created during the Joomla! installation.
If unspecified, the last name of your mStudio user will be used. This value can be changed after the installation is
finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the Joomla! installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the Joomla! installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your Joomla! installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the Joomla! configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your Joomla!
installation.
--install-path=<value> the installation path of your Joomla! application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your Joomla! installation.
The site title for this Joomla! installation. It is also the title shown in the app overview in the mStudio and the
CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of Joomla! to be installed.
Specify the version in which your Joomla! will be installed.
If unspecified, the Joomla! will be installed in the latest available version.
Creates new Matomo installation.
USAGE
$ mw app install matomo --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-user <value>]
[--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--wait-timeout <value>] [--install-path
<value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your Matomo installation with; needs to be created separately.
--install-path=<value> the installation path of your Matomo application
--site-title=<value> site title for your Matomo installation.
--version=<value> (required) [default: latest] version of Matomo to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new Matomo 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the Matomo installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the Matomo installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the Matomo installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your Matomo installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the Matomo configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your Matomo
installation.
--install-path=<value> the installation path of your Matomo application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your Matomo installation.
The site title for this Matomo installation. It is also the title shown in the app overview in the mStudio and the
CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of Matomo to be installed.
Specify the version in which your Matomo will be installed.
If unspecified, the Matomo will be installed in the latest available version.
Creates new Nextcloud installation.
USAGE
$ mw app install nextcloud --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-user <value>]
[--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--wait-timeout <value>] [--install-path
<value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your Nextcloud installation with; needs to be created
separately.
--install-path=<value> the installation path of your Nextcloud application
--site-title=<value> site title for your Nextcloud installation.
--version=<value> (required) [default: latest] version of Nextcloud to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new Nextcloud 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the Nextcloud installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the Nextcloud installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the Nextcloud installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your Nextcloud installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the Nextcloud configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your Nextcloud
installation.
--install-path=<value> the installation path of your Nextcloud application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your Nextcloud installation.
The site title for this Nextcloud installation. It is also the title shown in the app overview in the mStudio and
the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of Nextcloud to be installed.
Specify the version in which your Nextcloud will be installed.
If unspecified, the Nextcloud will be installed in the latest available version.
Creates new Shopware 5 installation.
USAGE
$ mw app install shopware5 --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-user <value>]
[--admin-email <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title
<value>] [--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--wait-timeout <value>]
[--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-firstname=<value> first name of your administrator user.
--admin-lastname=<value> Lastname of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your Shopware 5 installation with; needs to be created
separately.
--install-path=<value> the installation path of your Shopware 5 application
--shop-currency=<value> Currency your Shopware 5 will be working with.
--shop-email=<value> email address your Shopware 5 will be working with.
--shop-lang=<value> language your Shopware 5 will be working with.
--site-title=<value> site title for your Shopware 5 installation.
--version=<value> (required) [default: latest] version of Shopware 5 to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new Shopware 5 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the Shopware 5 installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-firstname=<value> first name of your administrator user.
The first name that will be used for the first administrator user that is created during the Shopware 5
installation.
If unspecified, the first name of your mStudio user will be used. This value can be changed after the installation
is finished.
--admin-lastname=<value> Lastname of your administrator user.
The last name that will be used for the first administrator user that is created during the Shopware 5 installation.
If unspecified, the last name of your mStudio user will be used. This value can be changed after the installation is
finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the Shopware 5 installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the Shopware 5 installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your Shopware 5 installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the Shopware 5 configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your Shopware
5 installation.
--install-path=<value> the installation path of your Shopware 5 application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--shop-currency=<value> Currency your Shopware 5 will be working with.
The default currency your Shopware 5 shop communicates prices and calculates transactions with.
If unspecified, this will default to EUR(€). The currency can be changed after the installation is finished.
--shop-email=<value> email address your Shopware 5 will be working with.
The email address your Shopware 5 installation will be using for correspondence with end users.
If unspecified, your mStudio account email will be used. This email address can be changed after the installation is
finished.
--shop-lang=<value> language your Shopware 5 will be working with.
The default language your Shopware 5 installation will be using. The front- and back end will be displayed using the
given language.
If unspecified, this will default to German (de_DE). The language can be changed after the installation is finished.
--site-title=<value> site title for your Shopware 5 installation.
The site title for this Shopware 5 installation. It is also the title shown in the app overview in the mStudio and
the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of Shopware 5 to be installed.
Specify the version in which your Shopware 5 will be installed.
If unspecified, the Shopware 5 will be installed in the latest available version.
Creates new Shopware 6 installation.
USAGE
$ mw app install shopware6 --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-user <value>]
[--admin-email <value>] [--admin-pass <value>] [--admin-firstname <value>] [--admin-lastname <value>] [--site-title
<value>] [--shop-email <value>] [--shop-lang <value>] [--shop-currency <value>] [-w] [--wait-timeout <value>]
[--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-firstname=<value> first name of your administrator user.
--admin-lastname=<value> Lastname of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your Shopware 6 installation with; needs to be created
separately.
--install-path=<value> the installation path of your Shopware 6 application
--shop-currency=<value> Currency your Shopware 6 will be working with.
--shop-email=<value> email address your Shopware 6 will be working with.
--shop-lang=<value> language your Shopware 6 will be working with.
--site-title=<value> site title for your Shopware 6 installation.
--version=<value> (required) [default: latest] version of Shopware 6 to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new Shopware 6 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the Shopware 6 installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-firstname=<value> first name of your administrator user.
The first name that will be used for the first administrator user that is created during the Shopware 6
installation.
If unspecified, the first name of your mStudio user will be used. This value can be changed after the installation
is finished.
--admin-lastname=<value> Lastname of your administrator user.
The last name that will be used for the first administrator user that is created during the Shopware 6 installation.
If unspecified, the last name of your mStudio user will be used. This value can be changed after the installation is
finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the Shopware 6 installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the Shopware 6 installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your Shopware 6 installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the Shopware 6 configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your Shopware
6 installation.
--install-path=<value> the installation path of your Shopware 6 application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--shop-currency=<value> Currency your Shopware 6 will be working with.
The default currency your Shopware 6 shop communicates prices and calculates transactions with.
If unspecified, this will default to EUR(€). The currency can be changed after the installation is finished.
--shop-email=<value> email address your Shopware 6 will be working with.
The email address your Shopware 6 installation will be using for correspondence with end users.
If unspecified, your mStudio account email will be used. This email address can be changed after the installation is
finished.
--shop-lang=<value> language your Shopware 6 will be working with.
The default language your Shopware 6 installation will be using. The front- and back end will be displayed using the
given language.
If unspecified, this will default to German (de_DE). The language can be changed after the installation is finished.
--site-title=<value> site title for your Shopware 6 installation.
The site title for this Shopware 6 installation. It is also the title shown in the app overview in the mStudio and
the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of Shopware 6 to be installed.
Specify the version in which your Shopware 6 will be installed.
If unspecified, the Shopware 6 will be installed in the latest available version.
Creates new TYPO3 installation.
USAGE
$ mw app install typo3 --version <value> --install-mode composer|symlink [--token <value>] [-p <value>] [-q] [--host
<value>] [--admin-user <value>] [--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w]
[--wait-timeout <value>] [--install-path <value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your TYPO3 installation with; needs to be created separately.
--install-mode=<option> (required) [default: composer] The installation mode your TYPO3 will be installed with.
<options: composer|symlink>
--install-path=<value> the installation path of your TYPO3 application
--site-title=<value> site title for your TYPO3 installation.
--version=<value> (required) [default: latest] version of TYPO3 to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Creates new TYPO3 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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the TYPO3 installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the TYPO3 installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the TYPO3 installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your TYPO3 installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the TYPO3 configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your TYPO3
installation.
--install-mode=composer|symlink The installation mode your TYPO3 will be installed with.
TYPO3 can be installed in one of two different ways: either as a composer project or in a more manual fashion using
the source directory and the TYPO3 console install wizard.
If unspecified, this will default to a composer-based installation. This can not be changed later.
--install-path=<value> the installation path of your TYPO3 application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your TYPO3 installation.
The site title for this TYPO3 installation. It is also the title shown in the app overview in the mStudio and the
CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of TYPO3 to be installed.
Specify the version in which your TYPO3 will be installed.
If unspecified, the TYPO3 will be installed in the latest available version.
Creates new WordPress installation.
USAGE
$ mw app install wordpress --version <value> [--token <value>] [-p <value>] [-q] [--host <value>] [--admin-user <value>]
[--admin-email <value>] [--admin-pass <value>] [--site-title <value>] [-w] [--wait-timeout <value>] [--install-path
<value>] [-c]
FLAGS
-c, --update-context update the CLI context to use the newly created app installation
-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 resource to be ready.
--admin-email=<value> email address of your administrator user.
--admin-pass=<value> password of your administrator user.
--admin-user=<value> Username for your administrator user.
--host=<value> host to initially configure your WordPress installation with; needs to be created
separately.
--install-path=<value> the installation path of your WordPress application
--site-title=<value> site title for your WordPress installation.
--version=<value> (required) [default: latest] version of WordPress to be installed.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
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.
--admin-email=<value> email address of your administrator user.
email address that will be used for the first administrator user that is created during the WordPress installation.
If unspecified, email address of your mStudio account will be used. This email address can be changed after the
installation is finished.
--admin-pass=<value> password of your administrator user.
The password that will be used for the first administrator user that is created during the WordPress installation.
If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
the installation is finished
--admin-user=<value> Username for your administrator user.
Username of the first administrator user which will be created during the WordPress installation.
If unspecified, an adequate username will be generated.
After the installation is finished, the username can be changed and additional administrator users can be created.
--host=<value> host to initially configure your WordPress installation with; needs to be created separately.
Specify a host which will be used during the installation and as an initial host for the WordPress configuration.
If unspecified, the default host for the given project will be used.
This does not change the target of the used host and can be changed later by configuring the host and your WordPress
installation.
--install-path=<value> the installation path of your WordPress application
This is the path where your application will be installed. If omitted, this will default to an
automatically-generated path.
--site-title=<value> site title for your WordPress installation.
The site title for this WordPress installation. It is also the title shown in the app overview in the mStudio and
the CLI.
If unspecified, the application name and the given project ID will be used. The title can be changed after the
installation is finished
--version=<value> version of WordPress to be installed.
Specify the version in which your WordPress will be installed.
If unspecified, the WordPress will be installed in the latest available version.
List installed apps in a project.
USAGE
$ mw app list -o txt|json|yaml|csv|tsv [--token <value>] [-x] [--no-header] [--no-truncate]
[--no-relative-dates] [--csv-separator ,|;] [-p <value>]
FLAGS
-o, --output=<option> (required) [default: txt] output in a more machine friendly format
<options: txt|json|yaml|csv|tsv>
-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 extended information
--csv-separator=<option> [default: ,] separator for CSV output (only relevant for CSV output)
<options: ,|;>
--no-header hide table header
--no-relative-dates show dates in absolute format, not relative (only relevant for txt output)
--no-truncate do not truncate output (only relevant for txt output)
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
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.
List upgrade candidates for an app installation.
USAGE
$ mw app list-upgrade-candidates [INSTALLATION-ID] -o txt|json|yaml|csv|tsv [--token <value>] [-x] [--no-header]
[--no-truncate] [--no-relative-dates] [--csv-separator ,|;]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-o, --output=<option> (required) [default: txt] output in a more machine friendly format
<options: txt|json|yaml|csv|tsv>
-x, --extended show extended information
--csv-separator=<option> [default: ,] separator for CSV output (only relevant for CSV output)
<options: ,|;>
--no-header hide table header
--no-relative-dates show dates in absolute format, not relative (only relevant for txt output)
--no-truncate do not truncate output (only relevant for txt output)
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
List upgrade candidates for an app installation.
Open an app installation in the browser.
USAGE
$ mw app open [INSTALLATION-ID] [--token <value>] [--backend]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
--backend open the backend of the app installation
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Open an app installation in the browser.
This command opens an app installation in the browser. For this to work, there needs to be at least one virtual host
linked to the app installation.
FLAG DESCRIPTIONS
--backend open the backend of the app installation
If this flag is set, the backend of the app installation will be opened instead of the frontend. This flag is only
available for some types of apps (like PHP and Node.js).
Connect to an app via SSH
USAGE
$ mw app ssh [INSTALLATION-ID] [--token <value>] [--ssh-user <value>] [--ssh-identity-file <value>] [--cd]
[--info] [--test] [--generate-intellij-config]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
--[no-]cd change to installation path after connecting
--generate-intellij-config generate IntelliJ IDEA SSH and deployment configuration files
--info only print connection information, without actually connecting
--test test connection and exit
SSH CONNECTION FLAGS
--ssh-identity-file=<value> [env: MITTWALD_SSH_IDENTITY_FILE] the SSH identity file (private key) to use for public
key authentication.
--ssh-user=<value> [env: MITTWALD_SSH_USER] override the SSH user to connect with; if omitted, your own user
will be used
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Connect to an app via SSH
Establishes an interactive SSH connection to an app installation.
This command is a wrapper around your systems SSH client, and will respect your SSH configuration in ~/.ssh/config.
An exception to this is the 'User' configuration, which will be overridden by this command to either your
authenticated mStudio user or the user specified with the --ssh-user flag.
See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
FLAG DESCRIPTIONS
--ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
authenticate the connection to the server.
You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
Uninstall an app
USAGE
$ mw app uninstall [INSTALLATION-ID] [--token <value>] [-q] [-f]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation 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
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Uninstall an app
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.
Update properties of an app installation (use 'upgrade' to update the app version)
USAGE
$ mw app update [INSTALLATION-ID] [--token <value>] [-q] [--description <value>] [--entrypoint <value>]
[--document-root <value>]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary
--description=<value> update the description of the app installation
--document-root=<value> update the document root of the app installation
--entrypoint=<value> update the entrypoint of the app installation (Python and Node.js only)
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
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.
--description=<value> update the description of the app installation
This flag updates the description of the app installation. If omitted, the description will not be changed.
--document-root=<value> update the document root of the app installation
Updates the document root of the app installation. If omitted, the document root will not be changed. Note that not
all apps support this field.
--entrypoint=<value> update the entrypoint of the app installation (Python and Node.js only)
Updates the entrypoint of the app installation. If omitted, the entrypoint will not be changed. Note that this field
is only available for some types of apps (like Python and Node.js).
Upgrade app installation to target version
USAGE
$ mw app upgrade [INSTALLATION-ID] [--token <value>] [--target-version <value>] [-f] [-p <value>] [-q] [-w]
[--wait-timeout <value>]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-f, --force do not ask for confirmation.
-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 resource to be ready.
--target-version=<value> target version to upgrade app to; if omitted, target version will be prompted
interactively. May also be a semantic versioning range, e.g. ^1.0.0. If set to 'latest',
the latest available version will be used.
--wait-timeout=<value> [default: 600s] the duration to wait for the resource to be ready (common units like
'ms', 's', 'm' are accepted).
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Upgrade app installation to target version
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.
Upload the filesystem of an app to a project
USAGE
$ mw app upload [INSTALLATION-ID] --source <value> [--token <value>] [-q] [--ssh-user <value>]
[--ssh-identity-file <value>] [--exclude <value>...] [--dry-run] [--delete] [--remote-sub-directory <value>]
ARGUMENTS
[INSTALLATION-ID] ID or short ID of an app installation; this argument is optional if a default app installation is
set in the context.
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary
--delete delete remote files that are not present locally
--dry-run do not actually upload the app installation
--exclude=<value>... [default: ] exclude files matching the given pattern
--remote-sub-directory=<value> specify a sub-directory within the app installation to upload
--source=<value> (required) source directory from which to upload the app installation
SSH CONNECTION FLAGS
--ssh-identity-file=<value> [env: MITTWALD_SSH_IDENTITY_FILE] the SSH identity file (private key) to use for public
key authentication.
--ssh-user=<value> [env: MITTWALD_SSH_USER] override the SSH user to connect with; if omitted, your own user
will be used
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
Upload the filesystem of an app to a project
Upload the filesystem of an app from your local machine to a project.
For this, rsync needs to be installed on your system.
CAUTION: This is a potentially destructive operation. It will overwrite files on the server with the files from your
local machine. This is NOT a turnkey deployment solution. It is intended for development purposes only.
This command relies on connecting to your hosting environment via SSH. For this, it will use your systems SSH client
under the hood, and will respect your SSH configuration in ~/.ssh/config.
An exception to this is the 'User' configuration, which will be overridden by this command to either your
authenticated mStudio user or the user specified with the --ssh-user flag.
See https://linux.die.net/man/5/ssh_config for a reference on the configuration file.
This command will also look for a file named .mw-rsync-filter in the current directory and use it as a filter file for
rsync. Have a look at https://manpages.ubuntu.com/manpages/noble/en/man1/rsync.1.html#filter%20rules for more
information on how to write filter rules.
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.
--remote-sub-directory=<value> specify a sub-directory within the app installation to upload
This is particularly useful when you only want to upload a specific sub-directory of the app installation, for
example when you are using a deployment tool that manages the app installation directory itself, and you only want
to upload exempt files, like environment specific configuration files or user data. For example, if you want to
upload to "/html/my-app-XXXXX/config", set "--remote-sub-directory=config".
--ssh-identity-file=<value> the SSH identity file (private key) to use for public key authentication.
The SSH identity file to use for the connection. This file should contain an SSH private key and will be used to
authenticate the connection to the server.
You can also set this value by setting the MITTWALD_SSH_IDENTITY_FILE environment variable.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
This command shows information about a specific app version. It is useful to get information about the user inputs that are required for the version to be deployed successfully.
USAGE
$ mw app version-info APP VERSION [--token <value>]
ARGUMENTS
APP name of the app
VERSION version of the app
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
This command shows information about a specific app version. It is useful to get information about the user inputs
that are required for the version to be deployed successfully.
show information about specific app versions
List supported Apps and Versions
USAGE
$ mw app versions [APP] [--token <value>]
ARGUMENTS
[APP] name of specific app to get versions for
AUTHENTICATION FLAGS
--token=<value> API token to use for authentication (overrides environment and config file). NOTE: watch out that
tokens passed via this flag might be logged in your shell history.
DESCRIPTION
List supported Apps and Versions