spotify_player

Table of Contents

• Introduction
• Examples
• Installation
• Features
  • Spotify Connect
  • Streaming
  • Media Control
  • Image
  • Notify
  • Mouse support
  • Daemon
  • Fuzzy search
  • CLI commands
• Commands
• Configurations
• Caches
  • Logging
• Acknowledgement

Introduction

spotify_player is a fast, easy to use, and configurable terminal music player.

Features

• Minimalist UI with an intuitive paging and popup system.
• Highly configurable
• Feature parity with the official Spotify application.
• Support remote control with Spotify Connect.
• Support streaming songs directly from the terminal.
• Support synced lyrics.
• Support cross-platform media control.
• Support image rendering.
• Support desktop notification.
• Support running the application as a daemon
• Offer a wide range of CLI commands

Examples

A demo of spotify_player v0.5.0-pre-release on youtube or on asciicast:

Checkout examples/README.md for more examples.

Installation

By default, the application's installed binary is spotify_player.

Requirements

A Spotify Premium account is required.

Dependencies

Windows and MacOS

• Rust and cargo as the build dependencies

Linux

• Rust and cargo as the build dependencies
• install openssl, alsa-lib (streaming feature), libdbus (media-control feature).

  • For example, on Debian based systems, run the below command to install application's dependencies:

    sudo apt install libssl-dev libasound2-dev libdbus-1-dev

  • On RHEL/Fedora based systems, run the below command to install application's dependencies :

    sudo dnf install openssl-devel alsa-lib-devel dbus-devel

    or if you're using yum:

    sudo yum install openssl-devel alsa-lib-devel dbus-devel

Binaries

Application's prebuilt binaries can be found in the Releases Page.

Note: to run the application, Linux systems need to install additional dependencies as specified in the Dependencies section.

Homebrew

Run brew install spotify_player to install the application.

Scoop

Run scoop install spotify-player to install the application.

Cargo

Install via Cargo:

cargo install spotify_player --locked

Arch Linux

Install via Arch Linux:

pacman -S spotify-player

Note: Defaults to PulseAudio/Pipewire. For a different backend, modify the official PKGBUILD and rebuild manually. See Audio Backends.

Void Linux

Install via Void Linux:

xbps-install -S spotify-player

FreeBSD

Install via FreeBSD:

pkg install spotify-player

NetBSD

Install via NetBSD:

pkgin install spotify-player

Build from source on NetBSD:

cd /usr/pkgsrc/audio/spotify-player
make install

NixOS

spotify-player is available as a Nix package. Install via:

nix-shell -p spotify-player

To build from source locally, run nix-shell in the root of the source checkout. The provided shell.nix will install prerequisites.

Docker

Note: The streaming feature is disabled in the Docker image.

Download the latest Docker image:

docker pull aome510/spotify_player:latest

Run the Docker container:

docker run --rm -it aome510/spotify_player:latest

To use your local config and cache folders:

docker run --rm \
-v $APP_CONFIG_FOLDER:/app/config/ \
-v $APP_CACHE_FOLDER:/app/cache/ \
-it aome510/spotify_player:latest

Features

Spotify Connect

Control Spotify remotely with Spotify Connect. Press D to list devices, then enter to connect.

Streaming

Stream music directly from the terminal. The streaming feature is enabled by default and uses the rodio-backend audio backend unless otherwise specified.

The app uses librespot to create an integrated Spotify client, registering a spotify-player device accessible via Spotify Connect.

Audio backend

Default audio backend is rodio. Available backends:

• alsa-backend
• pulseaudio-backend
• rodio-backend
• portaudio-backend
• jackaudio-backend
• rodiojack-backend
• sdl-backend
• gstreamer-backend

To use a different audio backend, specify the --features option when building. For example:

cargo install spotify_player --no-default-features --features pulseaudio-backend

Notes:

• Use --no-default-features to disable the default rodio-backend.
• Additional dependencies may be required for some backends. See Librespot documentation.

To disable streaming, build with:

cargo install spotify_player --no-default-features

Media Control

Media control is enabled by default. Set enable_media_control to true in your config to use it. See config docs.

Media control uses MPRIS DBus on Linux and OS window events on Windows and macOS.

Image

To enable image rendering, build with the image feature (disabled by default):

cargo install spotify_player --features image

Full-resolution images are supported in Kitty and iTerm2. Other terminals display images as block characters.

To use sixel graphics, build with the sixel feature (also enables image):

cargo install spotify_player --features sixel

Notes:

• Not all terminals supported by libsixel are supported by spotify_player (see viuer supported terminals).
• Sixel images may scale oddly; adjust cover_img_scale for best results.

Image rendering examples:

• iTerm2:

• Kitty:

• Sixel (foot terminal, cover_img_scale=1.8):

• Others:

Pixelate

For a pixelated look, enable the pixelate feature (also enables image):

cargo install spotify_player --features pixelate

Adjust the pixelation with the cover_img_pixels config option.

cover_img_pixels	8	16	32	64
example

To temporarily disable pixelation, set cover_img_pixels to a high value (e.g., 512).

Notify

To enable desktop notifications, build with the notify feature (disabled by default):

cargo install spotify_player --features notify

Note: Notification support is limited on macOS and Windows compared to Linux.

Mouse support

Mouse support: You can seek to a position in the playback by left-clicking the progress bar.

Daemon

To enable daemon mode, build with the daemon feature (disabled by default):

cargo install spotify_player --features daemon

Run as a daemon with -d or --daemon: spotify_player -d.

Notes:

• Daemon mode is not supported on Windows.

• Daemon mode requires streaming and an audio backend.

• On macOS, daemon mode does not work with media control (enabled by default). To use daemon mode on macOS, disable media control:

  cargo install spotify_player --no-default-features --features daemon,rodio-backend

Fuzzy search

To enable fuzzy search, build with the fzf feature (disabled by default).

CLI Commands

spotify_player provides several CLI commands for interacting with Spotify:

• get: Get Spotify data (playlist/album/artist data, user's data, etc)
• playback: Interact with the playback (start a playback, play-pause, next, etc)
• search: Search spotify
• connect: Connect to a Spotify device
• like: Like currently playing track
• authenticate: Authenticate the application
• playlist: Playlist editing (new, delete, import, fork, etc)

For more details, run spotify_player -h or spotify_player {command} -h.

Notes

• On first use, run spotify_player authenticate to authenticate the app.
• CLI commands communicate with a client socket on port client_port (default: 8080). If no instance is running, a new client is started, which may increase latency.

Scripting

The command-line interface is script-friendly. Use the search subcommand to retrieve Spotify data in JSON format, which can be processed with tools like jq.

Example: Start playback for the first track from a search query:

read -p "Search spotify: " query
spotify_player playback start track --id $(spotify_player search "$query" | jq '.tracks.[0].id' | xargs)

Commands

Press ? or C-h to open the shortcut help page (default for OpenCommandHelp).

Tips:

• Use the Search command to search in the shortcut help page and other pages.
• RefreshPlayback manually updates playback status.
• RestartIntegratedClient is useful for switching audio devices without restarting the app.

List of supported commands:

Command	Description	Default shortcuts
NextTrack	next track	n
PreviousTrack	previous track	p
ResumePause	resume/pause based on the current playback	space
PlayRandom	play a random track in the current context	.
Repeat	cycle the repeat mode	C-r
Shuffle	toggle the shuffle mode	C-s
VolumeChange	change playback volume by an offset (default shortcuts use 5%)	+, -
Mute	toggle playback volume between 0% and previous level	_
SeekStart	seek start of current track	^
SeekForward	seek forward by a duration in seconds (defaults to seek_duration_secs)	>
SeekBackward	seek backward by a duration in seconds (defaults to seek_duration_secs)	<
Quit	quit the application	C-c, q
ClosePopup	close a popup	esc
SelectNextOrScrollDown	select the next item in a list/table or scroll down (supports vim-style count: 5j)	j, C-n, down
SelectPreviousOrScrollUp	select the previous item in a list/table or scroll up (supports vim-style count: 10k)	k, C-p, up
PageSelectNextOrScrollDown	select the next page item in a list/table or scroll a page down (supports vim-style count: 3C-f)	page_down, C-f
PageSelectPreviousOrScrollUp	select the previous page item in a list/table or scroll a page up (supports vim-style count: 2C-b)	page_up, C-b
SelectFirstOrScrollToTop	select the first item in a list/table or scroll to the top	g g, home
SelectLastOrScrollToBottom	select the last item in a list/table or scroll to the bottom	G, end
ChooseSelected	choose the selected item	enter
RefreshPlayback	manually refresh the current playback	r
RestartIntegratedClient	restart the integrated client (streaming feature only)	R
ShowActionsOnSelectedItem	open a popup showing actions on a selected item	g a, C-space
ShowActionsOnCurrentTrack	open a popup showing actions on the current track	a
ShowActionsOnCurrentContext	open a popup showing actions on the current context	A
AddSelectedItemToQueue	add the selected item to queue	Z, C-z
FocusNextWindow	focus the next focusable window (if any)	tab
FocusPreviousWindow	focus the previous focusable window (if any)	backtab
SwitchTheme	open a popup for switching theme	T
SwitchDevice	open a popup for switching device	D
Search	open a popup for searching in the current page	/
BrowseUserPlaylists	open a popup for browsing user's playlists	u p
BrowseUserFollowedArtists	open a popup for browsing user's followed artists	u a
BrowseUserSavedAlbums	open a popup for browsing user's saved albums	u A
CurrentlyPlayingContextPage	go to the currently playing context page	g space
TopTrackPage	go to the user top track page	g t
RecentlyPlayedTrackPage	go to the user recently played track page	g r
LikedTrackPage	go to the user liked track page	g y
LyricsPage	go to the lyrics page of the current track	g L, l
LibraryPage	go to the user library page	g l
SearchPage	go to the search page	g s
BrowsePage	go to the browse page	g b
Queue	go to the queue page	z
OpenCommandHelp	go to the command help page	?, C-h
PreviousPage	go to the previous page	backspace, C-q
OpenSpotifyLinkFromClipboard	open a Spotify link from clipboard	O
SortTrackByTitle	sort the track table (if any) by track's title	s t
SortTrackByArtists	sort the track table (if any) by track's artists	s a
SortTrackByAlbum	sort the track table (if any) by track's album	s A
SortTrackByAddedDate	sort the track table (if any) by track's added date	s D
SortTrackByDuration	sort the track table (if any) by track's duration	s d
SortLibraryAlphabetically	sort the library alphabetically	s l a
SortLibraryByRecent	sort the library (playlists and albums) by recently added items	s l r
ReverseOrder	reverse the order of the track table (if any)	s r
MovePlaylistItemUp	move playlist item up one position	C-k
MovePlaylistItemDown	move playlist item down one position	C-j
CreatePlaylist	create a new playlist	N
JumpToCurrentTrackInContext	jump to the current track in the context	g c
JumpToHighlightTrackInContext	jump to the currently highlighted search result in the context	C-g

To add or modify shortcuts, see the keymaps section.

Actions

Not all actions are available for every Spotify item. To see available actions, use ShowActionsOnCurrentTrack or ShowActionsOnSelectedItem, then press enter to trigger the action. Some actions may not appear in the popup but can be bound to shortcuts.

List of available actions:

• GoToArtist
• GoToAlbum
• GoToRadio
• AddToLibrary
• AddToPlaylist
• AddToQueue
• AddToLiked
• DeleteFromLiked
• DeleteFromLibrary
• DeleteFromPlaylist
• ShowActionsOnAlbum
• ShowActionsOnArtist
• ShowActionsOnShow
• ToggleLiked
• CopyLink
• Follow
• Unfollow

Actions can also be bound to shortcuts. To add new shortcuts, see the actions section.

Search Page

When entering the search page, focus is on the search input. Enter text, use backspace to delete, and enter to search.

To move focus from the search input to other windows (track results, album results, etc.), use FocusNextWindow or FocusPreviousWindow.

Configurations

By default, configuration files are located in $HOME/.config/spotify-player. Change this with -c <FOLDER_PATH> or --config-folder <FOLDER_PATH>.

If no configuration file is found, one will be created with default values.

See configuration documentation for details on available options.

Caches

By default, cache files are stored in $HOME/.cache/spotify-player (logs, credentials, audio cache, etc.). Change this with -C <FOLDER_PATH> or --cache-folder <FOLDER_PATH>.

Logging

Logs are stored in $APP_CACHE_FOLDER/spotify-player-*.log. For debugging or issues, check the backtrace file in $APP_CACHE_FOLDER/spotify-player-*.backtrace.

Set the RUST_LOG environment variable to control logging level. Default is spotify_player=INFO.

Acknowledgement

spotify_player is written in Rust and built on top of libraries like ratatui, rspotify, librespot, and more. It is inspired by spotify-tui and ncspot.