Add more context on the manual

[rbdr/r.bdr.sh] / lyricli.gmi

--- title: /lyricli.html
--- description: "Lyricli (lrc), a command line lyrics finder for linux and mac"
## lyricli (lrc)

Command line tool that shows lyrics for your currently playing song in the terminal, supports spotify and apple music on macos, and most linux music players.

=> https://git.r.bdr.sh/rbdr/lyricli view source (git.r.bdr.sh)
=> https://git.sr.ht/~rbdr/lyricli view source (sourcehut mirror)

## Install

### Homebrew
You can install using homebrew. For direct binaries see below.

```
$ brew tap rbdr/apps git@git.sr.ht:~rbdr/homebrew-apps
$ brew install lyricli
```

### Prebuilt Packages
You can find pre-built packages for linux @ build.r.bdr.sh. There you can
find a `.tar.gz` that includes only the binary, or `.rpm` and `.deb`
distributions for fedora and debian that include a manpage.

Binaries are provided for x86_64 and aarch64.

Unstable releases are built directly from the main branch, while tagged
versions have their own release and can be considered more stable.

=> gemini://build.r.bdr.sh/lyricli lyricli pre-built releases @ gemini
=> https://build.r.bdr.sh/lyricli lyricli pre-built releases @ https

### From Source

In order to build this project, you'll need a genius client token. See the genius api docs for more information.

=> https://docs.genius.com/ genius api docs

Make sure you have rust and Make installed. Clone the repository, and run:

```
% make -e profile=release
```

Then copy the file somewhere in your PATH

```
% cp ./target/release/lyricli /usr/local/lyricli
```

## Usage
Running without arguments will try to detect your current song in apple music or spotify

```
$ lrc
```

You can run it with artist name and song name to fetch it manually

```
$ lrc artist_name song_name
```

You can view help with the h / help flag

```
$ lrc -h
$ lrc --help
```

## Managing Sources

By default it comes with spotify and apple music sources enabled, you can disable sources using:

```
$ lrc -d (source_name)
$ lrc --disable-source (source_name)
```

You can enable the source again using

```
$ lrc -e (source_name)
$ lrc --enable-source (source_name)
```

You can list all the sources with:

```
$ lrc -l
$ lrc --list-sources
```

## Manual

If you install using the rpm and deb you should be able to call help with man

```
man lrc
```

## Changelog

* 3.0.0 Rewritten in rust, supports linux media players. Relicensed to AGPL 3.0
* 2.0.1 Fixes a segfault when there are no results, and incorrect behavior when results are not songs.
* 2.0.0 Upgraded for swift 5.8 and work with the genius API instead of defunct LyricsWiki.
* 1.0.0 Upgraded for swift 5.0. Gets rid of the arguments source. Adds Apple Music support and ensures the app is running.
* 0.3.0 Spotify support. Bugfixes for iTunes support when app is not running.
* 0.2.0 iTunes support. Bugfixes for iTunes support when app is not running.
* 0.1.0 Initial swift release. Relicense to Apache. Only arguments source.
* 0.0.2 Improves error management and source management. Adds iTunes source.
* 0.0.1 Initial release in ruby with rdio support.

### Older Releases

You can download binaries of older releases, macos only.

2.0.1
=> /files/lyricli/lrc-2.0.1-universal.tar.gz lrc 2.0.1 (universal)
=> /files/lyricli/lrc-2.0.1-arm64.tar.gz lrc 2.0.1 (arm64)
=> /files/lyricli/lrc-2.0.1-x86_64.tar.gz lrc 2.0.1 (x86_64)

2.0.0
=> /files/lyricli/lrc-2.0.0-universal.tar.gz lrc 2.0.0 (universal)
=> /files/lyricli/lrc-2.0.0-arm64.tar.gz lrc 2.0.0 (arm64)
=> /files/lyricli/lrc-2.0.0-x86_64.tar.gz lrc 2.0.0 (x86_64)