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

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

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

Checkout examples/README.md for more examples.

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

A Spotify Premium account is required.

• Rust and cargo as the build dependencies

• 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

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.

Run brew install spotify_player to install the application.

Run scoop install spotify-player to install the application.

Install via Cargo:

cargo install spotify_player --locked

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.

Install via Void Linux:

xbps-install -S spotify-player

Install via FreeBSD:

pkg install spotify-player

Install via NetBSD:

pkgin install spotify-player

Build from source on NetBSD:

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

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.

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

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

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.

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 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.

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:

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).

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: You can seek to a position in the playback by left-clicking the progress bar.

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

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

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.

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)

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:

To add or modify shortcuts, see the keymaps section.

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.

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.

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.

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>.

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.

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.