Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.7 KB

README_future.md

File metadata and controls

34 lines (27 loc) · 1.7 KB

termusic

A minimal and lightweight terminal music player. Uses the cobalt api and ffplay to stream and play audio from youtube.

Getting started!

First, make sure you have node.js version 18 or later, npm, aswell as ffmpeg installed on your system.

After that, you can install termusic via npm by running the following command:

npm i -g termusic

More info on installation

Using termusic

After installing, enter termusic in your terminal. It will open up a new terminal window.

Start typing on your keyboard to enter a command. Here's a list of commands you can run:

  • play <song name> - searches up a song and starts playing it.
  • queue add <song name> - searches up a song and adds it to the queue
  • queue remove - removes the last song from the queue
  • queue clear - clears the queue
  • queue skip - skips to the next song in the queue
  • exit - exits the program.
  • volume <volume percent> - sets the volume, a value from 0 to 100.
  • loop - enables looping, ignoring the queue and looping the current song.
  • noloop - disables looping.
  • theme <theme> - applies a theme given its name. You can view your themes in the ./ui/themes folder.
  • share - copies a sharable link to the song your listening to.
  • reloadui - reloads the ui, mainly useful for debugging.
  • about - shows an about dialog.
  • pl <playlist> - searches for a playlist and adds all of its songs to the queue.

You can also use the right and left arrow keys to restart or skip songs.