lunar

README

lunar~

lunar a beautiful command line application for managing music libraries made in go. download songs from youtube, keep them offline forever.

[!CAUTION] lunar~ is still beta software, anything is likely to and will be changed. This may break your configuration, data, etc. Things will be more stable once we hit a release.

installation

1. Download go with your system package manager

apt install golang     # debian/ubuntu based distros
pacman -S golang       # arch based distros
dnf install golang     # fedora based distros
zypper in go           # openSUSE distros
nix-env -iA nixpkgs.go # nix package manager

1. Install. Make sure $GOPATH/bin is in your path.

make install

1. Use! Run the lunar command to get basic assistance with using the program. Be sure to report any bugs to codeberg.org/odysee/lunar

configuration

All configuration is kept under your home folder in ~/.config/lunar/lunar.toml. Environment variables in your configuration automatically expand (eg. $HOME => /home/user) and options case insensitive (SongDir == songdir)

SongDir

Default: $HOME/Music
Where your playlists will be created, playlists are seperated into their own folders. This does not use additional space as all songs are symlinks.

DataPath

Default: $HOME/.config/lunar/data.json
Where your data is stored. This is used to know what songs to download, their properties and the playlists they are in. It is recommended to keep this file safe, change this to a location synced with backups like cloud storage. This is the only file required to rebuild your music library.

DownloadDir

Default: $HOME/.cache/lunar/songs
IT IS UNRECOMMENDED TO CHANGE THIS
This is where songs are downloaded to, it is highly unrecommended to change this as it brings no benefit from doing so. Songs in this folder are unorganised and only named by their ID. Only change this if want to put your songs on a seperate drive (eg. if your running out of space).

faq

how do I play my songs?

lunar itself is not a music player, you will need to provide your own one like amberol.