Merge pull request #150 from danmx/fix_usage_ssh

fix(cmd): clarify ssh usage
danmx · Aug 27, 2020 · 8adf284 · 8adf284
2 parents 5a6edfe + 0966b27
commit 8adf284
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@
 
 ### Fix
 - **aws:** error log on a send ssh pub key failure
+- **cmd:** clarify ssh usage
 - **docs:** adding profile config entry description
 
 

diff --git a/cmd/ssh.go b/cmd/ssh.go
@@ -17,7 +17,7 @@ const tempKeyName = "temp_key"
 var (
 	portNum uint64 = 22
 	sshCmd         = &cobra.Command{
-		Use:                   "ssh [--type TYPE] ... { [--gen-key-pair] [--gen-key-dir DIR] | [--pub-key PUB_KEY_PATH] } TARGET",
+		Use:                   "ssh [--type TYPE] ... [ { --gen-key-pair [--gen-key-dir DIR] | --pub-key PUB_KEY_PATH } ] TARGET",
 		DisableFlagsInUseLine: true,
 		Short:                 "Start ssh session",
 		Long:                  `Start a new ssh for chosen EC2 instance.`,

diff --git a/docs/usage/20-ssh.md b/docs/usage/20-ssh.md
@@ -3,7 +3,7 @@
 Start a new ssh for chosen EC2 instance based on its instance ID, name tag, or private DNS name.
 
 ```console
-sigil ssh [--type TYPE] ... { [--gen-key-pair] [--gen-key-dir DIR] | [--pub-key PUB_KEY_PATH] } TARGET
+ssh [--type TYPE] ... [ { --gen-key-pair [--gen-key-dir DIR] | --pub-key PUB_KEY_PATH } ] TARGET
 ```
 
 [Man](../man/sigil_ssh.md) page
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,6 +12,7 @@ @@
     ### Fix
     - **aws:** error log on a send ssh pub key failure
+    - **cmd:** clarify ssh usage
     - **docs:** adding profile config entry description
@@ Expand Down @@