================
CODE SNIPPETS
================
TITLE: Install TYPO3 via Mittwald CLI
DESCRIPTION: This command creates a new TYPO3 installation. It supports various configuration options for installation mode, version, administrator details, and host setup. The `--install-mode` flag is required and can be set to `composer` or `symlink`. The `--version` flag specifies the TYPO3 version, defaulting to the latest.

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

LANGUAGE: APIDOC
CODE:
```
Command: mw app install typo3

Description: Creates new TYPO3 installation.

Usage:
  $ mw app install typo3 --version <value> --install-mode composer|symlink [-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
    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 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=<option>  (required) [default: composer] The installation mode your TYPO3 will be installed with.
                               <options: composer|symlink>
    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>        (required) [default: latest] 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.

      --wait-timeout=<value>   [default: 600s] the duration to wait for the resource to be ready (common units like
                               'ms', 's', 'm' are accepted).
```

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

TITLE: Get App Installation Details
DESCRIPTION: Retrieves details about a specific app installation. Supports output formats like text, JSON, or YAML for machine-friendly processing.

SOURCE: https://github.com/mittwald/cli/blob/master/docs/app.md#_snippet_7

LANGUAGE: APIDOC
CODE:
```
USAGE
  $ mw app get [INSTALLATION-ID] -o txt|json|yaml

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>

DESCRIPTION
  Get details about an app installation
```

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

TITLE: Shopware 6 Installation CLI Arguments
DESCRIPTION: This section details the command-line arguments available for the Mittwald CLI when installing Shopware 6. These options configure essential aspects of the installation process, including contact email, default language, site title, and the specific Shopware version to be installed. Default values are provided where applicable, and most settings can be modified post-installation.

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

LANGUAGE: APIDOC
CODE:
```
Mittwald CLI Shopware 6 Installation Options:

--shop-email=<value>
  - Description: Specifies the email address for your Shopware 6 installation to use for correspondence with end users. If not provided, your mStudio account email will be used. This setting can be changed after installation.
  - Parameters:
    - <value>: The email address (string).
  - Default:
    - mStudio account email.

--shop-lang=<value>
  - Description: Sets the default language for your Shopware 6 installation, affecting both the front-end and back-end display. If not specified, the installation defaults to German (de_DE). The language can be modified after the installation is complete.
  - Parameters:
    - <value>: The language code (e.g., 'en_US', 'de_DE') (string).
  - Default:
    - de_DE (German).

--site-title=<value>
  - Description: Defines the site title for your Shopware 6 installation. This title is also displayed in the mStudio application overview and the CLI. If omitted, the application name and project ID will be used. The title can be updated after the installation finishes.
  - Parameters:
    - <value>: The desired site title (string).
  - Default:
    - Application name and project ID.

--version=<value>
  - Description: Specifies the exact version of Shopware 6 to install. If this argument is not provided, the CLI will install the latest available version of Shopware 6.
  - Parameters:
    - <value>: The Shopware 6 version number (string).
  - Default:
    - Latest available version.
```

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

TITLE: Install Shopware 6 with Mittwald CLI
DESCRIPTION: Creates a new Shopware 6 installation using the Mittwald CLI. This command allows extensive configuration through various flags, including version selection, project association, administrator credentials, and site details. The host for the installation must be created separately.

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

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

Creates new Shopware 6 installation.

USAGE
  $ mw app install shopware6 --version <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 6 installation with; needs to be created
                                 separately.
      --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).

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.

  --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 that will be used for the Shopware 6 shop.
    If unspecified, the email address of your mStudio account will be used. This value 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 shop will be using.
    If unspecified, this will default to 'en'. The language can be changed after the installation is finished.

  --site-title=<value>  site title for your Shopware 6 installation.
    The title of your Shopware 6 shop.
    If unspecified, this will default to 'Shopware'. This value can be changed after the installation is finished.

  --version=<value>  (required) [default: latest] version of Shopware 6 to be installed.
    Specifies the exact version of Shopware 6 to install. Defaults to the latest stable version if not provided.

  --wait-timeout=<value>  [default: 600s] the duration to wait for the resource to be ready (common units like
    'ms', 's', 'm' are accepted).
    Sets a timeout for waiting for the Shopware 6 installation to become ready. If the installation does not complete
    within this duration, the command may exit with an error.
```

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

TITLE: Initialize DDEV Project with mw CLI
DESCRIPTION: Initializes a new DDEV project configuration for an existing Mittwald app installation in the current directory. This command sets up the .ddev directory, installs the mittwald DDEV addon, and adds SSH credentials. It requires DDEV to be installed on the system.

SOURCE: https://github.com/mittwald/cli/blob/master/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] [-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

DESCRIPTION
  Initialize a new ddev configuration for an existing app installation in the current directory.

  This command will:
  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: Open App Installation
DESCRIPTION: Opens a specific application installation in the web browser. This command requires that the application installation has at least one virtual host configured to enable browser access.

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

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

Open an app installation in the browser.

USAGE
  $ mw app open [INSTALLATION-ID]

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.

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: Install Shopware 5
DESCRIPTION: Creates a new Shopware 5 installation. This command allows specifying the Shopware version, project ID, host configuration, and details for the initial administrator user and shop settings. Optional flags control output verbosity and waiting for resource readiness.

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

LANGUAGE: bash
CODE:
```
USAGE
  $ mw app install shopware5 --version <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).

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.

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

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

TITLE: Mittwald CLI: Install Joomla Command
DESCRIPTION: Details the `mw app install joomla` command for creating new Joomla installations. It outlines the command's usage, required and optional flags, and provides detailed explanations for each parameter, including types and constraints.

SOURCE: https://github.com/mittwald/cli/blob/master/docs/app.md#_snippet_9

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

Creates new Joomla! installation.

USAGE
  $ mw app install joomla --version <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.
    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 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>
    (required) [default: latest] version of Joomla! to be installed.
    Specify the version in which your Joomla! will be installed. If unspecified, the Joomla! will be installed in the latest available version.

  --wait-timeout=<value>
    [default: 600s] the duration to wait for the resource to be ready (common units like 'ms', 's', 'm' are accepted).
    The duration to wait for the resource to be ready. Common units like 'ms', 's', 'm' are accepted.
```

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

TITLE: Start Mittwald Container CLI Command
DESCRIPTION: Starts a stopped container using the Mittwald CLI. This command requires the CONTAINER-ID of the container to be started and supports optional flags for specifying a project ID or suppressing output.

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

LANGUAGE: APIDOC
CODE:
```
## `mw container start CONTAINER-ID`

Starts a stopped container.

```
USAGE
  $ mw container start CONTAINER-ID [-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

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: 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/master/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/master/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: 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/master/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: Install Matomo App with Mittwald CLI
DESCRIPTION: Creates a new Matomo installation using the Mittwald CLI. Requires specifying the Matomo version and optionally project ID, host, and administrator credentials. The host must be created separately.

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

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

Creates new Matomo installation.

USAGE
  $ mw app install matomo --version <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).

DESCRIPTION
  Creates new Matomo installation.

FLAG DESCRIPTIONS
  -p, --project-id=<value>
    ID or short ID of a project; this flag is optional if a default project is set in the context

    May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
    to persistently set a default project for all commands that accept this flag.

  -q, --quiet
    suppress process output and only display a machine-readable summary

    This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
    scripts), you can use this flag to easily get the IDs of created resources for further processing.

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

  --wait-timeout=<value>
    the duration to wait for the resource to be ready (common units like 'ms', 's', 'm' are accepted).

```

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

TITLE: mw app install wordpress Command
DESCRIPTION: Creates a new WordPress installation with configurable options. This command allows specifying WordPress version, host, administrator details, and site title. It also supports quiet mode and waiting for resource readiness.

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

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

Creates new WordPress installation.

USAGE
  $ mw app install wordpress --version <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 WordPress installation with; needs to be created
                              separately.
      --site-title=<value>    site title for your WordPress installation.
      --version=<value>       (required) [default: latest] version of WordPress to be installed.
      --wait-timeout=<value>  [default: 600s] the duration to wait for the resource to be ready (common units like 'ms',
                              's', 'm' are accepted).

DESCRIPTION
  Creates new WordPress installation.

FLAG DESCRIPTIONS
  -p, --project-id=<value>
    ID or short ID of a project; this flag is optional if a default project is set in the context

    May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
    to persistently set a default project for all commands that accept this flag.

  -q, --quiet
    suppress process output and only display a machine-readable summary

    This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
    scripts), you can use this flag to easily get the IDs of created resources for further processing.

  -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 WordPress installation.
    If unspecified, email address of your mStudio account will be used. This email address can be changed after the
    installation is finished.

  --admin-pass=<value>
    password of your administrator user.

    The password that will be used for the first administrator user that is created during the WordPress installation.
    If unspecified, a random secure password will be generated and printed to stdout. This password can be changed after
    the installation is finished

  --admin-user=<value>
    Username for your administrator user.

    Username of the first administrator user which will be created during the WordPress installation.
    If unspecified, an adequate username will be generated.
    After the installation is finished, the username can be changed and additional administrator users can be created.

  --host=<value>
    host to initially configure your WordPress installation with; needs to be created separately.

    Specify a host which will be used during the installation and as an initial host for the WordPress configuration.
    If unspecified, the default host for the given project will be used.
    This does not change the target of the used host and can be changed later by configuring the host and your WordPress
    installation.

  --site-title=<value>
    site title for your WordPress installation.

    The site title for this WordPress installation. It is also the title shown in the app overview in the mStudio and
    the CLI.
    If unspecified, the application name and the given project ID will be used. The title can be changed after the
    installation is finished

  --version=<value>
    version of WordPress to be installed.

    Specify the version in which your WordPress will be installed.
    If unspecified, the WordPress will be installed in the latest available version.

  --wait-timeout=<value>
    the duration to wait for the resource to be ready (common units like 'ms', 's', 'm' are accepted).

    [default: 600s]
```

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

TITLE: Mittwald CLI: Install Nextcloud Application
DESCRIPTION: Creates a new Nextcloud installation using the Mittwald CLI. This command allows specifying various configuration options such as the Nextcloud version, project ID, host details, administrator credentials, and site title. It supports waiting for the installation to complete and suppressing output for scripting.

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

LANGUAGE: cli
CODE:
```
USAGE
  $ mw app install nextcloud --version <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).

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: 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/master/README.md#_snippet_0

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