diff --git a/.yarn/cache/js-yaml-npm-4.2.0-0ab78512c1-86bd35548a.zip b/.yarn/cache/js-yaml-npm-4.2.0-0ab78512c1-86bd35548a.zip deleted file mode 100644 index dfd2b1b67..000000000 Binary files a/.yarn/cache/js-yaml-npm-4.2.0-0ab78512c1-86bd35548a.zip and /dev/null differ diff --git a/.yarn/cache/js-yaml-npm-5.1.0-88045bdcf7-ed920d2956.zip b/.yarn/cache/js-yaml-npm-5.1.0-88045bdcf7-ed920d2956.zip new file mode 100644 index 000000000..db46b4b00 Binary files /dev/null and b/.yarn/cache/js-yaml-npm-5.1.0-88045bdcf7-ed920d2956.zip differ diff --git a/README.md b/README.md index 43583cd24..46cf7466b 100644 --- a/README.md +++ b/README.md @@ -110,29 +110,10 @@ USAGE * [`mw app`](docs/app.md) - Manage apps, and app installations in your projects * [`mw autocomplete`](docs/autocomplete.md) - Display autocomplete installation instructions. -* [`mw backup`](docs/backup.md) - Manage backups of your projects -* [`mw container`](docs/container.md) - Manage containers -* [`mw context`](docs/context.md) - Save certain environment parameters for later use * [`mw conversation`](docs/conversation.md) - Manage your support cases -* [`mw cronjob`](docs/cronjob.md) - Manage cronjobs of your projects * [`mw database`](docs/database.md) - Manage databases (like MySQL and Redis) in your projects -* [`mw ddev`](docs/ddev.md) - Integrate your mittwald projects with DDEV -* [`mw domain`](docs/domain.md) - Manage domains, virtual hosts and DNS settings in your projects -* [`mw experimental`](docs/experimental.md) - Experimental features, which are not considered stable yet and might change without a major version bump -* [`mw extension`](docs/extension.md) - Install and manage extensions in your organisations and projects * [`mw help`](docs/help.md) - Display help for mw. -* [`mw login`](docs/login.md) - Manage your client authentication -* [`mw mail`](docs/mail.md) - Manage mailboxes and mail addresses in your projects -* [`mw org`](docs/org.md) - Manage your organizations, and also any kinds of user memberships concerning these organizations. -* [`mw project`](docs/project.md) - Manage your projects, and also any kinds of user memberships concerning these projects. -* [`mw registry`](docs/registry.md) - Manage container registries -* [`mw server`](docs/server.md) - Manage your servers -* [`mw sftp-user`](docs/sftp-user.md) - Manage SFTP users of your projects -* [`mw ssh-user`](docs/ssh-user.md) - Manage SSH users of your projects -* [`mw stack`](docs/stack.md) - Manage container stacks * [`mw update`](docs/update.md) - update the mw CLI -* [`mw user`](docs/user.md) - Manage your own user account -* [`mw volume`](docs/volume.md) - Manage volumes diff --git a/docs/app.md b/docs/app.md index 6d1c3f818..23576f16f 100644 --- a/docs/app.md +++ b/docs/app.md @@ -3,1852 +3,8 @@ Manage apps, and app installations in your projects -* [`mw app copy [INSTALLATION-ID]`](#mw-app-copy-installation-id) -* [`mw app create node`](#mw-app-create-node) -* [`mw app create php`](#mw-app-create-php) -* [`mw app create php-worker`](#mw-app-create-php-worker) -* [`mw app create python`](#mw-app-create-python) -* [`mw app create static`](#mw-app-create-static) -* [`mw app dependency list`](#mw-app-dependency-list) -* [`mw app dependency update [INSTALLATION-ID]`](#mw-app-dependency-update-installation-id) -* [`mw app dependency versions SYSTEMSOFTWARE`](#mw-app-dependency-versions-systemsoftware) -* [`mw app download [INSTALLATION-ID]`](#mw-app-download-installation-id) -* [`mw app exec COMMAND`](#mw-app-exec-command) -* [`mw app get [INSTALLATION-ID]`](#mw-app-get-installation-id) -* [`mw app install contao`](#mw-app-install-contao) -* [`mw app install joomla`](#mw-app-install-joomla) -* [`mw app install matomo`](#mw-app-install-matomo) -* [`mw app install nextcloud`](#mw-app-install-nextcloud) -* [`mw app install shopware5`](#mw-app-install-shopware5) -* [`mw app install shopware6`](#mw-app-install-shopware6) -* [`mw app install typo3`](#mw-app-install-typo3) -* [`mw app install wordpress`](#mw-app-install-wordpress) -* [`mw app list`](#mw-app-list) -* [`mw app list-upgrade-candidates [INSTALLATION-ID]`](#mw-app-list-upgrade-candidates-installation-id) -* [`mw app open [INSTALLATION-ID]`](#mw-app-open-installation-id) -* [`mw app ssh [INSTALLATION-ID]`](#mw-app-ssh-installation-id) -* [`mw app uninstall [INSTALLATION-ID]`](#mw-app-uninstall-installation-id) -* [`mw app update [INSTALLATION-ID]`](#mw-app-update-installation-id) -* [`mw app upgrade [INSTALLATION-ID]`](#mw-app-upgrade-installation-id) -* [`mw app upload [INSTALLATION-ID]`](#mw-app-upload-installation-id) -* [`mw app version-info APP VERSION`](#mw-app-version-info-app-version) * [`mw app versions [APP]`](#mw-app-versions-app) -## `mw app copy [INSTALLATION-ID]` - -Copy an app within a project - -``` -USAGE - $ mw app copy [INSTALLATION-ID] --description [--token ] [-q] [--install-path ] - -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= (required) set a description for the new app installation - --install-path= set the installation path for the new app installation; if omitted, this will default to - an autogenerated directory name - -AUTHENTICATION FLAGS - --token= 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. -``` - - -## `mw app create node` - -Creates new custom Node.js installation. - -``` -USAGE - $ mw app create node [--token ] [-p ] [-q] [--site-title ] [--entrypoint ] [-w] - [--wait-timeout ] [--install-path ] [-c] - -FLAGS - -c, --update-context update the CLI context to use the newly created app installation - -p, --project-id= ID or short ID of a project; this flag is optional if a default project is set in the - context - -q, --quiet suppress process output and only display a machine-readable summary - -w, --wait wait for the resource to be ready. - --entrypoint= [default: yarn start] the command that should be used to start your custom Node.js - application. - --install-path= the installation path of your custom Node.js application - --site-title= site title for your custom Node.js installation. - --wait-timeout= [default: 600s] the duration to wait for the resource to be ready (common units like 'ms', - 's', 'm' are accepted). - -AUTHENTICATION FLAGS - --token= API token to use for authentication (overrides environment and config file). NOTE: watch out that - tokens passed via this flag might be logged in your shell history. - -DESCRIPTION - Creates new custom Node.js installation. - -FLAG DESCRIPTIONS - -p, --project-id= 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=" command - to persistently set a default project for all commands that accept this flag. - - -q, --quiet suppress process output and only display a machine-readable summary - - This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in - scripts), you can use this flag to easily get the IDs of created resources for further processing. - - --entrypoint= the command that should be used to start your custom Node.js application. - - This is the command that should be used to start your application; the app is required to run in the foreground, and - to listen on the port specified by the PORT environment variable. - - --install-path= the installation path of your custom Node.js application - - This is the path where your application will be installed. If omitted, this will default to an - automatically-generated path. - - --site-title= site title for your custom Node.js installation. - - The site title for this custom Node.js installation. It is also the title shown in the app overview in the mStudio - and the CLI. - If unspecified, the application name and the given project ID will be used. The title can be changed after the - installation is finished -``` - - -## `mw app create php` - -Creates new custom PHP installation. - -``` -USAGE - $ mw app create php --document-root [--token ] [-p ] [-q] [--site-title ] [-w] - [--wait-timeout ] [--install-path ] [-c] - -FLAGS - -c, --update-context update the CLI context to use the newly created app installation - -p, --project-id= 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= (required) [default: /] the document root from which your custom PHP will be served - (relative to the installation path) - --install-path= the installation path of your custom PHP application - --site-title= site title for your custom PHP installation. - --wait-timeout= [default: 600s] the duration to wait for the resource to be ready (common units like - 'ms', 's', 'm' are accepted). - -AUTHENTICATION FLAGS - --token= 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= 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=" 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= - - the document root from which your custom PHP will be served (relative to the installation path) - - This is the document root from which the files of your application will be served by the web server. This directory - is specified relative to the installation path. - - --install-path= the installation path of your custom PHP application - - This is the path where your application will be installed. If omitted, this will default to an - automatically-generated path. - - --site-title= 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 -``` - - -## `mw app create php-worker` - -Creates new PHP worker installation. - -``` -USAGE - $ mw app create php-worker [--token ] [-p ] [-q] [--entrypoint ] [--site-title ] [-w] - [--wait-timeout ] [--install-path ] [-c] - -FLAGS - -c, --update-context update the CLI context to use the newly created app installation - -p, --project-id= ID or short ID of a project; this flag is optional if a default project is set in the - context - -q, --quiet suppress process output and only display a machine-readable summary - -w, --wait wait for the resource to be ready. - --entrypoint= the command that should be used to start your PHP worker application. - --install-path= the installation path of your PHP worker application - --site-title= site title for your PHP worker installation. - --wait-timeout= [default: 600s] the duration to wait for the resource to be ready (common units like 'ms', - 's', 'm' are accepted). - -AUTHENTICATION FLAGS - --token= API token to use for authentication (overrides environment and config file). NOTE: watch out that - tokens passed via this flag might be logged in your shell history. - -DESCRIPTION - Creates new PHP worker installation. - -FLAG DESCRIPTIONS - -p, --project-id= 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=" command - to persistently set a default project for all commands that accept this flag. - - -q, --quiet suppress process output and only display a machine-readable summary - - This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in - scripts), you can use this flag to easily get the IDs of created resources for further processing. - - --entrypoint= the command that should be used to start your PHP worker application. - - This is the command that should be used to start your application; the app is required to run in the foreground, and - to listen on the port specified by the PORT environment variable. - - --install-path= the installation path of your PHP worker application - - This is the path where your application will be installed. If omitted, this will default to an - automatically-generated path. - - --site-title= site title for your PHP worker installation. - - The site title for this PHP worker installation. It is also the title shown in the app overview in the mStudio and - the CLI. - If unspecified, the application name and the given project ID will be used. The title can be changed after the - installation is finished -``` - - -## `mw app create python` - -Creates new custom python site installation. - -``` -USAGE - $ mw app create python [--token ] [-p ] [-q] [--site-title ] [--entrypoint ] [-w] - [--wait-timeout ] [--install-path ] [-c] - -FLAGS - -c, --update-context update the CLI context to use the newly created app installation - -p, --project-id= ID or short ID of a project; this flag is optional if a default project is set in the - context - -q, --quiet suppress process output and only display a machine-readable summary - -w, --wait wait for the resource to be ready. - --entrypoint= the command that should be used to start your custom python site application. - --install-path= the installation path of your custom python site application - --site-title= site title for your custom python site installation. - --wait-timeout= [default: 600s] the duration to wait for the resource to be ready (common units like 'ms', - 's', 'm' are accepted). - -AUTHENTICATION FLAGS - --token= API token to use for authentication (overrides environment and config file). NOTE: watch out that - tokens passed via this flag might be logged in your shell history. - -DESCRIPTION - Creates new custom python site installation. - -FLAG DESCRIPTIONS - -p, --project-id= 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=" command - to persistently set a default project for all commands that accept this flag. - - -q, --quiet suppress process output and only display a machine-readable summary - - This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in - scripts), you can use this flag to easily get the IDs of created resources for further processing. - - --entrypoint= the command that should be used to start your custom python site application. - - This is the command that should be used to start your application; the app is required to run in the foreground, and - to listen on the port specified by the PORT environment variable. - - --install-path= the installation path of your custom python site application - - This is the path where your application will be installed. If omitted, this will default to an - automatically-generated path. - - --site-title= site title for your custom python site installation. - - The site title for this custom python site installation. It is also the title shown in the app overview in the - mStudio and the CLI. - If unspecified, the application name and the given project ID will be used. The title can be changed after the - installation is finished -``` - - -## `mw app create static` - -Creates new custom static site installation. - -``` -USAGE - $ mw app create static --document-root [--token ] [-p ] [-q] [--site-title ] [-w] - [--wait-timeout ] [--install-path ] [-c] - -FLAGS - -c, --update-context update the CLI context to use the newly created app installation - -p, --project-id= 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= (required) [default: /] the document root from which your custom static site will be - served (relative to the installation path) - --install-path= the installation path of your custom static site application - --site-title= site title for your custom static site installation. - --wait-timeout= [default: 600s] the duration to wait for the resource to be ready (common units like - 'ms', 's', 'm' are accepted). - -AUTHENTICATION FLAGS - --token= API token to use for authentication (overrides environment and config file). NOTE: watch out that - tokens passed via this flag might be logged in your shell history. - -DESCRIPTION - Creates new custom static site installation. - -FLAG DESCRIPTIONS - -p, --project-id= 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=" 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= - - the document root from which your custom static site will be served (relative to the installation path) - - This is the document root from which the files of your application will be served by the web server. This directory - is specified relative to the installation path. - - --install-path= the installation path of your custom static site application - - This is the path where your application will be installed. If omitted, this will default to an - automatically-generated path. - - --site-title= site title for your custom static site installation. - - The site title for this custom static site installation. It is also the title shown in the app overview in the - mStudio and the CLI. - If unspecified, the application name and the given project ID will be used. The title can be changed after the - installation is finished -``` - - -## `mw app dependency list` - -Get all available dependencies - -``` -USAGE - $ mw app dependency list -o txt|json|yaml|csv|tsv [--token ] [-x] [--no-header] [--no-truncate] - [--no-relative-dates] [--csv-separator ,|;] - -FLAGS - -o, --output=