From 732b6fd62920c087d749928489b96042757c769c Mon Sep 17 00:00:00 2001 From: Martin Helmich Date: Tue, 20 Feb 2024 09:58:00 +0100 Subject: [PATCH] Update README --- README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c7d4ce8b..f10e57ba 100644 --- a/README.md +++ b/README.md @@ -551,17 +551,18 @@ Download the filesystem of an app within a project to your local machine ``` USAGE - $ mw app download [INSTALLATION-ID] --target [-q] [--dry-run] [--delete] + $ mw app download [INSTALLATION-ID] --target [-q] [--ssh-user ] [--dry-run] [--delete] 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. - --delete delete local files that are not present on the server - --dry-run do not actually download the app installation - --target= (required) target directory to download the app installation to + -q, --quiet suppress process output and only display a machine-readable summary. + --delete delete local files that are not present on the server + --dry-run do not actually download the app installation + --ssh-user= override the SSH user to connect with; if omitted, your own user will be used + --target= (required) target directory to download the app installation to DESCRIPTION Download the filesystem of an app within a project to your local machine @@ -1479,16 +1480,17 @@ Connect to an app via SSH ``` USAGE - $ mw app ssh [INSTALLATION-ID] [--cd] [--info] [--test] + $ mw app ssh [INSTALLATION-ID] [--ssh-user ] [--cd] [--info] [--test] 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 - --[no-]cd change to installation path after connecting - --info only print connection information, without actually connecting - --test test connection and exit + --[no-]cd change to installation path after connecting + --info only print connection information, without actually connecting + --ssh-user= override the SSH user to connect with; if omitted, your own user will be used + --test test connection and exit DESCRIPTION Connect to an app via SSH @@ -2269,7 +2271,7 @@ Create a dump of a MySQL database ``` USAGE - $ mw database mysql dump DATABASE-ID -o [-q] [-p ] [--temporary-user] [--gzip] + $ mw database mysql dump DATABASE-ID -o [-q] [-p ] [--ssh-user ] [--temporary-user] [--gzip] ARGUMENTS DATABASE-ID The ID of the database (when a project context is set, you can also use the name) @@ -2279,6 +2281,7 @@ FLAGS -p, --mysql-password= the password to use for the MySQL user (env: MYSQL_PWD) -q, --quiet suppress process output and only display a machine-readable summary. --gzip compress the dump with gzip + --ssh-user= override the SSH user to connect with; if omitted, your own user will be used --[no-]temporary-user create a temporary user for the dump FLAG DESCRIPTIONS @@ -2382,14 +2385,15 @@ Forward the TCP port of a MySQL database to a local port ``` USAGE - $ mw database mysql port-forward DATABASE-ID [-q] [--port ] + $ mw database mysql port-forward DATABASE-ID [-q] [--ssh-user ] [--port ] ARGUMENTS DATABASE-ID The ID of the database (when a project context is set, you can also use the name) FLAGS - -q, --quiet suppress process output and only display a machine-readable summary. - --port= [default: 3306] The local TCP port to forward to + -q, --quiet suppress process output and only display a machine-readable summary. + --port= [default: 3306] The local TCP port to forward to + --ssh-user= override the SSH user to connect with; if omitted, your own user will be used FLAG DESCRIPTIONS -q, --quiet suppress process output and only display a machine-readable summary.