mirror of
https://github.com/Xithrius/twitch-tui.git
synced 2024-09-11 13:45:30 +03:00
Twitch chat in the terminal.
.devcontainer | ||
.github | ||
.vscode | ||
src | ||
.editorconfig | ||
.gitignore | ||
.pre-commit-config.yaml | ||
Cargo.lock | ||
Cargo.toml | ||
CODE_OF_CONDUCT.md | ||
default-config.toml | ||
deny.toml | ||
LICENSE-APACHE | ||
LICENSE-MIT | ||
README.md | ||
rustfmt.toml |
Twitch chat in the terminal
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
- Install Rustup from the rust-lang website.
- 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"
). - 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
- Linux/MacOS:
- Get an OAuth token from Twitch, and place the value in the
token
variable in theconfig.toml
that was previously generated. - Once you're done modifying the config file, run
twt
again, and enjoy! Runtwt --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.