Added the help command

This commit is contained in:
deadvey
2026-03-30 15:21:29 +01:00
parent 302d7ea2e4
commit a912836c07

31
args.py
View File

@@ -35,6 +35,37 @@ def handle_arguments(arguments, config, engine):
for voice in voices:
print(voice)
exit()
case '--help'|'h':
print('''Command line options
All these options overide configuration in config.json
c,f,h,i,l,m,o,q,t,u,v,w
--wpm, -w <int>
set the rate of dictation, defaults to 50, note: this is not exact as it measures the time between words in order to avoid a very short gap after a long word.
--mode, -m <mode>
Sets a mode, one of 'timed', 'words','quote' or 'file' followed by an optional modifier representing either the time (in seconds) or the number of words, or the quote ID, or the file name.
--filename, -f <filename>
Passes a filename as parameter for the file mode
--words, -o <number of words>
Number of words for words mode
--time, -t <time>
Time in seconds for timed mode
--quote, -q <time>
Specify a quote ID for quotes mode, see all quotes in your selected language with -u
--language, -l <language>
Selects a language, defaults to english, must be a listed language in -i
--voice, -v <voice id>
Selects a voice to use, defaults to gwm/en in config.json
--list-voices, -c
Lists all the available voices you can use, also see [voices.txt](voices.txt)
--list-quotes, -u
Lists the available quotes and exits
--list-languages, -i
Lists the installed languages and exits
--help, -h
Output's this help text and exits
''')
exit()
case _:
continue
return config