a soundcloud client for the terminal
Instructions
curl -fsSL https://raw.githubusercontent.com/Illogicalll/sctui/main/install.sh | shirm https://raw.githubusercontent.com/Illogicalll/sctui/main/install.ps1 | iexGrab the archive for your platform from the latest release, extract it and put sctui somewhere on your PATH.
Needs Rust 1.85+. On Linux, install the ALSA headers first: sudo apt install libasound2-dev pkg-config
cargo install --git https://github.com/Illogicalll/sctuiUpdating
sctui checks GitHub for a newer release every time it starts and asks before installing it. Pass --no-update-check to skip the check, or re-run the installer above to update by hand. sctui --version shows what you have.
Requirements
- A SoundCloud account. The free tier is fine.
- A modern terminal with true colour. Cover art needs a terminal that supports an image protocol.
- A font with Unicode block and braille glyphs for the visualisers. Any Nerd Font, JetBrains Mono or Fira Code works.
- Linux: the ALSA runtime (
libasound2), which every desktop distro ships. PipeWire and PulseAudio work through their ALSA plugin. - macOS 11+ or Windows 10+.
Stream tracks directly from SoundCloud without the interruptions you would usually experience with a free account on the website
Browse your own Likes, Playlists and Saved Albums as well as the Tracks and Likes of the People you follow
Search for Tracks, Albums and Playlists to add to your library, as well as new People to follow
View the activity of everyone you follow to stay up to date with their latest releases or reposts
Enjoy seamless transitions in your favourite albums without the buffering present on SoundCloud Web
When a playlist, album or your likes run out, sctui keeps going with related tracks. Alternatively, pressing Shift + Enter on any track or artist will start a queue of related tracks
The current track shows in your system's media panel with artwork and a live position. The play/pause/ skip buttons on your keyboard, headphones integrate directly
Where available, live lyrics can be displayed in the visualiser (sourced from LRCLIB)
Choose from one of 14 modes, from oscilloscopes to spectrums and more...
+ 12 more...
Configuration
Configuration lives in ~/.config/sctui/config.toml / C:\Users\<you>\.config\sctui\config.toml
Press Shift+O to pick a colour theme with a live preview: default, tokyonight, catppuccin-mocha, dracula, gruvbox-dark, nord, solarized-dark, one-dark, rose-pine.
Press ? to edit bindings in the app: pick an action, Enter then press the new key to add it, Backspace to unbind, r to restore its default.
- Due to SoundCloud API limitations, Go+ tracks are not playable from the application (no matter what account type you have)
- If a creator has disabled off-app streaming, then a track will not be playable via the API
- Due to the SoundCloud API Terms of Use, the downloads and offline playback is not supported
sctui talks to SoundCloud directly for everything except login. Login and hourly token refresh go through a small relay (source in worker/) that adds the app secret and passes SoundCloud's reply straight back without reading or storing it.
Your password never leaves soundcloud.com. You can revoke sctui's access at any time from your SoundCloud settings.
Copyright © Will Murphy contact@w-murphy.com
This project is licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT)