jamz

README

JAMZ

JAMZ is a terminal tool to manage your spotify playback need without leaving your terminal, perfect for choosing those productivity boosting songs and playlists without disrupting your workflow.

Getting started

What you need to run the program

• Go 1.16 or higher
• Spotify Credentials associated with a valid Spotify Premium account

If building locally set up your Spotify credentials in a credentials.yaml file as shown in the sample file provided. Alternatively, you can set up environment variables with your SPOTIFY_SECRET and SPOTIFY_ID to authenticate the app. You will need to click the provided link to authenticate the app from the Spotify dashboard to get started.

How to run

Locally

1. Clone this git repo git clone https://github.com/Smelton01/jamz
2. Install/Build the binary

   cd jamz
   go build or go install
   

3. Run the program

   jamz [command]
   

Docker

1. Build image

Docker build --tag jamz .

1. Run the container

Docker run jamz

Usage

The executable comes with a few CLI commnds for quick access and a TUI for browsing through your music

CLI

Run jamz [command]

Supported commands

• play resume playback on your currently active device
• pause pause playback
• next skip to the next track in your queue
• prev skip back to the previous track

TUI

TODO

Contributing

Contributions are very welcome so feel free to open an issue or submit a PR if you would like to contribute to the project.

License

MIT License

Credits

Jamz is built using:

• BubbleTea for the UI
• Spotify API wrapper

Documentation

Overview

Copyright © 2021 Simon Juba

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.