mxlrc-go

command module
v0.0.0-...-9dbd475 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2022 License: MIT Imports: 21 Imported by: 0

README

MxLRC

build

Command line tool to fetch synced lyrics from Musixmatch and save it as *.lrc file.


Python version

Check it here


Download

Standalone binary

TBA

Build from source

Required Go 1.17+

go install github.com/fashni/mxlrc-go@latest

Usage

Usage: mxlrc-go [--outdir OUTDIR] [--cooldown COOLDOWN] [--token TOKEN] SONG [SONG ...]

Positional arguments:
  SONG                        song information in [ artist,title ] format (required)

Options:
  --outdir OUTDIR, -o OUTDIR  output directory [default: lyrics]
  --cooldown COOLDOWN, -c COOLDOWN
                              cooldown time in seconds [default: 15]
  --depth DEPTH, -d DEPTH     (directory mode) maximum recursion depth [default: 100]
  --update, -u                (directory mode) update existing lyrics file
  --bfs                       (directory mode) use breatdth-first-search traversal
  --token TOKEN, -t TOKEN     musixmatch token
  --help, -h                  display this help and exit

Example:

One song
mxlrc-go adele,hello
Multiple song and custom output directory
mxlrc-go adele,hello "the killers,mr. brightside" -o some_directory
With a text file and custom cooldown time
mxlrc-go example_input.txt -c 20
Directory Mode (recursive)
mxlrc-go "Dream Theater"

This option overrides the -o/--outdir argument which means the lyrics will be saved in the same directory as the given input.

The -d/--depth argument limit the depth of subdirectory to scan. Use -d 0 or --depth 0 to only scan the specified directory.


How to get the Musixmatch Token

Follow steps 1 to 5 from the guide here to get a new Musixmatch token.

Credits

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL