================
CODE SNIPPETS
================
TITLE: Install Shopware 6 via Mittwald CLI
DESCRIPTION: Creates a new Shopware 6 installation using the Mittwald CLI. This command supports numerous flags to configure project details, administrator credentials, host settings, and installation preferences. It allows for detailed customization of the Shopware 6 setup process.

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

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

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

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.
                                 [default: false]
      --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.
      --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.

```

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

TITLE: Install Shopware 5
DESCRIPTION: Creates a new Shopware 5 installation via the Mittwald CLI. It supports various flags for configuring the installation, including version, admin user details, host, and site settings. Optional flags control output verbosity and waiting behavior.

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

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

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

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 Shopware 5 installation with; needs to be created
                                 separately.
      --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.

```

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

TITLE: Initialize DDEV Project with Mittwald CLI
DESCRIPTION: Initializes a new DDEV configuration for an existing Mittwald app installation in the current directory. It creates `.ddev` configuration files, installs the Mittwald DDEV addon, and adds SSH credentials. Requires DDEV to be installed.

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

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

Initialize a new ddev project in the current directory.

USAGE
  $ mw ddev init [INSTALLATION-ID] [--token <value>] [-q] [--override-type <backdrop|craftcms|django4|drupal6|drupal7|drupal|laravel|magento|magento2|php|python|shopware6|silverstripe|typo3|wordpress|auto>] [--without-database | --database-id <value>] [--project-name <value>] [--override-mittwald-plugin <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
      --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

DEVELOPMENT FLAGS
  --override-mittwald-plugin=<value>  [default: mittwald/ddev] override the mittwald plugin

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
  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: mw extension install: Install Extension
DESCRIPTION: Installs an extension into a project or organization. Requires an EXTENSION-ID and supports authentication via token. Optional flags allow for quiet operation, consent, and specifying organization or project IDs.

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

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

Install and manage extensions in your organisations and projects

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 Shopware 5 Installation Configuration
DESCRIPTION: These are command-line arguments for configuring a Shopware 5 installation using the Mittwald CLI. Each argument allows specifying a particular setting for the shop, such as currency, email, language, site title, and the Shopware version to install. Defaults are applied if arguments are not provided.

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

LANGUAGE: APIDOC
CODE:
```
Mittwald CLI Shopware 5 Installation Arguments:

--shop-currency=<value>
  Description: 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.
  Parameters:
    value: The currency code (e.g., USD, GBP).

--shop-email=<value>
  Description: 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.
  Parameters:
    value: A valid email address.

--shop-lang=<value>
  Description: 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.
  Parameters:
    value: The language code (e.g., en_GB, fr_FR).

--site-title=<value>
  Description: 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.
  Parameters:
    value: The desired site title string.

--version=<value>
  Description: 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.
  Parameters:
    value: The Shopware 5 version string (e.g., 5.7.0.0).
```

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

TITLE: mw app copy: Copy App Installation
DESCRIPTION: Copies an existing application installation within a project. This command requires a description for the new installation and optionally accepts an installation ID if not set in the context. It supports quiet mode for non-interactive use.

SOURCE: https://github.com/mittwald/cli/blob/v1.6.0/docs/app.md#_snippet_0

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

  Copies an app within a project

USAGE
  $ mw app copy [INSTALLATION-ID] --description <value> [--token <value>] [-q]

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

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

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

TITLE: Mittwald CLI: Get App Installation Details
DESCRIPTION: Retrieves detailed information about a specific app installation managed by the Mittwald CLI. It supports specifying the installation ID and customizing output format and authentication.

SOURCE: https://github.com/mittwald/cli/blob/v1.6.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: Install Joomla via Mittwald CLI
DESCRIPTION: Creates a new Joomla! installation using the Mittwald CLI. This command supports various flags for configuring the installation, including Joomla version, project ID, administrator credentials, and host settings. The host must be created separately before running this command.

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

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

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

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.

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.

    The specific version of Joomla! to install. Defaults to the latest available version if not specified.
```

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

TITLE: Install TYPO3 Application via Mittwald CLI
DESCRIPTION: This command creates a new TYPO3 installation. It supports various configuration options for installation mode, version, host, and administrator details. Dependencies include the Mittwald CLI tool and potentially pre-configured project contexts.

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

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

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

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

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

TITLE: Mittwald CLI Context Management Commands
DESCRIPTION: Provides commands to manage context parameters for the Mittwald CLI. This includes getting an overview of set parameters, resetting them, and setting specific values for project, organization, server, or installation IDs.

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

LANGUAGE: APIDOC
CODE:
```
Mittwald CLI Context Commands:

## `mw context get`

Print an overview of currently set context parameters.

USAGE
  $ mw context get [--token <value>] [-o txt|json]

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
  Print an overview of currently set context parameters

  The context allows you to persistently set values for common parameters, like --project-id or --server-id, so you
  don't have to specify them on every command.

## `mw context reset`

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.

DESCRIPTION
  Reset context values

  This command resets any values for common parameters that you've previously set with 'context set'.

## `mw context set`

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.

DESCRIPTION
  Set context values for the current project, org or server

  The context allows you to persistently set values for common parameters, like --project-id or --server-id, so you
  don't have to specify them on every command.
```

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

TITLE: Basic mw CLI Usage Example
DESCRIPTION: Demonstrates basic usage of the `mw` CLI, including checking the version and displaying help for a command.

SOURCE: https://github.com/mittwald/cli/blob/v1.6.0/README.md#_snippet_5

LANGUAGE: sh-session
CODE:
```
$ npm install -g @mittwald/cli
$ mw COMMAND
running command...
$ mw (--version)
@mittwald/cli/1.0.0 darwin-arm64 node-v18.11.0
$ mw --help [COMMAND]
```

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

TITLE: Detail Command Implementation Pattern
DESCRIPTION: Guidelines for implementing detail commands that display a single resource. It involves inheriting from `RenderBaseCommand` and using provided components for rendering.

SOURCE: https://github.com/mittwald/cli/blob/v1.6.0/CONTRIBUTING.md#_snippet_1

LANGUAGE: APIDOC
CODE:
```
RenderBaseCommand:
  Inherit from this base class for commands displaying a single resource.

  Core Method:
    render(): This method should return a React node that renders the resource.

  Rendering Components:
    <SingleResult>: Use this component to render individual attributes of the resource.
      - Add multiple instances to display different data sections.
    <RenderJson>: Use this component to render a JSON representation of the resource when the `--output` flag is set to `json`.
      - This component needs to be implemented within the `render` method.
```

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

TITLE: Install Nextcloud with Mittwald CLI
DESCRIPTION: This command creates a new Nextcloud installation. It supports various flags for configuration, including specifying the Nextcloud version, project ID, administrator details, host, and site title. Optional flags control output verbosity and waiting behavior.

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

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

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

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 Nextcloud installation with; needs to be created
                              separately.
      --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.

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

```

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

TITLE: Shopware Version Configuration
DESCRIPTION: Specifies the exact version of Shopware 6 to be installed. If omitted, the latest available version will be installed.

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

LANGUAGE: APIDOC
CODE:
```
--version=<value>
  Description: version of Shopware 6 to be installed.
  Details: Specify the version in which your Shopware 6 will be installed.
           If unspecified, the Shopware 6 will be installed in the latest available version.
  Parameters:
    value: The Shopware 6 version string (e.g., 6.4.19.1).
```

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

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

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

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

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

TITLE: CLI Command with Project Context Flags
DESCRIPTION: Demonstrates extending a base command class and incorporating project-specific flags for context management.

SOURCE: https://github.com/mittwald/cli/blob/v1.6.0/CONTRIBUTING.md#_snippet_3

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

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

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

TITLE: Create Custom PHP Installation
DESCRIPTION: Creates a new custom PHP installation using the `mw app create php` command. This command allows specifying the document root, site title, project ID, and other options like quiet mode or waiting for resource readiness. It also supports authentication via an API token.

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

LANGUAGE: shell
CODE:
```
USAGE
  $ 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; 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)
      --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.

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

```