0cee99ba4c
* feat: add `info` command line subcommand Adding an info command allows the documentation to refer to it when mentioning platform specific information. This gives users a nicer experience since they don't need to think about how `ncspot` will behave on their system, but can run `ncspot info` to get that information. * fix: info command don't create runtime directory * fix: don't print runtime path on Windows Windows doesn't use the runtime path so it shouldn't be printed there. * fix: make `info` command easier to parse * docs: add back the default configuration directory
2.2 KiB
An ncurses Spotify client written in Rust using librespot
ncspot is an ncurses Spotify client written in Rust using librespot. It is heavily inspired by ncurses MPD clients, such as 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
- 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), Linux (native package and Flathub) and the BSD's. Detailed installation instructions for each platform can be found here.
Configuration
A configuration file can be provided. The default location is ~/.config/ncspot. Detailed
configuration information can be found here.
Building
Building ncspot requires a working Rust installation and
a Python 3 installation. To compile ncspot, run cargo build. For detailed instructions on building
ncspot, there is more information here.
Packaging
Information about provided files, how to generate some of them and current package status accross platforms can be found here.