Skip to content

shrimpram/spot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Spot

About

spot is a command line utility that provides various functions for music. It defaults to the currently playing song on Spotify but accepts search queries as well.

Installation

Spot can be installed using Homebrew.

brew install shrimpram/tap/spot

Configuration

spot searches for a configuration file first at $XDG_CONFIG_HOME/spot/config.yml then at ~/.config/spot/config.yml

Genius Access Token

Mandatory. A Genius client access token that gives access to the Genius API, can be generated on your dashboard. You can define either the token directly or a shell command that spot should run to get the token. spot first checks for the token and then falls back to running the shell command. E.g.:

genius:
  token: "<Genius token here>"
  command: "pass show Genius"

Pager

Optional. The program spot should use to display lyrics. Falls back to your environment’s $PAGER if not defined. E.g.:

pager: "nvim +Man!"

Usage

spot [-a] [-l] [-n] [<query>]

Flags can be combined and the search query is optional. If there’s no search query spot defaults to the currently playing song.

-a: Saves the album cover art to the current directory.

-l: Gets lyrics from Genius and outputs them to either the pager specified in the configuration file or $PAGER.

-n: Sends a notification with the now-playing song using terminal-notifier.

About

A command line utility for music

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages