📝 Update command docs

README.md

@@ -12,14 +12,32 @@ gh extension install gabe565/gh-profile
 
 ## Usage
 
-- `gh profile create` - Prompts to add a new profile.
-  - `gh profile create example` - Adds a profile named example.
-- `gh profile switch` - Prompts to choose a profile from an interactive list.
-  - `gh profile switch default` - Switches to a profile named default.
-- `gh profile rename` - Prompts to rename a profile.
-  - `gh profile rename example example2` - Renames a profile named example to example2.
-- `gh profile list` - Lists all profiles.
-- `gh profile remove` - Prompts to remove a profile.
-  - `gh profile remove example` - Removes a profile named example.
-
-See [generated usage docs](./docs/profile.md) for more information.
+See the [generated usage docs](./docs/profile.md), or see a summary of each
+subcommand below.
+
+### `gh profile create [NAME]`
+Creates a new profile called `name`.  
+Name is optional. If not set, command will run interactively.  
+Aliases: `new`, `add`
+
+### `gh profile switch [NAME]`
+Activates the profile called `name`.  
+Name is optional. If not set, command will run interactively.  
+Aliases: `activate`, `active`, `sw`
+
+### `gh profile rename [NAME] [NEW_NAME]`
+Renames a profile called `old` to `new`.  
+Old and new name are optional. If not set, command will run interactively.  
+Aliases: `mv`
+
+### `gh profile list`
+Lists all profiles. Active profile will be bold with a green check.  
+Aliases: `ls`, `l`
+
+### `gh profile remove [NAME]`
+Removes a profile called `name`.  
+Name is optional. If not set, command will run interactively.  
+Aliases: `delete`, `rm`
+
+### `gh profile show`
+Prints the active profile name. If no profile is active, will print `none`.

cmd/create/cmd.go

@@ -7,7 +7,7 @@ import (
 
 func New() *cobra.Command {
 	return &cobra.Command{
-		Use:     "create [name]",
+		Use:     "create [NAME]",
 		Aliases: []string{"c", "new", "add"},
 		Short:   "Creates a new profile",
 		RunE:    run,

cmd/remove/cmd.go

@@ -8,7 +8,7 @@ import (
 
 func New() *cobra.Command {
 	return &cobra.Command{
-		Use:     "remove [name]",
+		Use:     "remove [NAME]",
 		Aliases: []string{"delete", "rm", "d"},
 		Short:   "Deletes a profile",
 		RunE:    run,

cmd/rename/cmd.go

@@ -7,7 +7,7 @@ import (
 
 func New() *cobra.Command {
 	return &cobra.Command{
-		Use:     "rename [name] [new-name]",
+		Use:     "rename [NAME] [NEW_NAME]",
 		Aliases: []string{"mv"},
 		Short:   "Renames a profile",
 		RunE:    run,

cmd/switch/cmd.go

@@ -10,7 +10,7 @@ import (
 
 func New() *cobra.Command {
 	return &cobra.Command{
-		Use:     "switch [name]",
+		Use:     "switch [NAME]",
 		Aliases: []string{"activate", "active", "sw", "s"},
 		Short:   "Switch active profile",
 		RunE:    run,

docs/profile_create.md

@@ -3,7 +3,7 @@
 Creates a new profile
 
 ```
-profile create [name] [flags]
+profile create [NAME] [flags]
 ```
 
 ### Options

docs/profile_remove.md

@@ -3,7 +3,7 @@
 Deletes a profile
 
 ```
-profile remove [name] [flags]
+profile remove [NAME] [flags]
 ```
 
 ### Options

docs/profile_rename.md

@@ -3,7 +3,7 @@
 Renames a profile
 
 ```
-profile rename [name] [new-name] [flags]
+profile rename [NAME] [NEW_NAME] [flags]
 ```
 
 ### Options

docs/profile_switch.md

@@ -3,7 +3,7 @@
 Switch active profile
 
 ```
-profile switch [name] [flags]
+profile switch [NAME] [flags]
 ```
 
 ### Options