Skip to content

Commit

Permalink
More documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
martin-helmich committed Feb 20, 2024
1 parent 732b6fd commit 9f1b1f8
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,13 @@ FLAG DESCRIPTIONS
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.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
```

## `mw app get [INSTALLATION-ID]`
Expand Down Expand Up @@ -1494,6 +1501,14 @@ FLAGS
DESCRIPTION
Connect to an app via SSH
FLAG DESCRIPTIONS
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
```

## `mw app uninstall [INSTALLATION-ID]`
Expand Down Expand Up @@ -2309,6 +2324,13 @@ FLAG DESCRIPTIONS
Compress the dump with gzip. This is useful for large databases, as it can significantly reduce the size of the
dump.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
--[no-]temporary-user create a temporary user for the dump
Create a temporary user for the dump. This user will be deleted after the dump has been created. This is useful if
Expand Down Expand Up @@ -2400,6 +2422,13 @@ FLAG DESCRIPTIONS
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.
--ssh-user=<value> override the SSH user to connect with; if omitted, your own user will be used
This flag can be used to override the SSH user that is used for a connection; be default, your own personal user
will be used for this.
You can also set this value by setting the MITTWALD_SSH_USER environment variable.
```

## `mw database mysql shell DATABASE-ID`
Expand Down
7 changes: 6 additions & 1 deletion src/lib/ssh/flags.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@ import { Flags } from "@oclif/core";

export const sshConnectionFlags = {
"ssh-user": Flags.string({
description:
summary:
"override the SSH user to connect with; if omitted, your own user will be used",
description:
"This flag can be used to override the SSH user that is used for a " +
"connection; be default, your own personal user will be used for this." +
"\n\n" +
"You can also set this value by setting the MITTWALD_SSH_USER environment variable.",
required: false,
default: undefined,
env: "MITTWALD_SSH_USER",
Expand Down

0 comments on commit 9f1b1f8

Please sign in to comment.