Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.52 KB

README.md

File metadata and controls

26 lines (19 loc) · 1.52 KB
Raw

termusic

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

Termusic is designed to sit in the corner of your screen while you work, study, or play video games, while taking up as little screen real estate as possible.

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 few basic commands, but there are over 15 commands!:

  • 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
  • volume <volume percent> - sets the volume, a value from 0 to 100.
  • theme <theme> - applies a theme given its name. You can view your themes in the ./ui/themes folder.
  • 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.