Spotify for the Terminal Written in Rust

Spotify TUI

A Spotify client for the terminal written in Rust.

Installation

The binary executable is spt .

Homebrew (macOS)

brew install Rigellute/tap/spotify-tui

Cargo (Linux)

If you already have the Rust toolchain installed, you can build from source and install using

cargo install spotify-tui

This method has the benefit of supporting more architectures.

I've only tested on Ubuntu and Debian, but I expect this to work on other Linux distros.

Manual

1. Download the latest binary (currently only for macOS).
2. cd to the file you just downloaded and unzip
3. cd to spotify-ui and run with ./spt

Connecting to Spotify’s API

spotify-tui needs to connect to Spotify’s API in order to find music by name, play tracks etc.

Instructions on how to set this up will be shown when you first run the app.

But here they are again:

1. Go to the Spotify dashboard
2. Click Create a Client ID and create an app
3. Now click Edit Settings
4. Add http://localhost:8888/callback to the Redirect URIs - you don't need anything running on localhost, it will still work
5. You are now ready to authenticate with Spotify!
6. Go back to the terminal
7. Enter you Client ID
8. Enter you Client Secret

You can edit the config at anytime at ${HOME}/.config/spotify-tui/client.yml .

After the Client ID and Client Secret are set you will be redirected to an official Spotify webpage to ask you for permissions.

Once accepted you will be redirected to localhost . Copy the URL and paste into the prompt back in the terminal. And now you are ready to use the spotify-tui !

Usage

The binary is named spt .

When running spotify-tui press ? to bring up a help menu that shows currently implemented key events and their actions.

Limitations

This app uses the Web API from Spotify, which doesn't handle streaming itself. So you'll need either an official Spotify client open or a lighter weight alternative such as spotifyd .

If you want to play tracks, Spotify requires that you have a Premium account.

Libraries used

• tui-rs
• rspotify

Roadmap

The goal is to eventually implement almost every Spotify feature.

High level requirements yet to be implemented

spotify-tui

This table shows all that is possible with the Spotify API, what is implemented already, and whether that is essential.

API method Implemented yet? Explanation Essential? track No returns a single track given the track's ID, URI or URL No tracks No returns a list of tracks given a list of track IDs, URIs, or URLs No artist No returns a single artist given the artist's ID, URI or URL Yes artists No returns a list of artists given the artist IDs, URIs, or URLs No artist_albums Yes Get Spotify catalog information about an artist's top 10 tracks by country. Yes artist_top_tracks No Get Spotify catalog information about artists similar to an Yes artist_related_artists No Get Spotify catalog information about artists similar to an identified artist. Similarity is based on analysis of the Spotify community's listening history. Yes album Yes returns a single album given the album's ID, URIs or URL Yes albums No returns a list of albums given the album IDs, URIs, or URLs No search_album Yes Search album based on query Yes search_artist Yes Search artist based on query Yes search_track Yes Search track based on query Yes search_playlist Yes Search playlist based on query Yes album_track Yes Get Spotify catalog information about an album's tracks Yes user No Gets basic profile information about a Spotify User No playlist Yes playlist Yes current_user_playlists Yes Get current user playlists without required getting his profile Yes user_playlists No Gets playlists of a user No user_playlist No Gets playlist of a user No user_playlist_tracks Yes Get full details of the tracks of a playlist owned by a user Yes user_playlist_create No Creates a playlist for a user Yes user_playlist_change_detail No Changes a playlist's name and/or public/private state Yes user_playlist_unfollow No Unfollows (deletes) a playlist for a user Yes user_playlist_add_track No Adds tracks to a playlist Yes user_playlist_replace_track No Replace all tracks in a playlist No user_playlist_recorder_tracks No Reorder tracks in a playlist No user_playlist_remove_all_occurrences_of_track No Removes all occurrences of the given tracks from the given playlist No user_playlist_remove_specific_occurrenes_of_track No Removes all occurrences of the given tracks from the given playlist No user_playlist_follow_playlist No Add the current authenticated user as a follower of a playlist. Yes user_playlist_check_follow No Check to see if the given users are following the given playlist Yes me No Get detailed profile information about the current user. Yes current_user No Alias for me Yes current_user_playing_track Yes Get information about the current users currently playing track. Yes current_user_saved_albums No Gets a list of the albums saved in the current authorized user's "Your Music" library Yes current_user_saved_tracks Yes Gets the user's saved tracks or "Liked Songs" current_user_followed_artists No Gets a list of the artists followed by the current authorized user Yes current_user_saved_tracks_delete No Remove one or more tracks from the current user's "Your Music" library. Yes current_user_saved_tracks_contain No Check if one or more tracks is already saved in the current Spotify user’s “Your Music” library. Yes current_user_saved_tracks_add No Save one or more tracks to the current user's "Your Music" library. Yes current_user_top_artists No Get the current user's top artists Yes current_user_top_tracks No Get the current user's top tracks Yes current_user_recently_played No Get the current user's recently played tracks Yes current_user_saved_albums_add No Add one or more albums to the current user's "Your Music" library. Yes current_user_saved_albums_delete No Remove one or more albums from the current user's "Your Music" library. Yes user_follow_artists No Follow one or more artists Yes user_unfollow_artists No Unfollow one or more artists Yes user_follow_users No Follow one or more users No user_unfollow_users No Unfollow one or more users No featured_playlists No Get a list of Spotify featured playlists Yes new_releases No Get a list of new album releases featured in Spotify Yes categories No Get a list of new album releases featured in Spotify Yes recommendations No Get Recommendations Based on Seeds Yes audio_features No Get audio features for a track No audios_feature No Get Audio Features for Several Tracks No audio_analysis No Get Audio Analysis for a Track No device Yes Get a User’s Available Devices Yes current_playback Yes Get Information About The User’s Current Playback Yes current_playing No Get the User’s Currently Playing Track No transfer_playback No Transfer a User’s Playback No start_playback Yes Start/Resume a User’s Playback Yes pause_playback Yes Pause a User’s Playback Yes next_track No Skip User’s Playback To Next Track Yes previous_track No Skip User’s Playback To Previous Track Yes seek_track No Seek To Position In Currently Playing Track Yes repeat No Set Repeat Mode On User’s Playback Yes volume No Set Volume For User’s Playback No shuffle No Toggle Shuffle For User’s Playback Yes