Auth: Improve API authentication subcommand usage information #808

Signed-off-by: Michael Mayer <michael@photoprism.app>

internal/commands/auth_add.go

@@ -33,8 +33,8 @@ var AuthAddFlags = []cli.Flag{
 // AuthAddCommand configures the command name, flags, and action.
 var AuthAddCommand = cli.Command{
 	Name:        "add",
-	Usage:       "Creates a new client access token",
+	Usage:       "Creates a new access token for client authentication",
-	Description: "Specifying a username as argument creates a personal access token for a registered user account.",
+	Description: "If you provide a username as argument, a personal access token for registered users will be created.",
 	ArgsUsage:   "[username]",
 	Flags:       AuthAddFlags,
 	Action:      authAddAction,

internal/commands/auth_list.go

@@ -14,7 +14,7 @@ import (
 // AuthListCommand configures the command name, flags, and action.
 var AuthListCommand = cli.Command{
 	Name:      "ls",
-	Usage:     "Lists authenticated users and API clients",
+	Usage:     "Lists currently authenticated users and clients",
 	ArgsUsage: "[search]",
 	Flags:     append(report.CliFlags, countFlag, tokensFlag),
 	Action:    authListAction,

internal/commands/auth_remove.go

@@ -15,8 +15,8 @@ import (
 // AuthRemoveCommand configures the command name, flags, and action.
 var AuthRemoveCommand = cli.Command{
 	Name:      "rm",
-	Usage:     "Deletes the specified session or access token",
+	Usage:     "Deletes a session by id or access token",
-	ArgsUsage: "[id]",
+	ArgsUsage: "[identifier]",
 	Action:    authRemoveAction,
 }
 

internal/commands/auth_reset.go

@@ -15,7 +15,7 @@ import (
 // AuthResetCommand configures the command name, flags, and action.
 var AuthResetCommand = cli.Command{
 	Name:  "reset",
-	Usage: "Removes all registered user and client sessions",
+	Usage: "Resets the authentication of all users and clients",
 	Flags: []cli.Flag{
 		cli.BoolFlag{
 			Name:  "trace, t",

internal/commands/auth_show.go

@@ -14,8 +14,8 @@ import (
 // AuthShowCommand configures the command name, flags, and action.
 var AuthShowCommand = cli.Command{
 	Name:      "show",
-	Usage:     "Shows details of the specified session or access token",
+	Usage:     "Shows detailed information about a session",
-	ArgsUsage: "[id]",
+	ArgsUsage: "[identifier]",
 	Flags:     report.CliFlags,
 	Action:    authShowAction,
 }

internal/commands/clients_mod.go

@@ -16,7 +16,7 @@ import (
 var ClientsModCommand = cli.Command{
 	Name:      "mod",
 	Usage:     "Updates client application settings",
-	ArgsUsage: "[id]",
+	ArgsUsage: "[client id]",
 	Flags:     ClientModFlags,
 	Action:    clientsModAction,
 }

internal/commands/clients_remove.go

@@ -15,7 +15,7 @@ import (
 var ClientsRemoveCommand = cli.Command{
 	Name:      "rm",
 	Usage:     "Deletes the specified client application",
-	ArgsUsage: "[id]",
+	ArgsUsage: "[client id]",
 	Flags: []cli.Flag{
 		cli.BoolFlag{
 			Name:  "force, f",

internal/commands/clients_show.go

@@ -15,7 +15,7 @@ import (
 var ClientsShowCommand = cli.Command{
 	Name:      "show",
 	Usage:     "Shows client configuration details",
-	ArgsUsage: "[id]",
+	ArgsUsage: "[client id]",
 	Flags:     report.CliFlags,
 	Action:    clientsShowAction,
 }