Commands
NOTE: Keywords enclosed in <
>
are just placeholders. See example for the actual values.
1. add
-
Description: Used to set the word/s that triggers the reply.
-
Parameters: --add "<key>" "<reply>"
-
Example: ---add "hello" "world"
-
Flags:
- By default, only the exact word is matched. This means that if I chat the word
Hello
(with a capitalized H
) or hhello
then the reply will not be triggered.
- To change this, you can add
flags
to the command to specify how the key
will be matched to the word/s provided by the user:
--includes
- Description: Searches the whole string if it contains the
key
, meaning that it will trigger the reply
when a user says apple
since ppl
is inside the word apple
. See Example:
- Example:
--add "pple" "fruit" --includes
--ignoreCase
- Description: Ignore case sensitivity when matching the
key
. This will let us trigger the reply world
using Hello
(with a capitalized H) instead of hello
. See Example:
- Example:
--add "hello" "world" --ignoreCase
NOTE: You can combine multiple flags like so: --add "hello" "world" --includes --ignoreCase
.
2. list
- Description: Prints all saved replies.
- Parameters:
--list
- Example:
--list
3. remove
- Description: Used to remove saved reply either by it's `index``
- Parameters:
--remove <index>
- Example:
--remove 0