SuzumushiLocal terminal audio

Linux release · v1.2.1

Install Suzumushi.

Choose the AUR package for Arch Linux, the flake for NixOS, or the archive for x86-64 GNU/Linux. Then create your library below.

Arch Linux

Install the AUR package with yay. Both suzumushi and suzu launch the player.

Install with yay

yay -S suzumushi-bin
Next: set up your library →AUR package ↗

NixOS x86-64

With Nix installed, add the flake to your user profile. Both suzumushi and suzu launch the player.

Install with Nix

nix --extra-experimental-features 'nix-command flakes' \ profile add github:nuggocto/suzumushi/v1.2.1

Nix builds the stable v1.2.1 release with pinned dependencies. The first installation may take a few minutes.

Next: set up your library →NixOS and Home Manager configuration ↗

GNU/Linux x86-64

Download the release archive, verify its checksum, and install the player.

Show archive installation steps

1. Download

curl -fLO \ 'https://github.com/nuggocto/suzumushi/releases/download/v1.2.1/{SHA256SUMS,suzumushi-v1.2.1-x86_64-unknown-linux-gnu.tar.xz}'

2. Verify

sha256sum --check --ignore-missing SHA256SUMS

Continue only if the archive reports OK. If verification fails, stop and download the files again.

3. Install

tar -xf suzumushi-v1.2.1-x86_64-unknown-linux-gnu.tar.xz && cd suzumushi-v1.2.1-x86_64-unknown-linux-gnu && sudo install -Dm755 suzumushi /usr/local/bin/suzumushi && sudo ln -s suzumushi /usr/local/bin/suzu
Expected SHA-256 for v1.2.1

ef8b0611ad101bbfb8880ef85071b5932af2e87d296c9c1839caea2517da84ae

Next: set up your library →
Release files ↗

Set up your first library.

Run these commands from the folder where you want to keep your Suzumushi library. The player reads audio inside that library; it doesn't automatically scan your Music folder.

  1. Create a Suzumushi folder

    Create library

    suzumushi init ./suzumushi

  2. Add your music

    In your file manager, copy audio files or folders into ./suzumushi/audio/library/. You can keep your artist and album folders.

  3. Open the player

    Start listening

    suzumushi --root ./suzumushi

    Select a track in Library and press Enter to add it and start playback. Use Space to pause and ? for the key guide.

Audio support

The verified formats are MP3, FLAC, signed 16-bit PCM WAV, and Ogg Vorbis. Mono and stereo audio from 8 kHz through 192 kHz is supported when the default device accepts the source rate.

AAC, M4A, Opus, multichannel audio, and automatic resampling are not included in verified support.

Build from source

You need Rust 1.95 or newer and the development packages for your distribution.

  • Arch Linux: alsa-lib dbus pipewire clang pkgconf
  • Debian or Ubuntu: libasound2-dev libpipewire-0.3-dev libspa-0.2-dev libdbus-1-dev libclang-dev pkg-config
  • Fedora: alsa-lib-devel pipewire-devel dbus-devel libclang-devel pkgconf-pkg-config

Build and install

git clone https://github.com/nuggocto/suzumushi.git && cd suzumushi && cargo install --path . --locked

After installation, follow the library setup instructions above.

Back to the player