Skip to content

Latest commit

 

History

History
96 lines (56 loc) · 2.56 KB

README.md

File metadata and controls

96 lines (56 loc) · 2.56 KB

SpoTUI

Version Badge License Badge Code size Badge

Spotify in the terminal.

screenshot

Getting Started

Install with pip install spotui

Please Note: SpoTUI will not work with free Spotify accounts.

Register a developer application at: https://developer.spotify.com/dashboard/login. Once you create the application you'll need to edit it to add a Redirect URI. Use something like 'http://localhost:8888/callback' (it doesn't matter what you use really as long as it matches what's in your config file).

Run spotui to generate a sample config file at ~/.config/spotui/.spotuirc or create one manually with the following:

[spotify_api]
user_name = *Your spotify username*
client_id = *Your application client ID*
client_secret = *Your application secret*
redirect_uri = http://localhost:8888/callback

[other]
use_nerd_fonts = yes
config_version = 1 

Once you're done start the app with spotui, log in via your browser and copy the URL of the broken web page you're taken to. (This ugly authentication process is part of the underlying Spotipy library I use so don't blame me 😜)

This app acts like a kind of remote control for Spotify. The best way to use it is in conjunction with Spotifyd which means you won't need to actually have Spotify open. Alternatively, you can just open Spotify on your computer, phone etc. (press d to pick the device to play on).

Controls

Navigation

tab Switch section

k/ Up

j/ Down

g Scroll to top

G Scroll to bottom

Enter Select

/ Search

d Open device menu

Esc/q Quit/Back

Playback

space Play/Pause

n Next track

p Previous track

Seek 10s forwards

Seek 10s backwards

s Toggle shuffle

r Toggle repeat

FAQ

  • What do I do if something breaks? Raise an issue or submit a PR to fix my crappy code 🙏
  • Why can't I play anything? Check you have a device selected (d) and make sure you're using a paid Spotify account
  • I get an error page when I log into Spotify This is correct - just copy the URL and paste it back into the terminal
  • Podcasts aren't playing See: #13

Dependencies

LICENSE

MIT