Xithrius/twitch-tui
1
1
Fork 0
mirror of https://github.com/Xithrius/twitch-tui.git synced 2024-10-04 09:07:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
8977791943
twitch-tui/README.md

3.2 KiB
Raw Blame History

Twitch chat in the terminal

What it looks like

image

Keybinds

Normal mode
Key Description
c Go to the chat window chat.
i Enter message input mode for sending messages. Exit this mode with `Esc`.
? Have the keybinds popup window appear.
q Quit out of the entire application once in the base chat view.
s Open a popup window to switch channels.
Ctrl + f Enter message search mode, which highlights messages in the main window which match the query.
Esc Exits out of layered windows, such as going from the help window to normal view.
Input mode (message sending/searching, channel swapping)
Key Description
Ctrl + w Cuts a single word (from the cursor to the next whitespace).
Ctrl + u Cuts the entire line.
Ctrl + f Move cursor to the right.
Ctrl + b Move cursor to the left.
Ctrl + a Move cursor to the start.
Ctrl + e Move cursor to the end.
Alt + f Move to the end of the next word.
Alt + b Move to the start of the previous word.
Ctrl + t Swap previous character with current character.
Alt + t Swap previous word with current word.
Ctrl + u Remove everything before the cursor.
Ctrl + k Remove everything after the cursor.
Ctrl + w Remove the previous word.
Ctrl + d Remove character to the right.
Enter Confirm the current text to go through (doesn't do anything in message search mode).

Setup

  1. Make sure you have Cargo installed from rust-lang website. Make sure the Cargo binary folder is appended to your $PATH environment variable.
  2. Copy default-config.toml to a config.toml file. Based on your OS, place the config file in the following directories:
    • Windows: %appdata%\twt\config.toml
    • Linux/MacOs: ~/.config/twt/config.toml
  3. Get an OAuth token from Twitch, and have it ready to put into the token variable in the config.toml file that you created.
  4. Run cargo install twitch-tui and follow the instructions that it prints.
  5. You should now be able to run twt from anywhere now. For CLI options/arguments, run twt --help for information. Any arguments/options passed through the command line will overwrite config.toml. To update in the future, run cargo install twitch-tui. Have fun!

More information

  • This project used to be named terminal-twitch-chat, but was renamed to twitch-tui in version 1.2.2.