Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-helmich committed May 29, 2024
1 parent 6aa2353 commit 116f09e
Showing 1 changed file with 41 additions and 9 deletions.
50 changes: 41 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ USAGE
* [`mw app list-upgrade-candidates [INSTALLATION-ID]`](#mw-app-list-upgrade-candidates-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 versions [APP]`](#mw-app-versions-app)
Expand Down Expand Up @@ -1896,23 +1897,59 @@ FLAG DESCRIPTIONS
scripts), you can use this flag to easily get the IDs of created resources for further processing.
```

## `mw app update [INSTALLATION-ID]`

Update properties of an app installation (use 'upgrade' to update the app version)

```
USAGE
$ mw app update [INSTALLATION-ID] [-q] [--description <value>] [--entrypoint <value>] [--document-root <value>]
ARGUMENTS
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
in the context.
FLAGS
-q, --quiet suppress process output and only display a machine-readable summary.
--description=<value> update the description of the app installation
--document-root=<value> update the document root of the app installation
--entrypoint=<value> update the entrypoint of the app installation (Python and Node.js only)
FLAG DESCRIPTIONS
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
scripts), you can use this flag to easily get the IDs of created resources for further processing.
--description=<value> update the description of the app installation
This flag updates the description of the app installation. If omitted, the description will not be changed.
--document-root=<value> update the document root of the app installation
Updates the document root of the app installation. If omitted, the document root will not be changed. Note that not
all apps support this field.
--entrypoint=<value> update the entrypoint of the app installation (Python and Node.js only)
Updates the entrypoint of the app installation. If omitted, the entrypoint will not be changed. Note that this field
is only available for some types of apps (like Python and Node.js).
```

## `mw app upgrade [INSTALLATION-ID]`

Upgrade app installation to target version

```
USAGE
$ mw app upgrade [INSTALLATION-ID] [--target-version <value>] [-f] [-p <value>] [-q] [-w] [--wait-timeout
<value>]
$ mw app upgrade [INSTALLATION-ID] [--target-version <value>] [-f] [-q] [-w] [--wait-timeout <value>]
ARGUMENTS
INSTALLATION-ID ID or short ID of an app installation; this argument is optional if a default app installation is set
in the context.
FLAGS
-f, --force Do not ask for confirmation.
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the
context
-q, --quiet suppress process output and only display a machine-readable summary.
-w, --wait wait for the resource to be ready.
--target-version=<value> target version to upgrade app to; if omitted, target version will be prompted
Expand All @@ -1924,11 +1961,6 @@ DESCRIPTION
Upgrade app installation to target version
FLAG DESCRIPTIONS
-p, --project-id=<value> ID or short ID of a project; this flag is optional if a default project is set in the context
May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
to persistently set a default project for all commands that accept this flag.
-q, --quiet suppress process output and only display a machine-readable summary.
This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
Expand Down

0 comments on commit 116f09e

Please sign in to comment.