@vardhanbattula7/csongs
v0.0.2
Published
> A terminal music player for a local `~/Music` library.
Readme
csongs
A terminal music player for a local
~/Musiclibrary.
Requirements
- Node.js 16 or newer
npmffplayandffprobefrom FFmpegcavafor the visualizer- A
Musicdirectory in your home folder with.mp3files
If ~/Music does not exist, csongs will prompt you to create it on launch.
Install
Global install
npm install --global @vardhanbattula7/csongs
csongs --listFrom source
git clone https://codeberg.org/Vardhanb07/csongs.git
cd csongs
npm install
npm run buildDevelopment
npm install
npm run devRun
After installing or building, run:
csongsBy default the app opens the song list view. Use --play to start playback immediately.
CLI
csongs --help
Usage
csongs [options]
Options
--list Open the song list view
--play Start playing from the first song
Examples
csongs --list
csongs --playFlags
--listopens the library browser.--playstarts playback from the first song in~/Music.- If both are provided,
--listwins.
Keyboard Commands
Library view
↑/↓: move selectiong: jump to the first songG: jump to the last songEnter: play the selected songq/Esc: exit the app
Player view
Space: play or pausel: loop the current songL: loop the full playlistn/Right Arrow: next songp/Left Arrow: previous songq/Esc: stop playback and exit- When a song ends, playback automatically moves to the next song.
- When the final song ends and playlist loop is off, player returns to home.
How It Works
- csongs reads audio files from
~/Music - Only
.mp3files are shown and played - The player uses
ffplay - Track duration is read with
ffprobe - The animated visualizer uses
cava - CAVA signal-based exits during song transitions are treated as expected cleanup.
Commands During Setup
If you are setting up the project from source, these are the main commands:
npm install
npm run dev
npm run build