yamusic-tui

An unofficial Yandex Music terminal client.
Based on yandex-music-open-api.

Requirements

To use this client, you should have a valid Yandex Music account and an access token.
The easiest way to get a token is to use a browser extension (Chrome, Firefox).

Implemented features

• Player
  • Play/pause
  • Switch track
  • Play progress
  • Rewind
  • Like/unlike
  • Share
  • Synced lyrics
• Radio
  • My wave
  • Radio configuration
• Likes
  • Liked tracks
  • Liked playlists
  • Liked artists
  • Liked albums
• Playlists
  • Display user playlists
  • Play from playlist
  • Add/remove track to playlist
  • Create/remove playlist
  • Rename playlist
• Caching
• Search
• Landing

Installation

If you have Go installed on your PC:

go install github.com/dece2183/yamusic-tui@latest

Or just download the binary from the releases page.

Configuration

The configuration file is located at ~/.config/yamusic-tui/config.yaml.

This is the default configuration which is automatically created after the first login:

token: <your yandex music token>
buffer-size-ms: 80
rewind-duration-s: 5
volume: 0.5
volume-step: 0.05
show-errors: false
show-lyrics: false
cache-tracks: likes # none/likes/all
cache-dir: ""
search:
    artists: true
    albums: false
    playlists: false
controls:
   quit: ctrl+q,ctrl+c
   apply: enter
   cancel: esc
   cursor-up: up
   cursor-down: down
   show-all-keys: ?
   playlists-up: ctrl+up
   playlists-down: ctrl+down
   playlists-rename: ctrl+r
   tracks-like: l
   tracks-add-to-playlist: a
   tracks-remove-from-playlist: ctrl+a
   tracks-share: ctrl+s
   tracks-shuffle: ctrl+x
   tracks-search: ctrl+f
   player-pause: space
   player-next: right
   player-previous: left
   player-rewind-forward: ctrl+right
   player-rewind-backward: ctrl+left
   player-like: L
   player-cache: S
   player-vol-up: +,=
   player-vol-down: '-'

By default, all cached tracks are stored in the system cache directory. ~/.cache/yamusic-tui on Linux and ~/AppData/Local/yamusic-tui on Windows. You can change this behavior by specifying a preferred cache directory in the cache-dir field.

You can list multiple keys for the same control, separated by commas.

Increase the buffer-size-ms if you have glitches or stutters.

System media controls

Yamusic-tui supports the system media control interfaces: MPRIS on Linux and SMTC on Windows (there is currently no implementation for MacOS).

This feature is enabled by default, however for compatibility reasons you can disable it by building the app with the nomedia tag or downloading a release with the -nomedia suffix.

go build -tags='nomedia'