Improve help

essentialkaos · Mar 26, 2024 · 6ce52a5 · 6ce52a5
1 parent b13fc38
commit 6ce52a5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ Options
   --storage-fs-mode mode                     File mode on system (STORAGE_FS_MODE)
   --storage-sftp-host host                   SFTP host (STORAGE_SFTP_HOST)
   --storage-sftp-user name                   SFTP user name (STORAGE_SFTP_USER)
-  --storage-sftp-key key                     SFTP user private key (STORAGE_SFTP_KEY)
+  --storage-sftp-key key                     Base64-encoded private key (STORAGE_SFTP_KEY)
   --storage-sftp-path path                   Path on SFTP (STORAGE_SFTP_PATH)
   --storage-sftp-mode mode                   File mode on SFTP (STORAGE_SFTP_MODE)
   --storage-s3-host host                     S3 host (STORAGE_S3_HOST)

diff --git a/cli/cli.go b/cli/cli.go
@@ -708,7 +708,7 @@ func genUsage() *usage.Info {
 		addUnitedOption(info, STORAGE_FS_MODE, "File mode on system", "mode")
 		addUnitedOption(info, STORAGE_SFTP_HOST, "SFTP host", "host")
 		addUnitedOption(info, STORAGE_SFTP_USER, "SFTP user name", "name")
-		addUnitedOption(info, STORAGE_SFTP_KEY, "SFTP user private key", "key")
+		addUnitedOption(info, STORAGE_SFTP_KEY, "Base64-encoded private key", "key")
 		addUnitedOption(info, STORAGE_SFTP_PATH, "Path on SFTP", "path")
 		addUnitedOption(info, STORAGE_SFTP_MODE, "File mode on SFTP", "mode")
 		addUnitedOption(info, STORAGE_S3_HOST, "S3 host", "host")