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

💬 Twitch chat in your terminal
https://github.com/dongy7/twitch-chat-cli

cli emotes terminal twitch

Last synced: 26 days ago
JSON representation

💬 Twitch chat in your terminal

• Host: GitHub
• URL: https://github.com/dongy7/twitch-chat-cli
• Owner: dongy7
• License: mit
• Created: 2018-05-08T01:00:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:04:36.000Z (about 2 years ago)
• Last Synced: 2024-11-08T21:48:11.299Z (about 1 month ago)
• Topics: cli, emotes, terminal, twitch
• Language: JavaScript
• Homepage:
• Size: 2.11 MB
• Stars: 131
• Watchers: 2
• Forks: 8
• Open Issues: 20
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-twitch-dev - dongy7/twitch-chat-cli - Twitch chat in your terminal. (Libraries / JavaScript (Node.js))

README

        
# twitch-chat-cli

> Read Twitch chat on your terminal



	


	

	


	




## Installation

```sh

$ npm install -g twitch-chat-cli

```

## Usage

First generate an [OAuth token](https://twitchapps.com/tmi/) to connect to the Twitch IRC.

Add your OAuth token:

```sh

$ tc add  

```

Connect to a channel to start reading chat:

```sh

$ tc connect 

```

## Emotes

This feature currently only works in [iTerm](https://www.iterm2.com/), which has support for displaying pictures.

To see Twitch emotes as pictures, you will need to have the API server running, which allows the CLI to query for global and channel specific emotes. You will need to have [Docker](https://www.docker.com/community-edition) installed to run the server.

You will need to have [Git LFS](https://github.com/git-lfs/git-lfs) installed.

First clone this repo:

```sh

$ git clone https://github.com/dongy7/twitch-chat-cli.git

```

Start the Docker containers from the `api` directory:

```sh

$ cd api

$ docker-compose up

```

The server should now be running at `http://localhost:3000/`.