================
CODE SNIPPETS
================
TITLE: Mittwald CLI App Get Command Documentation
DESCRIPTION: Provides detailed information on how to use the `mw app get` command to retrieve app installation details. It outlines the command's usage, arguments, available flags for output formatting, and authentication options.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_10

LANGUAGE: APIDOC
CODE:
```
mw app get [INSTALLATION-ID]

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
```

--------------------------------

TITLE: Shopware 5 Installation Configuration Options
DESCRIPTION: Provides details on the command-line arguments for configuring a Shopware 5 installation. These options cover essential settings like currency, email, language, site title, and the specific version of Shopware to install.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_16

LANGUAGE: APIDOC
CODE:
```
APIDOC:
  --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.
```

--------------------------------

TITLE: Install WordPress
DESCRIPTION: Creates a new WordPress installation with various configuration options. Supports specifying version, project, authentication token, and WordPress admin details.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_20

LANGUAGE: bash
CODE:
```
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>]
```

--------------------------------

TITLE: Install Shopware 5
DESCRIPTION: Creates a new Shopware 5 installation with various configuration options. Requires specifying the Shopware version.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_15

LANGUAGE: APIDOC
CODE:
```
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>]

--version=<value> (required) [default: latest]: Version of Shopware 5 to be installed.
-p, --project-id=<value>: ID or short ID of a project; optional if a default project is set.
-q, --quiet: Suppress process output and only display a machine-readable summary.
--host=<value>: Host to initially configure your Shopware 5 installation with; needs to be created separately.
--admin-user=<value>: Username for your administrator user. If unspecified, an adequate username will be generated.
--admin-email=<value>: Email address of your administrator user. If unspecified, the email of your mStudio account will be used.
--admin-pass=<value>: Password of your administrator user. If unspecified, a random secure password will be generated.
--admin-firstname=<value>: First name of your administrator user. If unspecified, the first name of your mStudio user will be used.
--admin-lastname=<value>: Last name of your administrator user. If unspecified, the last name of your mStudio user will be used.
--site-title=<value>: Site title for your Shopware 5 installation.
--shop-email=<value>: Email address your Shopware 5 will be working with.
--shop-lang=<value>: Language your Shopware 5 will be working with.
--shop-currency=<value>: Currency your Shopware 5 will be working with.
-w, --wait: Wait for the resource to be ready.
--wait-timeout=<value> [default: 600s]: Duration to wait for the resource to be ready.
--token=<value>: API token to use for authentication (overrides environment and config file).
```

--------------------------------

TITLE: Mittwald CLI: Install TYPO3
DESCRIPTION: Installs a new TYPO3 application using the Mittwald CLI. Supports various installation modes, versions, and configuration options for the TYPO3 administrator and site.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_19

LANGUAGE: bash
CODE:
```
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>]
```

--------------------------------

TITLE: Create Python Site Installation
DESCRIPTION: Creates a new custom Python site installation. Allows specifying project ID, entrypoint, site title, and wait behavior. Supports quiet output and authentication via token.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_4

LANGUAGE: bash
CODE:
```
mw app create python [--token <value>] [-p <value>] [-q] [--site-title <value>] [--entrypoint <value>] [-w]
    [--wait-timeout <value>]
```

--------------------------------

TITLE: Install Extension
DESCRIPTION: Installs a specified extension into a project or organization. Supports optional authentication tokens and quiet mode for non-interactive use. Allows specifying organization or project IDs for targeted installation.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/extension.md#_snippet_0

LANGUAGE: APIDOC
CODE:
```
mw extension install EXTENSION-ID

Install an extension in a project or organization

USAGE
  $ mw extension install EXTENSION-ID [--token <value>] [-q] [--org-id <value>] [--project-id <value>] [--consent]

ARGUMENTS
  EXTENSION-ID  the ID of the extension to install

FLAGS
  -q, --quiet               suppress process output and only display a machine-readable summary
      --consent             consent to the extension having access to the requested scopes
      --org-id=<value>      the ID of the organization to install the extension in
      --project-id=<value>  the ID of the project to install the extension in

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
  Install an extension in a project or 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.
```

--------------------------------

TITLE: Mittwald CLI: Open App Installation
DESCRIPTION: Opens a specific application installation in the web browser. This functionality requires that at least one virtual host is associated with the app installation. The command accepts an optional installation ID, defaulting to a contextually set installation.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_23

LANGUAGE: APIDOC
CODE:
```
mw app open [INSTALLATION-ID]

Open an app installation in the browser.

USAGE
  $ mw app open [INSTALLATION-ID] [--token <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.

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.
```

--------------------------------

TITLE: Command with Project Context Flags
DESCRIPTION: An example of a command extending `ExtendedBaseCommand` and incorporating project-specific flags, likely for context management.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/CONTRIBUTING.md#_snippet_4

LANGUAGE: ts
CODE:
```
import { projectFlags } from "./flags";
import { ExtendedBaseCommand } from "./ExtendedBaseCommand";

class MyCommand extends ExtendedBaseCommand<typeof MyCommand> {
  static flags = {
    ...projectFlags,
  };

  async run(): Promise<void> {
    // Command logic here
  }
}

```

--------------------------------

TITLE: Install Shopware 6
DESCRIPTION: Creates a new Shopware 6 installation with various configuration options. Requires specifying the Shopware version. Optional parameters include project ID, quiet mode, host configuration, administrator details, site title, shop language, currency, and wait settings.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_17

LANGUAGE: bash
CODE:
```
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>]
```

--------------------------------

TITLE: Install Nextcloud
DESCRIPTION: Creates a new Nextcloud installation with various configuration options. Supports specifying project ID, quiet mode, waiting for resource readiness, and detailed Nextcloud administrator and site configuration.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_14

LANGUAGE: bash
CODE:
```
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>]
```

--------------------------------

TITLE: Create Custom PHP Installation
DESCRIPTION: Creates a new custom PHP installation for a project. Requires specifying the document root. Optional flags allow for quiet operation, waiting for resource readiness, setting a site title, and specifying a project ID or authentication token.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_2

LANGUAGE: APIDOC
CODE:
```
mw app create php --document-root <value> [--token <value>] [-p <value>] [-q] [--site-title <value>] [-w] [--wait-timeout <value>]

Flags:
  -p, --project-id=<value>     ID or short ID of a project; optional if a default project is set.
  -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) Document root from which custom PHP will be served (relative to installation path).
  --site-title=<value>         Site title for the custom PHP installation.
  --wait-timeout=<value>       [default: 600s] Duration to wait for the resource to be ready.

Authentication Flags:
  --token=<value>              API token for authentication (overrides environment and config file). Be cautious as tokens may be logged in shell history.
```

--------------------------------

TITLE: Shopware 6 Installation Configuration Options
DESCRIPTION: Provides details on various configuration flags for setting up a Shopware 6 installation via the Mittwald CLI. These options control essential shop settings like currency, email, language, site title, and the Shopware version.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_18

LANGUAGE: bash
CODE:
```
--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.
```

--------------------------------

TITLE: Install mw CLI using Homebrew
DESCRIPTION: Installs the Mittwald CLI on macOS using Homebrew. This is the recommended installation method for macOS users.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/README.md#_snippet_0

LANGUAGE: shell
CODE:
```
brew tap mittwald/cli
brew install mw
```

--------------------------------

TITLE: Install Matomo Application
DESCRIPTION: Creates a new Matomo installation using the Mittwald CLI. Supports specifying the Matomo version, project ID, host, administrator credentials, site title, and waiting for readiness. Authentication can be handled via an API token.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_13

LANGUAGE: APIDOC
CODE:
```
mw app install matomo

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>]

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 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.
      --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.

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.

  --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.
```

--------------------------------

TITLE: Install Joomla with Mittwald CLI
DESCRIPTION: Creates a new Joomla! installation with various configuration options. This command allows specifying the Joomla version, project ID, administrator details, host, and site title. It also supports quiet mode and waiting for the installation to complete.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_12

LANGUAGE: bash
CODE:
```
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>]

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 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.
      --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.

  --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.

```

--------------------------------

TITLE: Mittwald CLI Autocomplete Installation
DESCRIPTION: Provides instructions for installing shell autocompletion for the Mittwald CLI. Supports zsh, bash, and powershell. Includes an option to refresh the autocomplete cache.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/autocomplete.md#_snippet_0

LANGUAGE: APIDOC
CODE:
```
mw autocomplete [SHELL]

  Display autocomplete installation instructions.

  USAGE
    $ mw autocomplete [SHELL] [-r]

  ARGUMENTS
    SHELL  (zsh|bash|powershell) Shell type

  FLAGS
    -r, --refresh-cache  Refresh cache (ignores displaying instructions)

  DESCRIPTION
    Display autocomplete installation instructions.

  EXAMPLES
    $ mw autocomplete

    $ mw autocomplete bash

    $ mw autocomplete zsh

    $ mw autocomplete powershell

    $ mw autocomplete --refresh-cache

  See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.34/src/commands/autocomplete/index.ts)
```

--------------------------------

TITLE: Create PHP Worker Installation
DESCRIPTION: Creates a new PHP worker installation. Allows specifying project ID, entrypoint, site title, and wait behavior. Supports quiet output and authentication via token.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_3

LANGUAGE: bash
CODE:
```
mw app create php-worker [--token <value>] [-p <value>] [-q] [--entrypoint <value>] [--site-title <value>] [-w]
    [--wait-timeout <value>]
```

--------------------------------

TITLE: Install mw CLI using NPM
DESCRIPTION: Installs the Mittwald CLI globally on any operating system using Node.js and NPM. Note that stability may depend on the Node.js runtime, and automatic upgrades will not work.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/README.md#_snippet_1

LANGUAGE: javascript
CODE:
```
npm install -g @mittwald/cli
```

--------------------------------

TITLE: Mittwald CLI: Install Contao
DESCRIPTION: Installs a new Contao application using the Mittwald CLI. This command allows for detailed configuration of the Contao installation, including administrative user credentials, host settings, and site title. It supports specifying the Contao version and project ID, with options for quiet output and waiting for resource readiness.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_11

LANGUAGE: APIDOC
CODE:
```
mw app install contao

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>]

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.
    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.
  -w, --wait
    wait for the resource to be ready.
  --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.
  --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>
    (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.
```

--------------------------------

TITLE: Initialize DDEV Project with Mittwald
DESCRIPTION: Initializes a new DDEV configuration for an existing Mittwald app installation in the current directory. It creates a `.ddev` configuration file, initializes the DDEV project, installs the Mittwald DDEV addon, and adds SSH credentials. This command can be re-run to update the DDEV configuration.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/ddev.md#_snippet_0

LANGUAGE: APIDOC
CODE:
```
mw ddev init [INSTALLATION-ID]

Initialize a new ddev project in the current directory.

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
  --database-id=<value>                      ID of the application database
  --override-type=<option>                   [default: auto] Override the type of the generated DDEV configuration
                                             <options: backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wordpress|auto>
  --project-name=<value>                     DDEV project name
  --without-database                         Create a DDEV project without a database
  --override-mittwald-plugin=<value>         [default: mittwald/ddev] override the mittwald plugin
  --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:
  Initialize a new ddev configuration for an existing app installation in the current directory.

  This command initializes a new ddev configuration for an existing app installation in the current directory.

  More precisely, this command will do the following:

  1. Create a new ddev configuration file in the .ddev directory, appropriate for the reference app installation
  2. Initialize a new ddev project with the given configuration
  3. Install the official mittwald DDEV addon
  4. Add SSH credentials to the DDEV project

  This command can be run repeatedly to update the DDEV configuration of the project.

  Please note that this command requires DDEV to be installed on your system.

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.

  --database-id=<value>  ID of the application database

    The ID of the database to use for the DDEV project; if set to 'auto', the command will use the database linked to the app installation.

    Setting a database ID (either automatically or manually) is required. To create a DDEV project without a database, set the --without-database flag.

  --override-mittwald-plugin=<value>  override the mittwald plugin

    This flag allows you to override the mittwald plugin that should be installed by default; this is useful for testing purposes

  --override-type=backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wordpress|auto

    Override the type of the generated DDEV configuration

    The type of the generated DDEV configuration; this can be any of the documented DDEV project types, or 'auto' (which is also the default) for automatic discovery.

    See https://ddev.readthedocs.io/en/latest/users/configuration/config/#type for more information

  --project-name=<value>  DDEV project name

    The name of the DDEV project

  --without-database  Create a DDEV project without a database

    Use this flag to create a DDEV project without a database; this is useful for projects that do not require a database.
```

--------------------------------

TITLE: Mittwald CLI: List App Upgrade Candidates
DESCRIPTION: Lists potential upgrades for a specific application installation. Similar to `mw app list`, it supports multiple output formats and options for extended information and date formatting. An installation ID can be provided, or it defaults to a contextually set installation.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_22

LANGUAGE: APIDOC
CODE:
```
mw app list-upgrade-candidates [INSTALLATION-ID]

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.
```

--------------------------------

TITLE: Create Static Application
DESCRIPTION: Creates a new custom static site installation. Requires specifying the document root and optionally allows setting a project ID, site title, and wait timeout. Authentication can be handled via an API token.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_5

LANGUAGE: bash
CODE:
```
mw app create static --document-root <value> [--token <value>] [-p <value>] [-q] [--site-title <value>] [-w] [--wait-timeout <value>]
```

--------------------------------

TITLE: List Installed Extensions
DESCRIPTION: Lists extensions that are currently installed within a specific organization or project. Offers multiple output formats and customization options similar to listing available extensions.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/extension.md#_snippet_2

LANGUAGE: APIDOC
CODE:
```
mw extension list-installed

List installed extensions in an organization or project.

USAGE
  $ mw extension list-installed -o txt|json|yaml|csv|tsv [--token <value>] [-x] [--no-header] [--no-truncate]
    [--no-relative-dates] [--csv-separator ,|;] [--org-id <value>] [--project-id <value>]

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)
      --org-id=<value>          the ID of the organization to install the extension in
      --project-id=<value>      the ID of the project to install the extension in

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 extensions in an organization or project.
```

--------------------------------

TITLE: Mittwald CLI Context API Documentation
DESCRIPTION: Provides comprehensive documentation for the Mittwald CLI context commands. This includes usage, flags, authentication options, and detailed descriptions for getting, resetting, and setting context parameters.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/context.md#_snippet_0

LANGUAGE: APIDOC
CODE:
```
mw context get:
  Description: Print an overview of currently set context parameters.
  Usage: mw context get [--token <value>] [-o txt|json]
  Flags:
    -o, --output=<option>: 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.
  Context Description: 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 reset:
  Description: Reset context values.
  Usage: mw context reset [--token <value>]
  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.
  Context Description: This command resets any values for common parameters that you've previously set with 'context set'.

mw context set:
  Description: Set context values for the current project, org or server.
  Usage: mw context set [--token <value>] [--project-id <value>] [--server-id <value>] [--org-id <value>] [--installation-id <value>] [--stack-id <value>]
  Flags:
    --installation-id=<value>: ID or short ID of an app installation
    --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
    --stack-id=<value>: ID of a container stack
  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.
  Context Description: 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.
```

--------------------------------

TITLE: Start Stopped Container
DESCRIPTION: Starts a container that is currently stopped. The `--quiet` flag can be used to suppress output and only show a machine-readable summary.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/container.md#_snippet_11

LANGUAGE: bash
CODE:
```
USAGE
  $ mw container start CONTAINER-ID [--token <value>] [-q] [-p <value>]

ARGUMENTS
  CONTAINER-ID  ID or short ID of the container to start

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

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
  -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.
```

--------------------------------

TITLE: Mittwald CLI: List Installed Apps
DESCRIPTION: Lists all installed applications within a specified project. Supports various output formats (txt, json, yaml, csv, tsv) and options for extended information, CSV separators, and header visibility. Authentication can be managed via an API token.

SOURCE: https://github.com/mittwald/cli/blob/v1.7.0/docs/app.md#_snippet_21

LANGUAGE: APIDOC
CODE:
```
mw app list

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.
```