Skip to content
main
Switch branches/tags
Code

Ytui-music

Listen to music from youtube inside terminal with sleek tui

Ytui-music Search Result

See more screenshots


Installation

  1. Download latest binary from release page. If binary is not available for your platform head on to build from source

  2. Give it executable permission and from downloaded directory, in shell:

ytui_music run
  1. You may need to jump to Usage Guide

Dependencies

Ytui-music depends on mpv and youtube-dl. You may refer to the offical website of mpv and website of youtube-dl.

If you have choco for windows or brew in mac or one of popular package manager in linux you may do:

- Windows (In powershell or cmd)

choco install mpv youtube-dl

- Mac

brew install mpv youtube-dl

- Debain/ Ubuntu Deriatives

sudo apt update && sudo apt install youtube-dl libmpv1

For other distribution install youtube-dl and mpv package the way you please


Before running ytui-music

Before you start with ytui-music make sure that Following directory exist and have write permission to ytui-music in order to save configuration file

Windows

C:\Users\<username>\AppData\Roaming or anv var {FOLDERID_RoamingAppData}

Mac

/Users/<username>/Library/Application Support or $HOME/Library/Application Support

Linux

$HOME/.config/ or /home/<username>/.config or env var $XDG_CONFIG_HOME


Building from Source

Ytui-music is written entirely in Rust and thus making is dead simple to build from source. All you have to do is download source, install rust and build with cargo.

  1. Installing rust. Head to Rust installation. It is basically doing
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  1. Get the source code. You can download archives or git clone
git clone git@github.com:sudipghimire533/ytui-music
  1. cd into source root and do:
cargo build --all --release
  1. The compiled binary is located in target/release/ directory. Copy the ytui_music binary and place it somewhere where it is easy to run.

  2. Ytui-music is now ready to fire. Head to usage


Usage

ytui-music is single binary so it shouldn't be of any hassale to run. Just make sure you have installation of dependencies.

- Running ytui-music

ytui_music run

- Showing help message

ytui_music help

- Showing current configured shortcuts

ytui_music info shortcuts

- Showing version information

ytui_music infor version

Searching

  1. Press / to go to search box
  2. Type
    • music:Bartika Eam Rai to search only for music result for query "Bartika Eam Rai"
    • playlist:Soft pop hits to search only for playlist for query "Soft pop hits"
    • artist:Bibash Jk to search only for artist for query "Bibash Jk"
    • Coding music to search all of playlist, music and artist at once for query "Coding music"
  3. Press Enter key

Navigating

  • Use Left arrow or Backspace for backward and Right arrow or Tab key for forward to move between Sidebar, Musicbar, Playlistbar and Artistbar
  • Use Up arrow or Down arrow to move up or down in the list which will hilight the list item
  • Press Enter key to select an item

Playback control

  • Press Space key to pause/unpause the playback
  • Press s key to toggle suffle/unsuffle
  • Press r key to repeat single or all item in playlist
  • Press > for forward and < for backward playback seek
  • Press CTRL+n for next and CTRL+p to change track

Downloading

  1. Hilight the item you want to download. Currently downloading of music and playlist is supported.
  2. Press CTRL+d to download the selection

Quitting

  • Press CTRL+c to quit ytui-music
  • If download is ongoing press CTRL+ALT+C to force quit

Adding to favourates

  1. Hilight the item you want to add or remove from favourates
  2. Press f to add or u to remove from favourates
  3. To see your list
    • Favourtaes music are shown in Liked section in sidebar
    • Favourates playlist are shown in My playlist section in sidebar
    • Favourtaes artist are shown in Following section in sidebar

Screenshots

This is what ytui-music looks like. It may even look better on yours. ;)

Click to see screenshots

Initial Screen Searching Music Search Results Responsive Ui Music Info Playing Music