update help command
This commit is contained in:
parent
11d9bd9890
commit
15d978b18c
10
README.md
10
README.md
|
@ -42,7 +42,7 @@ get current settings
|
|||
|
||||
change a setting
|
||||
|
||||
set <key> <value>
|
||||
set <key> [value]
|
||||
|
||||
list current requests
|
||||
|
||||
|
@ -50,11 +50,11 @@ list current requests
|
|||
|
||||
accept a request (relay has to be running)
|
||||
|
||||
accept [actor, inbox, or domain]
|
||||
accept <actor, inbox, or domain>
|
||||
|
||||
reject a request (relay has to be running)
|
||||
|
||||
reject [actor, inbox, or domain]
|
||||
reject <actor, inbox, or domain>
|
||||
|
||||
list all subscribed instances
|
||||
|
||||
|
@ -62,8 +62,8 @@ list all subscribed instances
|
|||
|
||||
add an instance to the database (relay has to be running)
|
||||
|
||||
add [actor or domain]
|
||||
add <actor or domain>
|
||||
|
||||
remove an instance from the database
|
||||
|
||||
remove [actor, inbox, or domain]
|
||||
remove <actor, inbox, or domain>
|
||||
|
|
|
@ -41,10 +41,36 @@ class Command:
|
|||
def cmd_help(self):
|
||||
return f'''Uncia Relay Management v{__version__}
|
||||
|
||||
python3 -m uncia.manage help:
|
||||
Show this message
|
||||
|
||||
python3 -m uncia.manage list:
|
||||
List currently subscribed instances
|
||||
|
||||
python3 -m add <actor or domain>: *
|
||||
Add an instance to the database.
|
||||
|
||||
python3 -m remove <actor, inbox, or domain>:
|
||||
Remove an instance and any retries associated with it from the database.
|
||||
|
||||
python3 -m uncia.manage config [key] [value]:
|
||||
Gets or sets the config. Specify a key and value to set a config option.
|
||||
Only specify a key to get the value of a specific option. Leave out the
|
||||
key and value to get all the options and their values
|
||||
key and value to get all the options and their values.
|
||||
|
||||
python3 -m uncia.manage set <key> [value]:
|
||||
Set a config option to a value. If no value is specified, the default is used.
|
||||
|
||||
python3 -m uncia.manage request:
|
||||
List the instances currently requesting to join.
|
||||
|
||||
python3 -m uncia.manage accept <actor, inbox, or domain>: *
|
||||
Accept a request.
|
||||
|
||||
python3 -m uncia.manage deny <actor, inbox, or domain>: *
|
||||
Reject a request.
|
||||
|
||||
* = The relay needs to be running for the command to work
|
||||
'''
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue