huytd / xaudio-cli

TUI Youtube Player using Elm Architecture and mpv JSON IPC

Xaudio CLI

Xaudio CLI is a remake version of xaudio, focusing on CLI interface.

System requirements

Xaudio CLI uses MPV as a backend, so, make sure you have MPV installed:

brew instal mpv

To compile from source, you'll also need the Rust compiler, which is obvious.

How to run

To run, you'll need to create a .env file and put in your Youtube API key:

YOUTUBE_API_KEY=<your-key-here>

Then run the application with:

make

How to use

The app will start in Playlist mode, in this mode, you can:

• Hit / to search for songs
• Use j and k to navigate up and down
• Use < and > to switch between pages
• Hit Enter to play a song
• Use n and p to play next/previous song
• Hit Tab to go back to the previous search result

In the Search mode, you can type the song name to search and navigate with the same keybinding as the Playlist mode. You can also hit ESC to go back to the Playlist mode.

Technical Details

Please refer to DEVELOPMENT.md for more about the technical details:

• The Elm-like Architecture (src/ui.rs, MusicApp struct)
• mpv JSON IPC client (src/mpv.rs)
• Youtube API v3 (src/youtube.rs)