Sergeant is a terminal based Twitch chat widget and bot in one. It will display the Twitch chat from your channel in terminal while also allowing you to add chat bot commands.
Download the correct zip file from the releases section.
Once you've downloaded the zip, unzip the binary file and place it somewhere that it will be available for you to run. On macOS you can put it in a directory that is part of your $PATH. On Windows it also belongs in a directory that is in your PATH environment variable.
Displays your Twitch channel chat in your terminal. Authentication is required, the easiest way is to use sergeant login. You can also use positional arguments to provide your twitch screen name, an oauth token, and a client id. You can also provide environment variables. sergeant chat --help for more details.
This command opens a TUI based admin panel that lets you edit all of the different customizations that can be added to your stream's chat. The admin's interface is navigated using keyboard bindings, indicated by the letters surrounded by parentheses. Lists can be navigated with up/down arrows or j/k keys.
Starts an OAuth login flow to get a token. Navigate to the URL it prints to the terminal, it will wait for you to authenticate. Once complete you're ready to use sergeant.
Use this to add, remove, and list chat commands.
# add !today command:
sergeant commands add today "Today I am going to rust all day long!"
# remove command:
sergeant commands remove today
# list commands:
sergeant commands list
# add a recurring announcement every 5 mins:
sergeant commands add spam "Spam your Twitch channel all you want" 5
Both rewards and irc-actions allow you to configure !lurk style commands to execute a shell command. If the shell command that you are trying to execute has a subcommand, such as commands like git checkout, those can be configured by separating the subcommand with a colon. In the odd case that you wanted to run git checkout when configuring a !git command, the command would be entered as git:checkout in either the Sergeant admin or via the CLI tool.
Use this to add, remove, and list rewards. Rewards are linked directly to Twitch reward redemptions. You can directly link a Twitch redeem to an arbitrary CLI command. If the redeem takes user input, the input is passed on to the CLI command as well as the display_name of the Twitch user that redeemed the reward.
# Link a Twitch redeem named "spotify" to a CLI command named "spt":
sergeant rewards add spotify spt
# remove reward:
sergeant rewards remove spotify
# list rewards:
sergeant rewards list
Use this to add, remove, and list irc-actions. IRC actions are linked directly to IRC !commands. You can directly link a an arbitrary !command to an arbitrary CLI command. The display_name of the Twitch user that sent the chat command is sent to the CLI command.
# Link a irc-action named "boom" to a CLI command named "any-cli-command":
sergeant irc-actions add boom any-cli-command
# remove irc-action:
sergeant irc-actions remove spotify
# list irc-actions:
sergeant irc-actions list
The sergeant chat command also starts a WebSocket server that can be used to build OBS overlays. All supported Twitch IRC, PubSub, and EventSub messages are posted to the WebSocket server so that they can be used to build a web based interface. The WebSocket server runs on port 8765, http://localhost:8765.
There is an example websocket html page and JavaScript connection in the repository's root.