From de478fe7cc71e13536f02e162e53e34aee8039e0 Mon Sep 17 00:00:00 2001 From: "Abdulmhsen B. A. A" Date: Wed, 13 Jul 2022 20:41:41 +0300 Subject: [PATCH] updated config:* help doc --- src/Commands/Config/AddCommand.php | 10 ++++----- src/Commands/Config/EditCommand.php | 24 ++++++++++----------- src/Commands/Config/ListCommand.php | 5 ++--- src/Commands/Config/ManageCommand.php | 12 +++++------ src/Commands/Config/UnifyCommand.php | 24 ++++++++++----------- src/Commands/Config/ViewCommand.php | 30 +++++++++++++-------------- 6 files changed, 52 insertions(+), 53 deletions(-) diff --git a/src/Commands/Config/AddCommand.php b/src/Commands/Config/AddCommand.php index 6fe08754..6ee50fa7 100644 --- a/src/Commands/Config/AddCommand.php +++ b/src/Commands/Config/AddCommand.php @@ -27,14 +27,14 @@ final class AddCommand extends Command r( <<servers.yaml] config. -This command require interaction to work. + This command allow you to add new backend. + This command require interaction to work. -This command is purely shortcut for running the following command: + This command is purely shortcut for running the following command: -{cmd} {manage_route} --add -- backend_name + {cmd} {manage_route} --add -- backend_name -HELP, + HELP, [ 'cmd' => trim(commandContext()), 'route' => self::ROUTE, diff --git a/src/Commands/Config/EditCommand.php b/src/Commands/Config/EditCommand.php index 348197a3..c2f2035e 100644 --- a/src/Commands/Config/EditCommand.php +++ b/src/Commands/Config/EditCommand.php @@ -36,25 +36,25 @@ final class EditCommand extends Command r( <<edit backend config settings inline. + This command allow you to edit backend config settings inline. -The [--key] accept string value. the list of officially supported keys are: + The [--key] accept string value. the list of officially supported keys are: -[{keyNames}] + [{keyNames}] -------- -[ FAQ ] -------- + ------- + [ FAQ ] + ------- -# How to edit config setting? + # How to edit config setting? -{cmd} {route} --key key --set value -- backend_name + {cmd} {route} --key key --set value -- backend_name -# How to change the webhook token? + # How to change the webhook token? -{cmd} {route} --regenerate-webhook-token -- backend_name - -HELP, + {cmd} {route} --regenerate-webhook-token -- backend_name + + HELP, [ 'cmd' => trim(commandContext()), 'route' => self::ROUTE, diff --git a/src/Commands/Config/ListCommand.php b/src/Commands/Config/ListCommand.php index f9486aca..57622424 100644 --- a/src/Commands/Config/ListCommand.php +++ b/src/Commands/Config/ListCommand.php @@ -30,10 +30,9 @@ final class ListCommand extends Command ->setHelp( <<interaction to work. + This command allows you to manage backend settings. + This command require interaction to work. -HELP, + HELP, ) ); } @@ -63,11 +63,11 @@ HELP, r( <<ERROR: This command require interaction. For example: + ERROR: This command require interaction. For example: -{cmd} {route} -- {backend} + {cmd} {route} -- {backend_name} -ERROR, + ERROR, [ 'cmd' => trim(commandContext()), 'route' => self::ROUTE, diff --git a/src/Commands/Config/UnifyCommand.php b/src/Commands/Config/UnifyCommand.php index a525c6b3..df9bf1eb 100644 --- a/src/Commands/Config/UnifyCommand.php +++ b/src/Commands/Config/UnifyCommand.php @@ -43,23 +43,23 @@ final class UnifyCommand extends Command r( <<Plex multi server users. -You shouldn't use this command unless told by the team. + This command is mainly intended for Plex multi server users. + You shouldn't use this command unless told by the team. + + Due to Plex webhook limitation you cannot use multiple webhook tokens for one PlexPass account. + And as workaround we have to use one webhook token for all of your Plex backends. -Due to Plex webhook limitation you cannot use multiple webhook tokens for one PlexPass account. -And as workaround we have to use one webhook token for all of your Plex backends. + This command will do the following. -This command will do the following. + 3. Update backends unique identifier (uuid). + 1. Change the selected backend's webhook tokens to be replica of each other. + 2. Enable limit backend webhook requests to matching unique identifier. -3. Update backends unique identifier (uuid). -1. Change the selected backend's webhook tokens to be replica of each other. -2. Enable limit backend webhook requests to matching unique identifier. + To execute the command, you can do the following -To execute the command, you can do the following + {cmd} {route} -- plex -{cmd} {route} -- plex - -HELP, + HELP, [ 'cmd' => trim(commandContext()), 'route' => self::ROUTE, diff --git a/src/Commands/Config/ViewCommand.php b/src/Commands/Config/ViewCommand.php index 2bf9e786..25a8a989 100644 --- a/src/Commands/Config/ViewCommand.php +++ b/src/Commands/Config/ViewCommand.php @@ -42,29 +42,29 @@ final class ViewCommand extends Command r( <<[ FAQ ] -------- + ------- + [ FAQ ] + ------- -# How to show one backend information? + # How to show one backend information? -The flag [-s, --select-backends] accept comma seperated list of backends name, Using the flag -in combination with [--exclude] flag will flip the logic to exclude the selected backends -rather than include them. + The flag [-s, --select-backends] accept comma seperated list of backends name, Using the flag + in combination with [--exclude] flag will flip the logic to exclude the selected backends + rather than include them. -{cmd} {route} --select-backends my_backend + {cmd} {route} --select-backends my_backend -# How to show specific key? + # How to show specific key? -The key can be any value that already exists in the list. to access sub-keys use dot notation for example, -To see if the value of import.enabled you would run: + The key can be any value that already exists in the list. to access sub-keys use dot notation for example, + To see if the value of import.enabled you would run: -{cmd} {route} import.enabled + {cmd} {route} -- import.enabled -HELP, + HELP, [ 'cmd' => trim(commandContext()), 'route' => self::ROUTE,