29 releases (9 breaking)
Uses new Rust 2021
|0.9.4||Jan 1, 2022|
|0.9.3||Dec 10, 2021|
|0.9.2||Nov 30, 2021|
|0.8.1||Jul 27, 2021|
|0.0.0||Mar 4, 2019|
#2 in Audio
442 downloads per month
ncspot is a 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.
- Table of Contents
- Resource Footprint Comparison
- Key Bindings
- Vim-Like Commands
- Cover Drawing
ps_mem on Linux during playback:
|Client||Private Memory||Shared Memory||Total|
|ncspot||22.1 MiB||24.1 MiB||46.2 MiB|
|Spotify||407.3 MiB||592.7 MiB||1000.0 MiB|
ncspot is available via Homebrew:
brew install ncspot
ncspot is available via Scoop:
scoop install ncspot
- Python 3 (needed for building
portaudio-dev, if you want to use the PortAudio backend)
libxcb+ development headers (for clipboard access)
- A Spotify premium account
On Debian based systems you need following packages for development headers:
sudo apt install libncursesw5-dev libdbus-1-dev libpulse-dev libssl-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
For Fedora, these dependencies are required:
dnf install pulseaudio-libs-devel libxcb-devel openssl-devel ncurses-devel dbus-devel
You can use
cargo-deb create in order to build a Debian package from source.
Install it with:
cargo install cargo-deb
Then you can build a Debian package with:
You can find it under
Install the latest
ncspot release using:
cargo install ncspot
Or build it yourself using:
cargo build --release # NB: add these flags on Windows cargo build --release --no-default-features --features rodio_backend,cursive/pancurses-backend
Both approaches require a working Rust installation.
For debugging, you can pass a debug log filename and log stderr to a file, e.g. :
RUST_BACKTRACE=full cargo run -- -d debug.log 2> stderr.log
ncspot is built using the PulseAudio backend. To make it use the
PortAudio backend (e.g. for *BSD or macOS) or Rodio backend (e.g. for
Windows), you need to recompile
ncspot with the respective features:
# PortAudio (BSD/macOS) cargo run --no-default-features --features portaudio_backend,cursive/pancurses-backend # Rodio (Windows) cargo run --no-default-features --features rodio_backend,cursive/pancurses-backend
The keybindings listed below are configured by default. Additionally, if you
ncspot with MPRIS support, you may be able to use media keys to control
playback depending on your desktop environment settings. Have a look at the
configuration section if you want to set custom bindings.
|?||Show help screen.|
|F1||Queue (See specific commands).|
|F3||Library (See specific commands).|
|F8||Album Art (if compiled with the
|/||Open a Vim-like search bar (See specific commands).|
|:||Open a Vim-like command prompt (See specific commands).|
|Escape||Close Vim-like search bar or command prompt.|
|Return||Play track or playlist.|
|Space||Queue track or playlist.|
|.||Play the selected item after the currently playing track.|
|P||Move to the currently playing track in the queue.|
|S||Save the currently playing track to your library.|
|D||Remove the currently playing track from your library.|
|Shift+P||Toggle playback (i.e. Play/Pause).|
|Shift+U||Update the library cache (tracks, artists, albums, playlists).|
|<||Play the previous track.|
|>||Play the next track.|
|Shift+F||Seek forward with a 10-second step.|
|Shift+B||Seek backwards with a 10-second step.|
|-||Decrease volume by 1.|
|+||Increase volume by 1.|
|[||Decrease volume by 5.|
|]||Increase volume by 5.|
|R||Toggle Repeat mode.|
|Z||Toggle Shuffle state.|
|O||Open a detail view or context for the selected item.|
|Shift+O||Open a context menu for the currently playing track.|
|A||Open the album view for the selected item.|
|Shift+A||Open the artist view for the selected item.|
|M||Open the recommendations view for the selected item.|
|Shift+M||Open the recommendations view for the currently playing track.|
|Ctrl+V||Open the context menu for a Spotify link in your clipboard.|
|Backspace||Close the current view.|
When pressing O:
- If the selected item is not a track, it opens a detail view.
- If the selected item is a track, it opens a context menu with:
- "Show Artist"
- "Show Album"
- "Add to playlist"
- "Similar tracks"
|X||Copy a shareable URL of the currently selected item to the system clipboard.|
|Shift+X||Copy a shareable URL of the currently playing track to the system clipboard.|
|C||Clear the entire queue.|
|D||Delete the currently selected track.|
|Ctrl+S||Delete the currently selected track.|
|D||Delete the currently selected playlist.|
|n||Previous search occurrence.|
|N||Next search occurrence.|
You can open a Vim-style command prompt using :, and close it at any time with Escape.
The following is an abridged list of commonly-used commands. For the full list, see source code.
||Show current key bindings.|
||Remove any cached credentials from disk and quit
||Seek to the specified position, or seek relative to current position by prepending
|Set repeat mode. Omit
||Enable or disable shuffle. Omit argument to toggle.|
||Play previous track.|
||Play next track.|
||Switch to a screen.|
||Search a song.|
||Copies a shareable URL of the item to the system clipboard.|
||Create new playlist with name
||Sort a playlist by
||Executes a command in the system shell. Be aware that command output is printed to the terminal, so redirection to
selected: Selected item.
current: Current song.
Configuration is saved to
%AppData%\ncspot\config.toml on Windows). To reload the configuration during
runtime use the command prompt by typing
Possible configuration values are:
||Key to open command line||Single character||
||Screen to show after startup||
||Turn nerdfont glyphs on/off||
||Reverse play/pause icon meaning[^1]||
||Audio backend to use||String [^3]|
||Audio device to configure the backend||String|
||Enable caching of audio files||
||Maximum size of audio cache in MiB||Number|
||Enable volume normalization||
||Normalization pregain to apply (if enabled)||Number||0|
||Enable default keybindings||
||Enable desktop notifications||
||Audio bitrate to use for streaming||
||Show album column for tracks||
||Enable gapless playback||
||Set default shuffle state||
||Set default repeat mode||
||Custom theme||See custom theme|
||Custom keybindings||See custom keybindings|
[^1]: By default the statusbar will show a play icon when a track is playing and a pause icon when playback is stopped. If this setting is enabled, the behavior is reversed.
[^2]: If enabled.
ncspot -h for a list of devices.
Keybindings can be configured in
[keybindings] section in
e.g. as such:
[keybindings] "Shift+i" = "seek +10000"
ncspot will respect system proxy settings defined via the
The color palette can be modified in the configuration. For instance, to have
ncspot match Spotify's official client, you can add the following entries to
the configuration file:
[theme] background = "black" primary = "light white" secondary = "light black" title = "green" playing = "green" playing_selected = "light green" playing_bg = "black" highlight = "light white" highlight_bg = "#484848" error = "light white" error_bg = "red" statusbar = "black" statusbar_progress = "green" statusbar_bg = "green" cmdline = "light white" cmdline_bg = "black" search_match = "light red"
More examples can be found in this pull request.
When compiled with the
ncspot can draw the album art of the
current track in a dedicated view (
:focus cover or F8 by default)
using Überzug. For more information on
installation and terminal compatibility, consult that repository.
To allow scaling the album art up beyond its resolution (640x640 for Spotify
covers), use the config key
cover_max_scale. This is especially useful for
cover_max_scale = 2
ncspot prompts for a Spotify username and password on first launch, uses this
to generate an OAuth token, and stores it to disk.
The credentials are stored in
(unless the base path has been changed with the
:logout command can be used to programmatically remove cached credentials
(see Vim-Like Commands above).