Tidy up help documentation (#418)

README.md

@@ -2,47 +2,47 @@
 
 The Vultr Command Line Interface
 
-```sh
+```
 vultr-cli is a command line interface for the Vultr API
 
 Usage:
   vultr-cli [command]
 
 Available Commands:
-  account            Retrieve information about your account
-  apps               Display all available applications
+  account            Display account information
+  apps               Display applications
   backups            Display backups
-  bare-metal         bare-metal is used to access bare metal server commands
+  bare-metal         Commands to manage bare metal servers
   billing            Display billing information
-  block-storage      block storage commands
+  block-storage      Commands to manage block storage
   completion         Generate the autocompletion script for the specified shell
-  container-registry commands to interact with container registries
-  database           Commands to interact with managed databases on vultr
-  dns                dns is used to access dns commands
-  firewall           firewall is used to access firewall commands
+  container-registry Commands to interact with container registries
+  database           Commands to manage databases
+  dns                Commands to control DNS records
+  firewall           Commands to manage firewalls
   help               Help about any command
-  instance           commands to interact with instances on vultr
-  iso                iso is used to access iso commands
-  kubernetes         kubernetes is used to access kubernetes commands
-  load-balancer      load balancer commands
-  marketplace        Commands to interact with Vultr Marketplace
-  object-storage     object storage commands
-  os                 os is used to access os commands
-  plans              get information about Vultr plans
-  regions            get regions
-  reserved-ip        reserved-ip lets you interact with reserved-ip
-  script             startup script commands
-  snapshot           snapshot commands
-  ssh-key            ssh-key commands
-  user               user commands
-  version            Display current version of Vultr-cli
-  vpc                Interact with VPCs
-  vpc2               Interact with VPC 2.0 networks
+  instance           Commands to interact with instances
+  iso                Commands to manage ISOs
+  kubernetes         Commands to manage kubernetes clusters
+  load-balancer      Commands to managed load balancers
+  marketplace        Display marketplace information
+  object-storage     Commands to manage object storage
+  os                 Display available operating systems
+  plans              Display available plan information
+  regions            Display regions information
+  reserved-ip        Commands to interact with reserved IPs
+  script             Commands to interact with startup scripts
+  snapshot           Commands to interact with snapshots
+  ssh-key            Commands to manage SSH keys
+  user               Commands to manage users
+  version            Display the vultr-cli version
+  vpc                Commands to manage VPCs
+  vpc2               Commands to manage VPC2 networks
 
 Flags:
-  --config string   config file (default is $HOME/.vultr-cli.yaml) (default "#HOME/.vultr-cli.yaml")
+      --config string   config file (default is $HOME/.vultr-cli.yaml) (default "/home/michael/.vultr-cli.yaml")
   -h, --help            help for vultr-cli
-  -t, --toggle          Help message for toggle
+  -o, --output string   output format [ text | json | yaml ] (default "text")
 
 Use "vultr-cli [command] --help" for more information about a command.
 ```
@@ -57,7 +57,7 @@ These are the options available to install `vultr-cli`:
   - Brew
   - OpenBSD (-current)
   - Snap (Coming soon)
-  - Chocolatey (Coming soon)
+  - Chocolatey
 4. Docker
 
 ### GitHub Release

cmd/account/account.go

@@ -25,7 +25,7 @@ func NewCmdAccount(base *cli.Base) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "account",
-		Short:   "get account information",
+		Short:   "Display account information",
 		Long:    accountLong,
 		Example: accountExample,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {

cmd/applications/applications.go

@@ -38,7 +38,7 @@ func NewCmdApplications(base *cli.Base) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "apps",
-		Short:   "display applications",
+		Short:   "Display applications",
 		Aliases: []string{"a", "application", "applications", "app"},
 		Long:    appLong,
 		Example: appExample,
@@ -51,7 +51,7 @@ func NewCmdApplications(base *cli.Base) *cobra.Command {
 	// List
 	list := &cobra.Command{
 		Use:     "list",
-		Short:   "list applications",
+		Short:   "List available applications",
 		Aliases: []string{"l"},
 		Long:    listLong,
 		Example: listExample,

cmd/backups/backups.go

@@ -29,7 +29,7 @@ func NewCmdBackups(base *cli.Base) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "backups",
 		Aliases: []string{"backup", "b"},
-		Short:   "user commands",
+		Short:   "Display backups",
 		Long:    backupsLong,
 		Example: backupsExample,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
@@ -44,7 +44,7 @@ func NewCmdBackups(base *cli.Base) *cobra.Command {
 	// List
 	list := &cobra.Command{
 		Use:     "list",
-		Short:   "list all backups",
+		Short:   "List all backups",
 		Aliases: []string{"l"},
 		Long:    listLong,
 		Example: listExample,
@@ -71,7 +71,7 @@ func NewCmdBackups(base *cli.Base) *cobra.Command {
 	// Get
 	get := &cobra.Command{
 		Use:     "get",
-		Short:   "get a backup",
+		Short:   "Get a backup",
 		Long:    getLong,
 		Example: getExample,
 		Args: func(cmd *cobra.Command, args []string) error {

cmd/baremetal/baremetal.go

@@ -127,7 +127,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 
 	cmd := &cobra.Command{
 		Use:     "bare-metal",
-		Short:   "Bare metal server commands",
+		Short:   "Commands to manage bare metal servers",
 		Aliases: []string{"bm"},
 		Long:    long,
 		Example: example,
@@ -392,7 +392,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Application
 	application := &cobra.Command{
 		Use:     "app",
-		Short:   "app is used to access bare metal server application commands",
+		Short:   "Commands to modify applications on a bare metal server",
 		Aliases: []string{"a", "application"},
 		Long:    applicationLong,
 		Example: applicationExample,
@@ -448,7 +448,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Application List
 	applicationList := &cobra.Command{
 		Use:     "list <Bare Metal ID>",
-		Short:   "Available apps for a bare metal server",
+		Short:   "List available apps for a bare metal server",
 		Long:    applicationListLong,
 		Example: applicationListExample,
 		Args: func(cmd *cobra.Command, args []string) error {
@@ -473,7 +473,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Image
 	image := &cobra.Command{
 		Use:     "image",
-		Short:   "image is used to access bare metal server image commands",
+		Short:   "Commands to manage the image on a bare metal server",
 		Aliases: []string{"i"},
 		Long:    imageLong,
 		Example: imageExample,
@@ -531,7 +531,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// OS
 	operatingSystem := &cobra.Command{
 		Use:     "os",
-		Short:   "Server operating system commands",
+		Short:   "Commands to manage the operating system on a bare metal server",
 		Aliases: []string{"o"},
 		Long:    operatingSystemLong,
 		Example: operatingSystemExample,
@@ -540,7 +540,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// OS Change
 	operatingSystemChange := &cobra.Command{
 		Use:     "change <Bare Metal ID>",
-		Short:   "Change a bare metal server's image",
+		Short:   "Change a bare metal server's operating system",
 		Aliases: []string{"c"},
 		Long:    operatingSystemChangeLong,
 		Example: operatingSystemChangeExample,
@@ -586,7 +586,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Operating System List
 	operatingSystemList := &cobra.Command{
 		Use:     "list <Bare Metal ID>",
-		Short:   "Available operating systems for a bare metal server",
+		Short:   "List the available operating systems for a bare metal server",
 		Long:    operatingSystemListLong,
 		Example: operatingSystemListExample,
 		Args: func(cmd *cobra.Command, args []string) error {
@@ -693,7 +693,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// VNC URL
 	vnc := &cobra.Command{
 		Use:     "vnc <Bare Metal ID>",
-		Short:   "get a bare metal server's VNC url",
+		Short:   "Get a bare metal server's VNC url",
 		Long:    vncLong,
 		Example: vncExample,
 		Args: func(cmd *cobra.Command, args []string) error {
@@ -742,7 +742,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Tags
 	tags := &cobra.Command{
 		Use:     "tags <Bare Metal ID>",
-		Short:   "add or modify tags on the bare metal server.",
+		Short:   "Add or modify tags on the bare metal server",
 		Long:    tagsLong,
 		Example: tagsExample,
 		Args: func(cmd *cobra.Command, args []string) error {
@@ -800,7 +800,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// IPv6 Addresses
 	ipv6 := &cobra.Command{
 		Use:     "ipv6 <Bare Metal ID>",
-		Short:   "list the IPv6 information of a bare metal server.",
+		Short:   "Get the IPv6 information of a bare metal server",
 		Long:    ipv6Long,
 		Example: ipv6Example,
 		Args: func(cmd *cobra.Command, args []string) error {
@@ -824,7 +824,7 @@ func NewCmdBareMetal(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// VPC2
 	vpc2 := &cobra.Command{
 		Use:   "vpc2",
-		Short: "commands to manage vpc 2.0 on bare metal servers",
+		Short: "Commands to manage VPC2s on bare metal servers",
 		Long:  vpc2Long,
 	}
 

cmd/billing/billing.go

@@ -81,7 +81,7 @@ func NewCmdBilling(base *cli.Base) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:     "billing",
-		Short:   "display billing information",
+		Short:   "Display billing information",
 		Long:    long,
 		Example: example,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
@@ -97,15 +97,15 @@ func NewCmdBilling(base *cli.Base) *cobra.Command {
 	invoice := &cobra.Command{
 		Use:     "invoice",
 		Aliases: []string{"i"},
-		Short:   "display invoice information",
+		Short:   "Display invoice information",
 		Long:    invoicesLong,
 		Example: invoicesExample,
 	}
 
 	// Invoice List
 	invoicesList := &cobra.Command{
 		Use:     "list",
-		Short:   "list billing invoices",
+		Short:   "List billing invoices",
 		Aliases: []string{"l"},
 		Long:    invoiceListLong,
 		Example: invoiceListExample,
@@ -132,7 +132,7 @@ func NewCmdBilling(base *cli.Base) *cobra.Command {
 	// Invoice Get
 	invoiceGet := &cobra.Command{
 		Use:     "get",
-		Short:   "get invoice",
+		Short:   "Get an invoice",
 		Aliases: []string{"g"},
 		Long:    invoiceGetLong,
 		Example: invoiceGetExample,
@@ -157,7 +157,7 @@ func NewCmdBilling(base *cli.Base) *cobra.Command {
 	// Invoice Items List
 	invoiceItemsList := &cobra.Command{
 		Use:     "items <INVOICE_ID>",
-		Short:   "list invoice items",
+		Short:   "Get all invoice items",
 		Aliases: []string{"i"},
 		Long:    invoiceItemsListLong,
 		Example: invoiceItemsListExample,
@@ -205,15 +205,15 @@ func NewCmdBilling(base *cli.Base) *cobra.Command {
 	history := &cobra.Command{
 		Use:     "history",
 		Aliases: []string{"h"},
-		Short:   "display billing history information",
+		Short:   "Display billing history information",
 		Long:    historyLong,
 		Example: historyExample,
 	}
 
 	// History List
 	historyList := &cobra.Command{
 		Use:     "list",
-		Short:   "list billing history",
+		Short:   "Show billing history",
 		Aliases: []string{"l"},
 		Long:    historyListLong,
 		Example: historyListExample,

cmd/blockstorage/blockstorage.go

@@ -101,7 +101,7 @@ func NewCmdBlockStorage(base *cli.Base) *cobra.Command { //nolint:gocyclo
 	cmd := &cobra.Command{
 		Use:     "block-storage",
 		Aliases: []string{"bs"},
-		Short:   "block storage commands",
+		Short:   "Commands to manage block storage",
 		Long:    `block-storage is used to interact with the block-storage api`,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 			utils.SetOptions(o.Base, cmd, args)

cmd/containerregistry/containerregistry.go

@@ -334,7 +334,7 @@ func NewCmdContainerRegistry(base *cli.Base) *cobra.Command { //nolint:funlen,go
 	// Plans
 	plans := &cobra.Command{
 		Use:     "plans",
-		Short:   "List the plan names for container registry",
+		Short:   "List the plan names for a container registry",
 		Aliases: []string{"p"},
 		Long:    plansLong,
 		Example: plansExample,
@@ -354,7 +354,7 @@ func NewCmdContainerRegistry(base *cli.Base) *cobra.Command { //nolint:funlen,go
 	// Regions
 	regions := &cobra.Command{
 		Use:     "regions",
-		Short:   "List the available regions for container registry",
+		Short:   "List the available regions for a container registry",
 		Aliases: []string{"i"},
 		Long:    regionsLong,
 		Example: regionsExample,

cmd/database/database.go

@@ -53,7 +53,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 
 	cmd := &cobra.Command{
 		Use:     "database",
-		Short:   "Access database commands",
+		Short:   "Commands to manage databases",
 		Long:    long,
 		Example: example,
 		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
@@ -650,7 +650,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// User ACL
 	userACL := &cobra.Command{
 		Use:   "acl",
-		Short: "commands to handle managed database user access control (Redis only)",
+		Short: "Commands to manage database user access control (Redis only)",
 	}
 
 	// User ACL Update
@@ -758,7 +758,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Logical Database
 	db := &cobra.Command{
 		Use:   "db",
-		Short: "Commands to handle database logical dbs",
+		Short: "Commands to handle database logical DBs",
 	}
 
 	// Logical DB List
@@ -787,7 +787,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Logical DB Create
 	dbCreate := &cobra.Command{
 		Use:   "create <Database ID>",
-		Short: "Create a logical database ",
+		Short: "Create a logical database",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
 				return errors.New("please provide a database ID")
@@ -825,7 +825,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Logical DB Delete
 	dbDel := &cobra.Command{
 		Use:   "delete <Database ID> <DB Name>",
-		Short: "Delete a logical database ",
+		Short: "Delete a logical database",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 2 {
 				return errors.New("please provide a database ID and a DB name")
@@ -1111,7 +1111,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Migration Detach
 	migrationDetach := &cobra.Command{
 		Use:   "detach <Database ID>",
-		Short: "Detach a migration from a database ",
+		Short: "Detach a migration from a database",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
 				return errors.New("please provide a database ID")
@@ -1249,7 +1249,7 @@ func NewCmdDatabase(base *cli.Base) *cobra.Command { //nolint:funlen,gocyclo
 	// Backup Restore
 	backupRestore := &cobra.Command{
 		Use:   "restore <Database ID>",
-		Short: "Restore a database backup ",
+		Short: "Restore a database backup",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
 				return errors.New("please provide a database ID")