Skip to content
Spotify for the terminal written in Rust 🚀
Rust Other
  1. Rust 99.1%
  2. Other 0.9%
Branch: master
Clone or download
Latest commit 1dfa026 Oct 18, 2019

README.md

Spotify TUI

Crates.io

A Spotify client for the terminal written in Rust.

Demo

The terminal in the demo above is using the Rigel theme.

Installation

The binary executable is spt.

Homebrew (macOS)

brew install Rigellute/tap/spotify-tui

To update, run

brew upgrade spotify-tui

Cargo (Linux)

Eventually, there should be prebuilt binaries available in the Github release, but until then you can install via Rust's package manager cargo.

First, install Rust (using the recommended rustup installation method) and then

cargo install spotify-tui

This method will build the binary from source, so 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.

To update, run

cargo install spotify-tui --force

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
  5. You are now ready to authenticate with Spotify!
  6. Go back to the terminal
  7. Run spt
  8. Enter your Client ID
  9. Enter your Client Secret
  10. You will be redirected to an official Spotify webpage to ask you for permissions.
  11. After accepting the permissions, you'll be redirected to localhost (blank webpage, might say something like "Connection Refused" since no server is running), copy the URL and paste into the prompt in the terminal.

And now you are ready to use the spotify-tui 🎉

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

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.

Using with spotifyd

Follow the spotifyd documentation to get set up.

After that there is not much to it.

  1. Start running the spotifyd daemon.
  2. Start up spt
  3. Press d to go to the device selection menu and the spotifyd "device" should be there - if not check these docs

Libraries used

Development

  1. Install OpenSSL
  2. Install Rust
  3. Clone or fork this repo and cd to it
  4. And then cargo run

Roadmap

The goal is to eventually implement almost every Spotify feature.

High level requirements yet to be implemented

  • Add songs to a playlist
  • Be able to like songs in every view, and see that a given track is already liked.
  • Unlike songs
  • See if a song is liked
  • Be able to scroll through result pages in every view
  • View Library "Made for you"
  • Make the play bar hoverable with its own event handlers that would
    • Like the playing song
    • Navigate to song info

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 Yes 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 Yes Skip User’s Playback To Next Track Yes
previous_track Yes Skip User’s Playback To Previous Track Yes
seek_track No Seek To Position In Currently Playing Track Yes
repeat Yes Set Repeat Mode On User’s Playback Yes
volume No Set Volume For User’s Playback No
shuffle Yes Toggle Shuffle For User’s Playback Yes
You can’t perform that action at this time.