spotatui docs

spotatui is a fast music player for the terminal and the desktop, written in Rust: Spotify through its own built-in client, plus local files, Subsonic/Navidrome, internet radio, YouTube and Qobuz, and Apple Music on macOS.

Get started

  • Installation: every way to install, the desktop app, updates, and building from source.
  • Configuration: config.yml, the sources, layout, icons, tables, Discord, the visualizer and logging.
  • Keybindings: every key and how to rebind it.
  • Themes: the built-in presets and your own colors.

Features

  • Native streaming: play Spotify in spotatui itself, and where else Spotify can play.
  • Soloist: play Spotify through Spotify's own player, for lossless audio or an account that native streaming cannot play.
  • CLI: control spotatui from your shell.
  • Playlist sync: mirror one playlist onto other sources.
  • Listening Party: listen in sync with friends.
  • Friends: see what your friends play.
  • AI DJ: let a model pick the music inside spotatui.
  • MCP setup: make your coding agent the DJ.
  • Scripting: the Lua plugin API. PLUGINS.md lists plugins to install.

Community setups

Unofficial setups that people got working. They are not supported installs.

  • Android TV box: the terminal app fullscreen on a TV, through Termux and a Debian container.

Help

Edit on GitHub