cliamp README

The project's README from github.com/bjarneo/cliamp. As one markdown file: README.md.

Docs on contextowl.co

A retro terminal music player inspired by Winamp. Play local files, streams, podcasts, YouTube, YouTube Music, SoundCloud, Mixcloud, Bilibili, Spotify, NetEase Cloud Music, Yandex Music, Xiaoyuzhou (小宇宙), Navidrome, Lyrion, Plex, Jellyfin, and Audiobookshelf. Use the spectrum visualizer, parametric EQ, and playlist manager.

cliamp.stream | docs

cliamp uses Bubbletea, Lip Gloss, Beep, and go-librespot.

https://github.com/user-attachments/assets/fbc33d20-e3ac-4a62-a991-8a2f0243c8ea

Proudly sponsored by contextowl.co

Install

curl -fsSL https://cliamp.stream/install.sh | sh

Homebrew

brew install bjarneo/cliamp/cliamp

The formula installs all required runtime libraries.

Arch Linux (AUR)

yay -S cliamp

Nix

nix run github:bjarneo/cliamp

For a declarative NixOS configuration, add github:bjarneo/cliamp as a flake input. Install its default package:

inputs.cliamp.url = "github:bjarneo/cliamp";

environment.systemPackages = [
  inputs.cliamp.packages.${pkgs.stdenv.hostPlatform.system}.default
];

Go

go install github.com/bjarneo/cliamp@latest

Install ALSA development headers before you build on Linux. See Building from source.

Pre-built binaries

Download from GitHub Releases.

macOS: Pre-built binaries link dynamically to FLAC, Vorbis, Ogg, and mpg123 from Homebrew. If you download from Releases or use install.sh, install these libraries first. Otherwise, you can see errors such as Library not loaded: /opt/homebrew/opt/libvorbis/lib/libvorbisenc.2.dylib:

brew install flac libvorbis libogg mpg123

brew install bjarneo/cliamp/cliamp installs these libraries.

Linux: Pre-built binaries link FLAC, Vorbis, Ogg, and mpg123 statically. No extra codec packages are required. You can still need an ALSA bridge for your sound server. See Troubleshooting.

Windows: Download and extract cliamp-windows-amd64.zip from Releases. It includes the codec DLLs that Spotify requires. If HOME is not set, cliamp stores its config under %APPDATA%\cliamp.

Optional runtime dependencies for all platforms and install methods:

On macOS, run brew install ffmpeg yt-dlp. On Linux, use your distribution package manager.

On Windows, install ffmpeg and yt-dlp with your package manager. Keep both on PATH.

Build from source

git clone https://github.com/bjarneo/cliamp.git && cd cliamp && go build -o cliamp .

Quick Start

cliamp ~/Music                     # play a directory
cliamp *.mp3 *.flac               # play files
cliamp https://example.com/stream  # play a URL

Press Ctrl+K to see all keybindings.

Configure remote providers such as Navidrome, Lyrion, Plex, Jellyfin, Audiobookshelf, Spotify, Mixcloud, YouTube Music, and NetEase Cloud Music with the interactive wizard:

cliamp setup

The wizard guides you through each provider. It writes the required block to your config file (~/.config/cliamp/config.toml, or %APPDATA%\cliamp\config.toml on Windows when HOME is unset). It validates supported server connections during setup. It checks optional Mixcloud browser-session or OAuth credentials when you use them. See docs/cli.md for details.

See the Mixcloud provider guide for discovery, account, creator/show, genre search, local genre favorites, authentication, signed-in playback, resume, seeking, and limitations.

For podcast discovery and subscriptions, run cliamp --provider podcast. Browse Apple's top 100 shows and 19 categories, search with / then Enter, and subscribe with f. No account or API key is needed. See the Podcasts guide.

Radio

Press R in the player to browse about 58,000 online radio stations in the Radio Browser directory.

Cut that down by location or genre: N browses by country, Browse genres & tags opens the directory's complete tag index, and / filters either list. f pins the countries you listen to, and Enter on a country or tag loads its stations as a playlist. cliamp does not work out where you are unless you pick "Use my location" and accept; it then reads your country from the system timezone, never from a geo-IP service. See docs/radio.md.

Add your own stations to ~/.config/cliamp/radios.toml (or %APPDATA%\cliamp\radios.toml on Windows when HOME is unset). See docs/configuration.md.

To host a radio station, use cliamp-server.

Building from source

Prerequisites:

Linux (Debian/Ubuntu):

sudo apt install libasound2-dev libflac-dev libvorbis-dev libogg-dev libmpg123-dev

Linux (Fedora):

sudo dnf install alsa-lib-devel flac-devel libvorbis-devel libogg-devel mpg123-devel

Linux (Arch):

sudo pacman -S alsa-lib flac libvorbis libogg mpg123

macOS: brew install flac libvorbis libogg mpg123 pkg-config

Windows: The core player needs no extra SDKs. It uses pure-Go audio decoding. ffmpeg.exe and yt-dlp.exe remain optional runtime dependencies for the same formats and providers as other platforms.

Spotify support uses go-librespot. It needs CGO and a MinGW toolchain:

  1. Install MSYS2.
  2. Open the MSYS2 MinGW64 terminal, not the standard MSYS2 terminal. Install the toolchain and codec libraries:
    pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-pkg-config \
  mingw-w64-x86_64-libogg mingw-w64-x86_64-libvorbis \
  mingw-w64-x86_64-flac mingw-w64-x86_64-mpg123
  3. In that MinGW64 terminal, build with CGO enabled. This keeps gcc and pkg-config on PATH:
    CGO_ENABLED=1 go build -o cliamp.exe .
    Some MSYS2 libogg builds provide libogg-0.dll without ogg_stream_iovecin in its export table. The static libogg.a has this symbol. If linking fails with undefined reference to 'ogg_stream_iovecin', use static linking for this library only:
    CGO_LDFLAGS="-Wl,-Bstatic -logg -Wl,-Bdynamic" CGO_ENABLED=1 go build -o cliamp.exe .
  4. cliamp.exe links dynamically to codec and MinGW runtime DLLs. Keep C:\msys64\mingw64\bin on PATH at runtime, or copy each /mingw64/bin/*.dll that ldd cliamp.exe shows next to cliamp.exe.

Clone and build:

git clone https://github.com/bjarneo/cliamp.git
cd cliamp
make && make install

Or without Make: go build -o cliamp .

make install places the binary in ~/.local/bin/.

Optional runtime dependencies:

Docs

Full documentation is hosted at whiterose.org.contextowl.co/docs/cliamp.

Troubleshooting

No audio output

cliamp reports audio output unavailable when it cannot open an output device. On Linux systems that use PipeWire or PulseAudio, the cliamp ALSA backend needs a bridge package to route audio through the sound server:

Install the package for your system:

# PipeWire (Arch)
sudo pacman -S pipewire-alsa

# PulseAudio (Arch)
sudo pacman -S pulseaudio-alsa

# Debian/Ubuntu (PipeWire)
sudo apt install pipewire-alsa

# Debian/Ubuntu (PulseAudio, including WSL2)
sudo apt install libasound2-plugins

On WSL2 see WSL2 setup for the extra ALSA routing step.

Author

x.com/iamdothash

Disclaimer

Use this software at your own risk. The authors are not responsible for damage or issues that result from its use.

cliamp (bjarneo/cliamp)

Searching Database…

4.5K ·GitHub
Cliamp
What is this?cliamp is a retro terminal music player inspired by Winamp. It plays local files plus streams from services like YouTube, Spotify, SoundCloud, Navidrome, Jellyfin, Plex, and internet radio, all from a terminal UI.
Is this a GUI app or does it run in the terminal?It's a terminal (TUI) application you run in your shell rather than a windowed GUI, built with Bubbletea and Lip Gloss for the interface and Beep plus go-librespot for audio playback.
How do I install cliamp?Install via Homebrew (brew install bjarneo/cliamp/cliamp), the Arch AUR, a Nix flake, go install, or a pre-built binary from GitHub Releases, or build from source with go build -o cliamp .
What do I need installed besides cliamp itself?On Linux you need ALSA development headers to build and an ALSA bridge (pipewire-alsa or pulseaudio-alsa) to actually hear sound. Optional ffmpeg handles AAC/ALAC/Opus/WMA, and yt-dlp pulls audio from YouTube, SoundCloud, Bilibili, and more.
Any install pitfalls I should know about?Pre-built macOS binaries dynamically link FLAC, Vorbis, Ogg, and mpg123 from Homebrew, so you must install those first or playback fails with a 'Library not loaded' error. Building Spotify support on Windows requires CGO and a full MSYS2 MinGW toolchain.
Does cliamp track my location for the radio feature?cliamp only detects your country from your system's timezone, and only if you explicitly opt into 'Use my location' for browsing radio stations by country.
Does cliamp support podcasts?Yes — run cliamp --provider podcast to browse Apple's top 100 shows across 19 categories, search, and subscribe, with no account or API key required.
How many radio stations can I browse?Pressing R in the player opens about 58,000 online stations from the Radio Browser directory, which you can filter by country or genre and search.
What playback features does the player itself have?The player includes a spectrum visualizer, a parametric EQ, and a playlist manager alongside the usual transport controls.
How do I connect services like Navidrome or Spotify?An interactive setup wizard walks you through each remote provider (Navidrome, Plex, Jellyfin, Spotify, Mixcloud, and more), writes the config block, and validates the connection during setup.
What are similar projects?spotatui, spotify-tui, spotify-downloader, openspot-music-app, Levyra-deepsound, ISpotify, moji, cli
Which topics is it in?soundcloud, bubbletea, stream, audio-streaming, radio, m3u, podcast, spotify, yt-dlp, music-player, youtube, music
Creator
bjarneo
Size
10.4 MB
Stars
4.5K
Updated
CommitOct 11Releasev2.3.0Sep 28
Age
7mo
Commits · 90 Days