https://github.com/hrkfdn/ncspot

Cross-platform ncurses Spotify client written in Rust, inspired by ncmpc and the likes.
https://github.com/hrkfdn/ncspot

Last synced: about 1 month ago
JSON representation

Cross-platform ncurses Spotify client written in Rust, inspired by ncmpc and the likes.

• Host: GitHub
• URL: https://github.com/hrkfdn/ncspot
• Owner: hrkfdn
• License: bsd-2-clause
• Created: 2018-11-10T23:00:46.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-16T19:57:39.000Z (5 months ago)
• Last Synced: 2024-07-16T23:48:19.873Z (5 months ago)
• Language: Rust
• Homepage:
• Size: 2.96 MB
• Stars: 4,813
• Watchers: 34
• Forks: 206
• Open Issues: 127
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/hrkfdn/ncspot - ncurses Spotify (Jump To / CLI/TUI Apps)
• awesome-linux-minimalism - ncspot - Command line spotify player for linux (Uncategorized / Uncategorized)
• awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/hrkfdn/ncspot - ncurses Spotify (Jump To / CLI/TUI Apps)
• awesome-rust - ncspot - Cross-platform ncurses Spotify client, inspired by ncmpc and the likes. [](https://github.com/hrkfdn/ncspot/actions?query=workflow%3ABuild) (Applications / Audio and Music)
• awesome-rust-cn - ncspot - 跨平台的ncurses (应用程序 Applications / 音频和音乐 Audio and Music)
• awesome-browserless - ncspot - Cross-platform ncurses Spotify client written in Rust, inspired by ncmpc and the likes. (Radio and podcasts / Misc)
• awesome-rust - ncspot - Cross-platform ncurses Spotify client, inspired by ncmpc and the likes. [](https://github.com/hrkfdn/ncspot/actions?query=workflow%3ABuild) (Applications / Audio and Music)
• fucking-awesome-rust - ncspot - Cross-platform ncurses Spotify client, inspired by ncmpc and the likes. [](https://github.com/hrkfdn/ncspot/actions?query=workflow%3ABuild) (Applications / Audio and Music)
• fucking-awesome-rust - ncspot - Cross-platform ncurses Spotify client, inspired by ncmpc and the likes. [](https://github.com/hrkfdn/ncspot/actions?query=workflow%3ABuild) (Applications / Audio and Music)

README

        


  

    

    

    

  

  
An ncurses Spotify client written in Rust using librespot


[![Crates.io](https://img.shields.io/crates/v/ncspot.svg)](https://crates.io/crates/ncspot)

[![Gitter](https://badges.gitter.im/ncspot/community.svg)](https://gitter.im/ncspot/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

  



ncspot is an ncurses Spotify client written in Rust using librespot. It is heavily inspired by

ncurses MPD clients, such as [ncmpc](https://musicpd.org/clients/ncmpc/). My motivation was to

provide a simple and resource friendly alternative to the official client as well as to support

platforms that currently don't have a Spotify client, such as the \*BSDs.

ncspot only works with a Spotify premium account as it offers features that are not available for

free accounts.

## Features

- Support for tracks, albums, playlists, genres, searching...

- Small [resource footprint](doc/resource_footprint.md)

- Support for a lot of platforms

- Vim keybindings out of the box

- IPC socket for remote control

- Automatic authentication using a password manager

## Installation

ncspot is available on macOS (Homebrew), Windows (Scoop, WinGet), Linux (native package, Flathub and

Snapcraft) and the BSD's. Detailed installation instructions for each platform can be found

[here](/doc/users.md).

## Configuration

A configuration file can be provided. The default location is `~/.config/ncspot`. Detailed

configuration information can be found [here](/doc/users.md#configuration).

## Building

Building ncspot requires a working [Rust installation](https://www.rust-lang.org/tools/install) and

a Python 3 installation. To compile ncspot, run `cargo build`. For detailed instructions on building

ncspot, there is more information [here](/doc/developers.md).

## Packaging

Information about provided files, how to generate some of them and current package status accross

platforms can be found [here](/doc/package_maintainers.md).