Skip to content

itzreesa/lyria

Repository files navigation

lyria

your new song manager

GitHub Release GitHub code size in bytes GitHub License
GitHub top language GitHub commit activity Static Badge

Quickstart

On Linux and macOS, type this into your terminal.

curl https://reesa.cc/lyria | sh

lyria will be installed into ~/.local/share/lyria and linked to ~/.local/bin.
Make sure it's in your PATH. And you have python installed.

Install manually (and windows)

Prepare folders ~/.local/share/lyria and ~/.local/bin

Download the tarball from main branch or get the latest release

Unpack the tarball to ~/.local/share/lyria

Make sure it's executable (windows doesn't need it)

chmod +x lyria.py

Link the executable (idk if it'll work on windows):

ln -sf "$HOME/.local/share/lyria/lyria.py" "$HOME/.local/bin/lyria"

If you haven't already, add ~/.local/bin to your PATH!

# for bash
echo "export PATH=$HOME/.local/bin:$PATH" >> ~/.bashrc

# for zsh
echo "export PATH=$HOME/.local/bin:$PATH" >> ~/.zshrc

Now, run lyria once to set up the venv and you'll be good to go!
If there's a new version available, run this to update:

lyria update

Usage

lyria is split into components, explanation for them can be viewed using

lyria -e <component>

or you can see the text files in this directory.

Below you can find a few examples,
but I strongly recommend checking out the docs, so you can use lyria for what you actually need it for.

lyric grabbing

Fetch lyrics for all files in the current directory.
The minimal example.

lyria

Fetch lyrics for folder Music/ recursively.
And for every song that you can't find lyrics for, create an empty file to skip it on next use.

lyria lyrics Music/ -r --forget-not-found

music organization

Get all the songs from folder Import/ and organize them into the folder Music/.
Force artist name to be "Mozart`.
Perform a dry run, do not actually move files.

lyria organize Music/ Import/ --artist="Mozart" --dry-run

Issues

If you're having an issue, or you have a proposal for a feature, please use the Issues tab.

License

lyria's source code is licensed under the MIT license. here



thanks for reading me! ~readme file