https://github.com/szktkfm/sptui

Spotify TUI player, written in Go
https://github.com/szktkfm/sptui

bubble bubbletea cli go spotify tui

Last synced: about 1 month ago
JSON representation

Spotify TUI player, written in Go

• Host: GitHub
• URL: https://github.com/szktkfm/sptui
• Owner: szktkfm
• License: mit
• Created: 2024-01-02T09:21:48.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-02-03T15:25:47.000Z (4 months ago)
• Last Synced: 2024-04-21T09:37:38.634Z (about 2 months ago)
• Topics: bubble, bubbletea, cli, go, spotify, tui
• Language: Go
• Homepage:
• Size: 3.59 MB
• Stars: 23
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• cli-apps - sptui - Spotify TUI player, written in Go. (<a name="music"></a>Sound and music)
• awesome-cli-apps - sptui - Spotify TUI player, written in Go. (<a name="music"></a>Sound and music)

README

        
# sptui

[![Go Report Card](https://goreportcard.com/badge/github.com/szktkfm/spotui)](https://goreportcard.com/report/github.com/szktkfm/sptoui)



## Overview

sptui is a Spotify TUI player, written in Go and leveraging the  [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea)  library. 

## Installation

Visit the  [GitHub Releases](https://github.com/szktkfm/sptui/releases) page for sptui and download the appropriate binary for your operating system.

## Usage

### Connecting to Spotify’s API

To use sptui, you need to connect it to Spotify's API. Follow these steps:

1. [Go to the Spotify Dashboard](https://developer.spotify.com/dashboard).

2. Create a new app to obtain your Client ID and Client Secret.

3. In `Edit Settings`, add `http://localhost:21112/callback` to the `Redirect URIs`. Don’t forget to save your changes.

4. Set your Client ID as an environment variable `SPOTIFY_ID`. 

5. Run sptui. You will see an official Spotify URL for authentication.

```bash

# Replace your_client_id with the actual Client ID you obtained from Spotify.

SPOTIFY_ID=your_client_id sptui

```

6. Open the provided URL in a web browser and log in to your Spotify account to grant the necessary permissions.

After granting permission, you might be redirected to a blank page. This is normal and indicates that the authentication process is complete.

Once authenticated, you are ready to use sptui!

### API Token Storage

Once authenticated, your Spotify API token will be stored at `${HOME}/.config/sptui/spotify_token.json`. Ensure this file is kept secure as it contains sensitive information.

### Key Bindings

Here are the key bindings for sptui:

| Key       | Action                           |

|-----------|----------------------------------|

| `h` `j` `k` `l` | Navigate (left, down, up, right) |

| `esc`     | Return to the previous screen           |

| `q`       | Quit sptui                       |

| `:play`   | Play current selection           |

| `:pause`  | Pause playback                   |

| `:next`   | Next track                       |

| `:prev`   | Previous track                   |

| `:device` | Select a device                  |