Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-helmich committed Feb 20, 2024
1 parent 3538894 commit 732b6fd
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,17 +551,18 @@ Download the filesystem of an app within a project to your local machine

```
USAGE
$ mw app download [INSTALLATION-ID] --target <value> [-q] [--dry-run] [--delete]
$ mw app download [INSTALLATION-ID] --target <value> [-q] [--ssh-user <value>] [--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=<value> (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=<value> override the SSH user to connect with; if omitted, your own user will be used
--target=<value> (required) target directory to download the app installation to
DESCRIPTION
Download the filesystem of an app within a project to your local machine
Expand Down Expand Up @@ -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 <value>] [--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=<value> 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
Expand Down Expand Up @@ -2269,7 +2271,7 @@ Create a dump of a MySQL database

```
USAGE
$ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--temporary-user] [--gzip]
$ mw database mysql dump DATABASE-ID -o <value> [-q] [-p <value>] [--ssh-user <value>] [--temporary-user] [--gzip]
ARGUMENTS
DATABASE-ID The ID of the database (when a project context is set, you can also use the name)
Expand All @@ -2279,6 +2281,7 @@ FLAGS
-p, --mysql-password=<value> 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=<value> 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
Expand Down Expand Up @@ -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 <value>]
$ mw database mysql port-forward DATABASE-ID [-q] [--ssh-user <value>] [--port <value>]
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=<value> [default: 3306] The local TCP port to forward to
-q, --quiet suppress process output and only display a machine-readable summary.
--port=<value> [default: 3306] The local TCP port to forward to
--ssh-user=<value> 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.
Expand Down

0 comments on commit 732b6fd

Please sign in to comment.