Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/martinbjeldbak/twitch-chat-cli

Chat on Twitch.tv from your CLI
https://github.com/martinbjeldbak/twitch-chat-cli

bubbletea cli go golang tui twitch

Last synced: 2 months ago
JSON representation

Chat on Twitch.tv from your CLI

Host: GitHub
URL: https://github.com/martinbjeldbak/twitch-chat-cli
Owner: martinbjeldbak
License: mit
Created: 2022-03-15T10:24:55.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-04-03T04:03:08.000Z (almost 2 years ago)
Last Synced: 2024-10-12T21:07:14.838Z (3 months ago)
Topics: bubbletea, cli, go, golang, tui, twitch
Language: Go
Homepage:
Size: 316 KB
Stars: 16
Watchers: 4
Forks: 2
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Twitch Chat CLI
A [Twitch.tv](https://twitch.tv) chat client in your terminal

Still in early development and missing many core features

## Demo

[![asciicast](https://asciinema.org/a/CXxLYodF6bwrLvwmXWIDo6a2R.svg)](https://asciinema.org/a/CXxLYodF6bwrLvwmXWIDo6a2R)

## Features

- Connect to multiple Twitch channels
- Chat in multiple Twitch channels (requires authentication)

Goal is to be simmiler to [Chatterino](https://chatterino.com/), but in the CLI

Built With
- Go
- [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea)

## Installation

Binaries for most platforms can be downloaded from this project's GitHub [release page](https://github.com/martinbjeldbak/twitch-chat-cli/releases)

Docker images are also built and deployed. See the [Docker](#docker) section below on how to run it.

## How to use

This CLI can be started without any arguments and will launch in anonymous mode, meaning you won't be able to chat.

If you wish to chat, you must auth first with the `auth` command and add the credentials to the `--accounts` flag or the config file.

### Unauthenticated Example

You can connect to one or multiple channels using the `--channels` flag

```sh
$ twitch-chat-cli --channels "ThePrimeagen,blastpremier"
```

### Authenticated Example

Below is an example sequence of commands to authenticte and connect to some channels, where all arguments are passed in via flags

```sh
$ twitch-chat-cli auth # get the arguments passed in to --accounts
$ twitch-chat-cli --channels "blastpremier,jakenbakelive" --accounts "username=qcx;user_id=1234;client_id=123;oauth_token=456"
```

This tool is completely self-sufficient and does not rely on any other services than the Twitch.tv APIs.

A help menu can be found using the `--help` flag.

### Docker

You can also run this CLI through Docker. If you wish to authenticate with your user, you will need to expose port `8090` to your host so that you can run the local authentication server to receive your OAuth tokens from Twitch.

#### Anonymous / Unauthenticated

Simply run the docker image

```sh
$ docker run -it ghcr.io/martinbjeldbak/twitch-chat-cli --channels "ThePrimeagen"
```

#### Authenticated

To authenticate with Twitch and be able to write in chat, follow the below commands. Authentication happens client-side, and your username and password are only ever entered on Twitch.tv.

The first command will prompt you to authenticate with Twitch, and will then present you with an OAuth string at `http://localhost:8090` which needs to be set in the `--accounts` flag. See below for example:

```sh
$ docker run -it -p 8090:8090 ghcr.io/martinbjeldbak/twitch-chat-cli auth
$ docker run -it ghcr.io/martinbjeldbak/twitch-chat-cli --channels "ThePrimeagen" --accounts "PASTE HERE"
```

### Help

```sh
$ twitch-chat-cli --help
A Twitch chat client in the terminal.

Allows chatting in multiple Twitch channels from the comfort of your terminal.
Supports connecting anonymously or as an authenticated user.

This application pairs nicely with Streamlink for
a complete website-free viewing experience!

Usage:
twitch-chat-cli [flags]
twitch-chat-cli [command]

Available Commands:
auth Authenticate with Twitch
completion Generate the autocompletion script for the specified shell
help Help about any command
version Print the version number of twitch-chat-cli

Flags:
--accounts auth accounts and their oauth tokens to use, for example see example.yaml. Fetched via the auth command
--channels strings channels to join (default [pokimane])
--config string config file (default is $HOME/.twitch-chat-cli.yaml)
-h, --help help for twitch-chat-cli
-t, --toggle Help message for toggle
```

### Command: auth

```sh
$ twitch-chat-cli auth
```

This command spins up a local server which will act as the callback URL for the Twitch [OIDC implicit grant flow](https://dev.twitch.tv/docs/authentication/getting-tokens-oidc#oidc-implicit-grant-flow) dance.

You will be asked to sign in to the Twitch account you wish to use this CLI with.

Once authenticated, you will be redirected to the local web server will display a web page with auth string that needs to be passed to the `--accounts` flag, or pasted into your config.

## Inspiration
- https://github.com/chatterino/chatterino2 - Chatterino
- https://github.com/atye/ttchat, similar principle, 1 channel only and need dev account
- https://github.com/dlvhdr/gh-dash - beautiful TUI

## Docs
- https://dev.twitch.tv/docs/cli
- https://dev.twitch.tv/docs/irc
- https://github.com/gempir/go-twitch-irc
- https://github.com/nicklaw5/helix

## Contributing
[![.github/workflows/ci.yml](https://github.com/martinbjeldbak/twitch-chat-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/martinbjeldbak/twitch-chat-cli/actions/workflows/ci.yml)
[![CodeQL](https://github.com/martinbjeldbak/twitch-chat-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/martinbjeldbak/twitch-chat-cli/actions/workflows/codeql-analysis.yml)
[![release](https://github.com/martinbjeldbak/twitch-chat-cli/actions/workflows/release.yml/badge.svg)](https://github.com/martinbjeldbak/twitch-chat-cli/actions/workflows/release.yml)

### TODO
- [ ] Style authentication page smilar to https://chatterino.com/client_login or https://twitchapps.com/tmi/ (starts site with url first, can do this)
- [ ] Open streamlink for current channel using bubbles keybind
- [ ] Add multiuser support
- [x] Tab for each chat/channel
- [x] Scrolling chat window
- [ ] Remove older messages (performance improvement. do if needed)
- Consider via oauth2 pkg https://pkg.go.dev/golang.org/x/oauth2#AuthStyle, https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/#implicit-grant-flow
- [x] Enter chat msg
- [ ] Vim-modes for navigation
- [x] Idea: Start in lurker mode. No chat input, just focus on seeing
- [x] Goreleaser https://goreleaser.com/intro/
- [x] Goreleaser: release docker image (have Dockerfile already, but first fix it up with `distroless`)
- [ ] Animated emotes (image/gif?)
- [ ] Add to lists
- https://github.com/charmbracelet/bubbletea#bubble-tea-in-the-wild
- https://github.com/rothgar/awesome-tuis
- [x] Add viper for config files https://github.com/spf13/viper
- [ ] BTTW emote support via https://github.com/pajlada/gobttv (see usage https://github.com/pajbot/pajbot2/search?q=gobttv)
- [ ] Add emote cache https://github.com/charmbracelet/charm/tree/main/kv
- [ ] User profile pages + mentions
- [ ] Nicer text wrapping (indentet length of user name)
- [ ] Add info about terminal emote support (kitty / iterm2 / sixel)
- https://github.com/alacritty/alacritty (soon)
- soon https://github.com/alacritty/alacritty/pull/4763, https://github.com/alacritty/alacritty/issues/910
- Windows Terminal does not support emotes
- [ ] `PM` and `WhisperMessage` support. See https://pkg.go.dev/github.com/gempir/go-twitch-irc/[email protected]#readme-available-data
- [ ] Add `--debug` command to increase logging
- [ ] Goreleaser: release to package managers scoop/apt/etc.

## License

This application is released under the MIT license. See [`LICENSE`](LICENSE)