luzifer/twitch-bot
1
0
Fork 0
mirror of https://github.com/Luzifer/twitch-bot.git synced 2024-12-30 00:21:16 +00:00
Code Issues Projects Releases Wiki Activity

[docs] Update README

Browse source 
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2022-01-05 18:17:07 +01:00
parent 9150ec6311
commit 7653f557ca
Signed by: luzifer
GPG key ID: 0066F03ED215AD7D
1 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -17,18 +17,19 @@ Please see the [Wiki](https://github.com/Luzifer/twitch-bot/wiki) for documentat
```console ```console
# twitch-bot --help # twitch-bot --help
Usage of twitch-bot: Usage of twitch-bot:
--base-url string External URL of the config-editor interface (set to enable EventSub support) --base-url string External URL of the config-editor interface (set to enable EventSub support)
--command-timeout duration Timeout for command execution (default 30s) --command-timeout duration Timeout for command execution (default 30s)
-c, --config string Location of configuration file (default "./config.yaml") -c, --config string Location of configuration file (default "./config.yaml")
--log-level string Log level (debug, info, warn, error, fatal) (default "info") --log-level string Log level (debug, info, warn, error, fatal) (default "info")
--plugin-dir string Where to find and load plugins (default "/usr/lib/twitch-bot") --plugin-dir string Where to find and load plugins (default "/usr/lib/twitch-bot")
--rate-limit duration How often to send a message (default: 20/30s=1500ms, if your bot is mod everywhere: 100/30s=300ms, different for known/verified bots) (default 1.5s) --rate-limit duration How often to send a message (default: 20/30s=1500ms, if your bot is mod everywhere: 100/30s=300ms, different for known/verified bots) (default 1.5s)
--storage-file string Where to store the data (default "./storage.json.gz") --storage-encryption-pass string Passphrase to encrypt secrets inside storage (defaults to twitch-client:twitch-client-secret)
--twitch-client string Client ID to act as --storage-file string Where to store the data (default "./storage.json.gz")
--twitch-token string OAuth token valid for client --twitch-client string Client ID to act as
-v, --validate-config Loads the config, logs any errors and quits with status 0 on success --twitch-client-secret string Secret for the Client ID
--version Prints current version and exits --twitch-token string OAuth token valid for client (fallback if no token was set in interface)
-v, --validate-config Loads the config, logs any errors and quits with status 0 on success
--version Prints current version and exits
# twitch-bot help # twitch-bot help
Supported sub-commands are: Supported sub-commands are:
actor-docs Generate markdown documentation for available actors actor-docs Generate markdown documentation for available actors