LinuxCommandLibrary

ncspot

Play Spotify music in terminal

TLDR

Start ncspot

$ ncspot
copy

Enable logging to the specified file
$ ncspot [[-d|--debug]] [path/to/file]
copy

Display paths to the configuration and cache
$ ncspot info
copy

Use a different configuration file (in the directory reported by ncspot info; default: config.toml)
$ ncspot [[-c|--config]] [file_name]
copy

Display a list of keybindings
$ <?>
copy

SYNOPSIS

ncspot [OPTIONS]

PARAMETERS

-b, --backend <BACKEND>
    Specifies the audio backend to use. Common options include alsa, pulseaudio, and portaudio. Defaults to pulseaudio.

-c, --config <CONFIG>
    Provides an alternative path to the configuration file. By default, ncspot looks for ~/.config/ncspot/config.toml.

-h, --help
    Displays a help message with available command-line options and exits.

-o, --osc
    Enables Open Sound Control (OSC) for communication with external applications, useful for integration with other tools.

-s, --session
    Restores the previous playback session upon startup, picking up where you left off.

-V, --version
    Prints the version information of ncspot and exits.

DESCRIPTION

ncspot is a feature-rich, ncurses-based Spotify client for your Linux terminal, crafted with Rust. It provides a lightweight and efficient way to interact with Spotify without leaving your command line. Users can browse playlists, search for artists, albums, and tracks, manage queues, and even view lyrics directly within the terminal interface. It leverages the librespot library for Spotify's internal communication, ensuring a robust connection to the service. Designed for minimal resource usage, ncspot is an excellent choice for users who prefer keyboard-driven interfaces and want a seamless Spotify experience on remote servers, older hardware, or simply within their favorite terminal emulator. It requires a Spotify Premium account to function.

CAVEATS

ncspot requires a Spotify Premium account for full functionality. It does not support local music file playback. As a terminal UI application, it relies on keyboard shortcuts for navigation and control, which might have a slight learning curve for new users.

CONFIGURATION

ncspot's behavior, keybindings, and themes can be customized via its configuration file, typically located at ~/.config/ncspot/config.toml. This TOML-formatted file allows users to personalize nearly every aspect of the application's appearance and interaction.

KEYBINDINGS

Navigation and control within ncspot are primarily done through keyboard shortcuts. Common actions include searching (/), playing/pausing (space), skipping tracks (n), and managing the queue (q). A comprehensive list of keybindings can be found within the application's help menu (?) or in the configuration file.

HISTORY

Developed in Rust, ncspot emerged as a modern terminal Spotify client, leveraging Rust's performance and safety features. It builds upon the success of other terminal-based music players and aims to provide a robust and responsive user experience for Spotify users who prefer a command-line interface.

SEE ALSO

spotify-tui(1), cmus(1), mopidy(1), spotifyd(1)

Copied to clipboard