Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Rigellute/spotify-tui

Spotify for the terminal written in Rust 🚀
https://github.com/Rigellute/spotify-tui

cli rust spotify spotify-api spotify-tui terminal terminal-based

Last synced: 13 days ago
JSON representation

Spotify for the terminal written in Rust 🚀

Host: GitHub
URL: https://github.com/Rigellute/spotify-tui
Owner: Rigellute
License: mit
Created: 2019-08-16T19:31:53.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-04-04T15:03:12.000Z (7 months ago)
Last Synced: 2024-10-14T15:25:23.546Z (25 days ago)
Topics: cli, rust, spotify, spotify-api, spotify-tui, terminal, terminal-based
Language: Rust
Homepage:
Size: 2.29 MB
Stars: 17,429
Watchers: 76
Forks: 522
Open Issues: 298
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-cli-apps - spotify-tui - Spotify client. (Entertainment / Music)
awesome-starred-test - Rigellute/spotify-tui - Spotify for the terminal written in Rust 🚀 (Rust)
awesome - Rigellute/spotify-tui - Spotify for the terminal written in Rust 🚀 (Rust)
awesome-rust-cn - Spotify TUI
vim-keybindings-everywhere-the-ultimate-list - spotify-tui - TUI for Spotify with Vim-like keybindings. (Music Players)
awesome-repositories - Rigellute/spotify-tui
stars - Rigellute/spotify-tui - Spotify for the terminal written in Rust 🚀 (Rust)
fucking-awesome-cli-apps - spotify-tui - Spotify client. (Entertainment / Music)
awesome-linux-ricing - spotify-tui - spotify (Terminal / Apps and Tools)
StarryDivineSky - Rigellute/spotify-tui
jimsghstars - Rigellute/spotify-tui - Spotify for the terminal written in Rust 🚀 (Rust)
awesome-ratatui - spotify-tui - (DEPRECATED; See `spotify-player`) Spotify client for the terminal. (💻 Apps / 🎼 Music and Media)

README

# Spotify TUI

![Continuous Integration](https://github.com/Rigellute/spotify-tui/workflows/Continuous%20Integration/badge.svg?branch=master&event=push)
![](https://img.shields.io/badge/license-MIT-blueviolet.svg)
![](https://tokei.rs/b1/github/Rigellute/spotify-tui?category=code)
[![Crates.io](https://img.shields.io/crates/v/spotify-tui.svg)](https://crates.io/crates/spotify-tui)
![](https://img.shields.io/github/v/release/Rigellute/spotify-tui?color=%23c694ff)

[![All Contributors](https://img.shields.io/badge/all_contributors-94-orange.svg?style=flat-square)](#contributors-)

[![Follow Alexander Keliris (Rigellute)](https://img.shields.io/twitter/follow/AlexKeliris?label=Follow%20Alexander%20Keliris%20%28Rigellute%29&style=social)](https://twitter.com/intent/follow?screen_name=AlexKeliris)

A Spotify client for the terminal written in Rust.

![Demo](https://user-images.githubusercontent.com/12150276/75177190-91d4ab00-572d-11ea-80bd-c5e28c7b17ad.gif)

The terminal in the demo above is using the [Rigel theme](https://rigel.netlify.com/).

- [Spotify TUI](#spotify-tui)
- [Installation](#installation)
- [Homebrew](#homebrew)
- [Snap](#snap)
- [AUR](#aur)
- [Nix](#nix)
- [Void Linux](#void-linux)
- [Fedora/CentOS](#fedora-centos)
- [Cargo](#cargo)
- [Note on Linux](#note-on-linux)
- [Windows](#windows-10)
- [Scoop installer](#scoop-installer)
- [Manual](#manual)
- [Connecting to Spotify’s API](#connecting-to-spotifys-api)
- [Usage](#usage)
- [Configuration](#configuration)
- [Limitations](#limitations)
- [Using with spotifyd](#using-with-spotifyd)
- [Libraries used](#libraries-used)
- [Development](#development)
- [Windows Subsystem for Linux](#windows-subsystem-for-linux)
- [Contributors](#contributors)
- [Roadmap](#roadmap)
- [High-level requirements yet to be implemented](#high-level-requirements-yet-to-be-implemented)

## Installation

The binary executable is `spt`.

### Homebrew

For both macOS and Linux

```bash
brew install spotify-tui
```

To update, run

```bash
brew upgrade spotify-tui
```

### Snap

For a system with Snap installed, run

```bash
snap install spt
```

The stable version will be installed for you automatically.

If you want to install the nightly build, run

```bash
snap install spt --edge
```

### AUR

For those on Arch Linux you can find the package on AUR [here](https://aur.archlinux.org/packages/spotify-tui/). If however you're using an AUR helper you can install directly from that, for example (in the case of [yay](https://github.com/Jguer/yay)), run

```bash
yay -S spotify-tui
```

### Nix

Available as the package `spotify-tui`. To install run:

```bash
nix-env -iA nixpkgs.spotify-tui
```

Where `nixpkgs` is the channel name in your configuration. For a more up-to-date installation, use the unstable channel.
It is also possible to add the package to `environment.systemPackages` (for NixOS), or `home.packages` when using [home-manager](https://github.com/rycee/home-manager).

### Void Linux

Available on the official repositories. To install, run

```bash
sudo xbps-install -Su spotify-tui
```

### Fedora/CentOS

Available on the [Copr](https://copr.fedorainfracloud.org/coprs/atim/spotify-tui/) repositories. To install, run

```bash
sudo dnf copr enable atim/spotify-tui -y && sudo dnf install spotify-tui
```

### Cargo

Use this option if your architecture is not supported by the pre-built binaries found on the [releases page](https://github.com/Rigellute/spotify-tui/releases).

First, install [Rust](https://www.rust-lang.org/tools/install) (using the recommended `rustup` installation method) and then

```bash
cargo install spotify-tui
```

This method will build the binary from source.

To update, run the same command again.

#### Note on Linux

For compilation on Linux the development packages for `libssl` are required.
For basic installation instructions, see [install OpenSSL](https://docs.rs/openssl/0.10.25/openssl/#automatic).
In order to locate dependencies, the compilation also requires `pkg-config` to be installed.

If you are using the Windows Subsystem for Linux, you'll need to [install additional dependencies](#windows-subsystem-for-linux).

### Windows 10

#### Scoop installer

First, make sure scoop installer is on your windows box, for instruction please visit [scoop.sh](https://scoop.sh)

Then open powershell and run following two commands:

```bash
scoop bucket add scoop-bucket https://github.com/Rigellute/scoop-bucket
scoop install spotify-tui
```

After that program is available as: `spt` or `spt.exe`

### Manual

1. Download the latest [binary](https://github.com/Rigellute/spotify-tui/releases) for your OS.
1. `cd` to the file you just downloaded and unzip
1. `cd` to `spotify-tui` 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](https://developer.spotify.com/dashboard/applications)
1. Click `Create an app`
- You now can see your `Client ID` and `Client Secret`
1. Now click `Edit Settings`
1. Add `http://localhost:8888/callback` to the Redirect URIs
1. Scroll down and click `Save`
1. You are now ready to authenticate with Spotify!
1. Go back to the terminal
1. Run `spt`
1. Enter your `Client ID`
1. Enter your `Client Secret`
1. Press enter to confirm the default port (8888) or enter a custom port
1. You will be redirected to an official Spotify webpage to ask you for permissions.
1. After accepting the permissions, you'll be redirected to localhost. If all goes well, the redirect URL will be parsed automatically and now you're done. If the local webserver fails for some reason you'll be redirected to a blank webpage that might say something like "Connection Refused" since no server is running. Regardless, 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`. (for snap `${HOME}/snap/spt/current/.config/spotify-tui/client.yml`)

## Usage

The binary is named `spt`.

Running `spt` with no arguments will bring up the UI. Press `?` to bring up a help menu that shows currently implemented key events and their actions.
There is also a CLI that is able to do most of the stuff the UI does. Use `spt --help` to learn more.

Here are some example to get you excited.
```
spt --completions zsh # Prints shell completions for zsh to stdout (bash, power-shell and more are supported)

spt play --name "Your Playlist" --playlist --random # Plays a random song from "Your Playlist"
spt play --name "A cool song" --track # Plays 'A cool song'

spt playback --like --shuffle # Likes the current song and toggles shuffle mode
spt playback --toggle # Plays/pauses the current playback

spt list --liked --limit 50 # See your liked songs (50 is the max limit)

# Looks for 'An even cooler song' and gives you the '{name} from {album}' of up to 30 matches
spt search "An even cooler song" --tracks --format "%t from %b" --limit 30
```

# Configuration

A configuration file is located at `${HOME}/.config/spotify-tui/config.yml`, for snap `${HOME}/snap/spt/current/.config/spotify-tui/config.yml`
(not to be confused with client.yml which handles spotify authentication)

The following is a sample config.yml file:

```yaml
# Sample config file

# The theme colours can be an rgb string of the form "255, 255, 255" or a string that references the colours from your terminal theme: Reset, Black, Red, Green, Yellow, Blue, Magenta, Cyan, Gray, DarkGray, LightRed, LightGreen, LightYellow, LightBlue, LightMagenta, LightCyan, White.
theme:
active: Cyan # current playing song in list
banner: LightCyan # the "spotify-tui" banner on launch
error_border: Red # error dialog border
error_text: LightRed # error message text (e.g. "Spotify API reported error 404")
hint: Yellow # hint text in errors
hovered: Magenta # hovered pane border
inactive: Gray # borders of inactive panes
playbar_background: Black # background of progress bar
playbar_progress: LightCyan # filled-in part of the progress bar
playbar_progress_text: Cyan # song length and time played/left indicator in the progress bar
playbar_text: White # artist name in player pane
selected: LightCyan # a) selected pane border, b) hovered item in list, & c) track title in player
text: "255, 255, 255" # text in panes
header: White # header text in panes (e.g. 'Title', 'Artist', etc.)

behavior:
seek_milliseconds: 5000
volume_increment: 10
# The lower the number the higher the "frames per second". You can decrease this number so that the audio visualisation is smoother but this can be expensive!
tick_rate_milliseconds: 250
# Enable text emphasis (typically italic/bold text styling). Disabling this might be important if the terminal config is otherwise restricted and rendering text escapes interferes with the UI.
enable_text_emphasis: true
# Controls whether to show a loading indicator in the top right of the UI whenever communicating with Spotify API
show_loading_indicator: true
# Disables the responsive layout that makes the search bar smaller on bigger
# screens and enforces a wide search bar
enforce_wide_search_bar: false
# Determines the text icon to display next to "liked" Spotify items, such as
# liked songs and albums, or followed artists. Can be any length string.
# These icons require a patched nerd font.
liked_icon: ♥
shuffle_icon: 🔀
repeat_track_icon: 🔂
repeat_context_icon: 🔁
playing_icon: ▶
paused_icon: ⏸
# Sets the window title to "spt - Spotify TUI" via ANSI escape code.
set_window_title: true

keybindings:
# Key stroke can be used if it only uses two keys:
# ctrl-q works,
# ctrl-alt-q doesn't.
back: "ctrl-q"

jump_to_album: "a"

# Shift modifiers use a capital letter (also applies with other modifier keys
# like ctrl-A)
jump_to_artist_album: "A"

manage_devices: "d"
decrease_volume: "-"
increase_volume: "+"
toggle_playback: " "
seek_backwards: "<"
seek_forwards: ">"
next_track: "n"
previous_track: "p"
copy_song_url: "c"
copy_album_url: "C"
help: "?"
shuffle: "ctrl-s"
repeat: "r"
search: "/"
audio_analysis: "v"
jump_to_context: "o"
basic_view: "B"
add_item_to_queue: "z"
```

## Limitations

This app uses the [Web API](https://developer.spotify.com/documentation/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](https://github.com/Spotifyd/spotifyd).

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

## Using with [spotifyd](https://github.com/Spotifyd/spotifyd)

Follow the spotifyd documentation to get set up.

After that there is not much to it.

1. Start running the spotifyd daemon.
1. Start up `spt`
1. Press `d` to go to the device selection menu and the spotifyd "device" should be there - if not check [these docs](https://github.com/Spotifyd/spotifyd#logging)

## Libraries used

- [tui-rs](https://github.com/fdehau/tui-rs)
- [rspotify](https://github.com/ramsayleung/rspotify)

## Development

1. [Install OpenSSL](https://docs.rs/openssl/0.10.25/openssl/#automatic)
1. [Install Rust](https://www.rust-lang.org/tools/install)
1. [Install `xorg-dev`](https://github.com/aweinstock314/rust-clipboard#prerequisites) (required for clipboard support)
1. Clone or fork this repo and `cd` to it
1. And then `cargo run`

### Windows Subsystem for Linux

You might get a linking error. If so, you'll probably need to install additional dependencies required by the clipboard package

```bash
sudo apt-get install -y -qq pkg-config libssl-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
```

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Alexander Keliris}
💻 📖 🎨 📝 🤔 🚇 🚧 📦 👀

_{Mickael Marques}
💵

_{Grzegorz Koperwas}
📖

_{Austin Gassert}
💻

_{Calen Robinette}
💻

_M*C*O
🚇

_{Andrew Chin}
💻

_{Sam Naser}
💻

_Micha
💻

_neriglissar
💻

_Timon
💻

_echoSayonara
💻

_D-Nice
📖 🚇

_{Grzegorz Pawlik}
💻

_{Lennart Bernhardt}
💻

_{Arnaud Lefebvre}
💻

_tem1029
💻

_{Peter K. Moss}
💻

_{Geoff Shannon}
💻

_{Zachary Mayhew}
💻

_jfaltis
💻

_{Marcel Schramm}
📖

_{Fangyi Zhou}
💻

_Max
💻

_{Sven van der Vlist}
💻

_{jacobchrismarsh}
💻

_{Nils Rauch}
💻

_{Nick Stockton}
💻 🐛 🚧 💬 📖

_{Stuart Hinson}
💻

_{Sam Calvert}
💻 📖

_{Jeroen Wijenbergh}
📖

_{Kimberley Cook}
📖

_{Audrey Baxter}
💻

_Norman
📖

_{Peter Maatman}
💻

_AlexandreS
💻

_{Finn Vos}
💻

_{Carlos Hernandez}
📦

_{Pedro Alves}
💻

_jtagcat
📖

_{Benjamin Kitor}
💻

_{Aleš Najmann}
📖 📦

_{Jeremy Stucki}
💻

_(´⌣`ʃƪ)
💻

_{Artem Polishchuk}
📦

_{Chris Sosnin}
💻

_{Ben Buhse}
📖

_{Sean Li}
💻

_{TimotheeGerber}
💻 📖

_{Ferdinand Ratajczak}
💻

_{Sheel Choksi}
💻

_{Michael Hellwig}
📖

_{Oliver Daniel}
💻

_{Drew Fisher}
💻

_ncoder-1
📖

_{Macguire Rintoul}
📖

_{Ricardo Holguin}
💻

_{Keisuke Toyota}
💻

_{Craig Astill}
💻

_Onielfa
💻

_usrme
📖

_{Sergey A.}
💻

_{Hideyuki Okada}
💻

_kepae
💻 📖

_{Érico Nogueira Rolim}
💻

_{Alexander Meinhardt Scheurer}
💻

_{Ondřej Kinšt}
💻

_Kryan90
📖

_n-ivanov
💻

_bi1yeu
💻 📖

_May
💻

_{Bruno A. Muciño}
💻

_{Finn Hediger}
💻

_dp304
💻

_{Marco Micera}
📖

_{Marco Ieni}
🚇

_{Artúr Kovács}
💻

_{Antony Kellermann}
💻

_{Rasmus Pedersen}
💻

_noir-Z
📖

_{David Bailey}
📖

_sheepwall
💻

_Hwatwasthat
💻

_Jesse
💻

_Sang
📖

_{Yuuki Takahashi}
📖

_{Alejandro Angulo}
💻

_{Anton Kostin}
📖

_{Justin Sexton}
💻

_{Jiati Le}
📖

_{Matthew Cobbing}
💻

_Milo
🚇

_{Diego Veralli}
💻

_{Maja Bojarska}
💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## 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 scroll through result pages in every view

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 albums | Yes |
| artist_top_tracks | Yes | Get Spotify catalog information about an artist's top 10 tracks by country. | Yes |
| artist_related_artists | Yes | 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 | Get full details about Spotify 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 | Yes | 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 | Yes | 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 | Yes | 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" | Yes |
| current_user_followed_artists | Yes | Gets a list of the artists followed by the current authorized user | Yes |
| current_user_saved_tracks_delete | Yes | 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 | Yes | Get the current user's recently played tracks | Yes |
| current_user_saved_albums_add | Yes | Add one or more albums to the current user's "Your Music" library. | Yes |
| current_user_saved_albums_delete | Yes | Remove one or more albums from the current user's "Your Music" library. | Yes |
| user_follow_artists | Yes | Follow one or more artists | Yes |
| user_unfollow_artists | Yes | 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 categories used to tag items in Spotify | Yes |
| recommendations | Yes | Get Recommendations Based on Seeds | Yes |
| audio_features | No | Get audio features for a track | No |
| audios_features | No | Get Audio Features for Several Tracks | No |
| audio_analysis | Yes | Get Audio Analysis for a Track | Yes |
| 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 | Yes | Transfer a User’s Playback | Yes |
| 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 | Yes | Seek To Position In Currently Playing Track | Yes |
| repeat | Yes | Set Repeat Mode On User’s Playback | Yes |
| volume | Yes | Set Volume For User’s Playback | Yes |
| shuffle | Yes | Toggle Shuffle For User’s Playback | Yes |