toshihidetagami / spotify-next

Small CLI app for filtering out music on Spotify.

spotify-next

A small program making it easier to filter out music on Spotify.

Installation

1. Create an application in the Spotify API dashboard. Add a redirect URI pointing to http://localhost:4321/login. The port 4321 is configured in the .spotify-next.json config file (see usage).

2. If you have coursier, this will install the app in your current working directory:

coursier bootstrap com.kubukoz:spotify-next_2.13:1.3.2 -o spotify-next

# now you can run the app like this:
./spotify-next --help

Build from source

Alternatively, if you want a fresh-out-of-the-oven version, you can build it from source:

1. sbt stage

This will create a launcher at ./target/universal/stage/bin/spotify-next.

Usage

The application requires some configuration (e.g. the client ID for the Spotify Web API). It's stored in a file at ~/.spotify-next.json. When you first run the application, or if that file is deleted, the application will ask and attempt to create one.

The configuration defines the port for the embedded HTTP server used for authentication. The server will only start when the login flow is triggered, and stop afterwards.

$ ./spotify-next --help

Usage:
    spotify-next login
    spotify-next skip
    spotify-next drop
    spotify-next forward
    spotify-next s
    spotify-next d
    spotify-next f
    spotify-next repl

spotify-next: Gather great music.

Options and flags:
    --help
        Display this help text.

Subcommands:
    login
        Log into Spotify
    skip
        Skip to next track without any changes
    drop
        Drop current track from the current playlist and skip to the next track
    forward
        Fast forward the current track by a percentage of its length (10% by default)
    s
        Alias for `skip`
    d
        Alias for `drop`
    f
        Alias for `forward`
    repl
        Run application in interactive mode

You can run the login command to be prompted for authorization, or you can rely on the fallback mechanism of all API calls - when one fails with 401 Unauthorized, you'll see the response and be prompted to log in. The call will be retried once after you successfully log in.

The application automatically saves the token to the configuration file after successful logins.

Limitations

Currently, it's impossible to control the playback on some devices (e.g. Sonos speakers) through the Spotify Web API.

As of version v1.3.0, spotify-next is able to work around that if the user has an instance of node-sonos-http-api running. Currently the instance has to run at localhost:5005 and only a single device can be controlled.

To get this workaround to be used, make sure the Sonos API is running before you start spotify-next - it'll be checked at startup to determine which API should be used for player control:

Loading REPL...
Checking if Sonos API is available at http://localhost:5005...
Found 1 zone(s), will use room Living Room
Welcome to the spotify-next REPL! Type in a command to begin
next>