Skip to content

Nadhum/twitch-tui

 
 

Repository files navigation

Twitch chat in the terminal

CI pre-commit.ci status Lines of code Crate Status

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.
Ctrl + t Toggle the filter.
Ctrl + r Reverse the filter.
Ctrl + p Manually trigger a panic, so the application crashes.
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.
Tab Fill in suggestion, if available.
Enter Confirm the current text to go through (doesn't do anything in message search mode).

Setup

  1. Install Rustup from the rust-lang website.
  2. Install the program through cargo install twitch-tui. You can use this same command to update the program in the future. To install a specific version, use a version number from the releases page and the --version flag (ex. cargo install twitch-tui --version "2.0.0-alpha.1").
  3. Run the program with twt in the terminal to generate the default configuration at the paths below. If the directories don't exist, they will be created for you.
    • Linux/MacOS: ~/.config/twt/config.toml
    • Windows: %appdata%\twt\config.toml
  4. Get an OAuth token from Twitch, and place the value in the token variable in the config.toml that was previously generated.
  5. Once you're done modifying the config file, run twt again, and enjoy! Run twt --help if you're looking for more options/arguments.

If you have any problems, do not hesitate to submit an issue.

Along with this application, I recommend using streamlink so there's no more need for a browser.

About

Twitch chat in the terminal.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 99.4%
  • Dockerfile 0.6%