# chafa-yt

![](https://hackatime-badge.hackclub.com/U099JENAUGP/chafa-yt)

A YouTube TUI! Featuring a sophisticated UI, real-time video playback, subtitles, and a progress indicator.

<img src="readme/demo.png" width="100%">

<p align="center">
<img src="readme/demo.webp" width="50%">
</p>

Advantages:

- No ads
- Looks cool
- Real streaming, not just predownloading
- In the terminal
- Blazingly fast 30fps at an innovative resolution of 80x24 
- Full 24-bit color (on supported terminals)
- Open-source
- Is cool

## Install

[look here!](readme/install-instructions.md)

## Usage

> [!TIP]
> Use a more modern terminal emulator like Ghostty for better colors (but it should work on the default terminal, too)

```bash
# Default
uv run https://raw.githubusercontent.com/JBlitzar/chafa-yt/main/main.py

# Custom video (use quotes!)
uv run https://raw.githubusercontent.com/JBlitzar/chafa-yt/main/main.py "https://youtube.com/watch?v=..."

# See all options
uv run https://raw.githubusercontent.com/JBlitzar/chafa-yt/main/main.py --help
# (Press 'q' to exit help)

# Exit the player
Press Ctrl+Q
```

## How this works

> _Sometimes in life, the best solution is to utilize pre-existing libraries_ - Sun Tzu, the Art of Software Development

Pipes `yt-dlp` to `ffmpeg` to `chafa` to `textual` to your eyeballs!

Read all about it in `main.py`. TUI code is in `ChafaYTApp`, streaming code is in `Streamer`.

Have a feature request? An implementation idea? Issues / PRs are open. If you like this project, please do leave a star, it would mean a lot to me.

## Installation for development

- Git clone and `uv sync`. Then `uv run main.py` as usual.