From 9f1b1f826c08d8f57ac59bbc70d12b6c1bd35404 Mon Sep 17 00:00:00 2001
From: Martin Helmich <m.helmich@mittwald.de>
Date: Tue, 20 Feb 2024 10:32:43 +0100
Subject: [PATCH] More documentation

---
 README.md            | 29 +++++++++++++++++++++++++++++
 src/lib/ssh/flags.ts |  7 ++++++-
 2 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f10e57ba..3cb3534f 100644
--- a/README.md
+++ b/README.md
@@ -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]`
@@ -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]`
@@ -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
@@ -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`
diff --git a/src/lib/ssh/flags.ts b/src/lib/ssh/flags.ts
index 0268e9c9..50034d17 100644
--- a/src/lib/ssh/flags.ts
+++ b/src/lib/ssh/flags.ts
@@ -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",